Parsertests

This page is a translated version of the page Parser tests and the translation is 50% complete.
Outdated translations are marked like this.
The Parsoid specific sections and Parsoid specific options are only relevant for (a) Parser test files in the Parsoid repository (b) Parser test files that have been marked Parsoid-compatible. Also note that MW 1.38 and prior do not have support for running Parsoid tests via the parserTests.php test runner in MediaWiki core. But, these options are available in Parsoid's test runner (bin/parserTests.php in Parsoid's repository).

Jeder Parsertest-Fall gibt eine Wikitext-Eingabe und eine HTML-Ausgabe an, um sicherzustellen, dass der Parser wie erwartet arbeitet. Der tatsächliche Output wird mit dem gewünschten Ergebnis verglichen, wodurch die Parsertest-Fälle (auch Parsertsts genannt) hilfreich sein können, um Regressionen zu erkennen.

Die Parsertests befinden sich unter tests/parser/parserTests.txt. Erweiterungen sollten ihre Tests in einem tests/parser/-Verzeichnis platzieren.

Sie können sowohl durch die phpunit-Testsuite als auch durch das alleinstehende parserTests.php ausgeführt werden -- daher sollte ein Parsertest-Fehler zu einem Fehlschlag der Jenkins-Tests führen.

Syntax & Ausführung

Version 2 format

Starting with 1.35, parser tests are required to be in the Version 2 format. Specifying version 2 indicates that the tests are ready to be run in "tidy" mode (See T249138).
To indicate your parser tests are run in version 2 format, the first line in your parser test file must be !! Version 2

Enabling hooks

Um sicherzugehen, dass der Erweiterungs-Tag tag1 geladen ist, füge zum Anfang der Datei dies hinzu:

!! hooks
tag1
!! endhooks

Adding articles

In order to create a new article, the syntax is:

!! article
Template:Simple template
!! text
A ''simple'' template.
!! endarticle

Layout of a parser test

Besides the test time, a test has a number of sections: options (optional), config (optional), wikitext, wikitext/edited (optional), html (optional), html/php (optional), html/parsoid (optional), html/parsoid+standalone (optional).

The wikitext/edited and the various html/parsoid* sections are only relevant when running a test with Parsoid. Parsoid also allows additional configuration with additional test-specific options in the options section.

Die Syntax ist wie folgt:

!! Version 2
!! test
Simple paragraph
!! config
wgRestrictDisplayTitle=false
!! wikitext
This is a simple paragraph.
!! html
<p>This is a simple paragraph.
</p>
!! end

Configuration section

Der "config"-Abschnitt kann weggelassen werden. Wenn du dort Konfigurationswerte angibst, stelle sicher, dass du keinen Whitespace zwischen deinen Ausdrücken hast, da Whitespace durch den Test Runner nicht entfernt wird.

Options section

Each option should come on its own line.

  • disabled disables the test.
  • php runs the test only with the core's default parser unless Parsoid-specific HTML sections are present. The "php" name is a historical remnant from when Parsoid was a Node.js codebase.
  • parsoid=comma-separated-modes or parsoid={...} (JSON format object) enable Parsoid-specific options.
    • Ex: parsoid=wt2html,wt2wt runs this test in only those 2 modes. By default, the test is run all available test modes for the test given the wikitext and html sections. In the common case, this defaults to running the test in wt2html, wt2wt, html2wt, html2html, and selser modes. The selser mode is an abbreviation for a test mode where the HTML section is edited in a number of automated ways which is then converted to wikitext using Parsoid's selective-serialization (selser henceforth) transformations. TODO: Add a link to a wikipage that explains Parsoid's various transformations.
    • In the JSON format object, the following keys are current recognized modes, selser, changes, suppressErrors, normalizePhp,
      • modes: This is a comma separated list of Parsoid modes to run
      • selser: If selser is one of the test modes in the modes property, this property can optionally specify "noauto" to indicate automatic edits for this test should not be generated. If so, only manual edits as specified by the changes property will be applied.
      • changes: This format is described separately below. This option will need to be paired with a wikitext/edited section in the test (see below) that specifies the expected wikitext output when this edited HTML is converted (via selser) to wikitext by Parsoid.

changes format

This is an array of individual changes to apply to the DOM of the HTML generated by transforming wikitext. Each element of the array contains 3 or more elements: (a) jquery selector to select a DOM node (b) the type of change to apply to the selected node (c) the relevant values / content needed to apply the change specified.

More succinctly, each array element represents a jquery method call. So, [x,y,z...] becomes $(x)[y](z....) So, ['fig', 'attr', 'width', '120'] is interpreted as $('fig').attr('width', '120')

Right now, the following jquery methods are recognized: after, addClass, append, attr, before, empty, html, remove, removeAttr, removeClass, text, wrap

See http://api.jquery.com/ for documentation of these methods.

"contents" as second argument calls the jquery .contents() method on the results of the selector in the first argument, which is a good way to get at the text and comment nodes.

Wikitext sections

  • wikitext section: This is expected to be present in all tests is the that specifies the wikitext to be processed to HTML (or in Parsoid html2wt and wt2wt test modes, the wikitext to generate from the HTML sections).
  • wikitext/edited section: This section is only relevant in Parsoid test runs. For tests that provide a manual set of changes to apply to the HTML generated from the wikitext section, this is the output expected when Parsoid converts that edited HTML back to wikitext.

HTML sections

TODO

Extension.json & parser tests

Für Erweiterungen, die ihre Tests in tests/parser/ platzieren und extension.json verwenden, werden die Parsertests automatisch ausgeführt. Erweiterungen die das alte System zum Laden von Erweiterungen verwenden, können dies verwenden:

$wgParserTestFiles[] = __DIR__ . "/myParserTests.txt";

Running tests with parserTests.php

Um Parsertests auszuführen, führe im Wurzelverzeichnis deiner MediaWiki-Installaton folgendes per Kommandozeile auf:

php tests/parser/parserTests.php
Vor MediaWiki 1.28 befand sich diese Datei unter dem Pfad tests/parserTests.php

Um Tests nur für eine Datei durchzuführen, verwende den --file=...-Parameter. Siehe --help für weitere Parameter.

php tests/parser/parserTests.php --file=extensions/Kartographer/tests/parser/parserTests.txt

Parsoid-specific test runner options

These options aren't available with MediaWiki core's paresr test runner in MW 1.38 and prior. You can run tests in Parsoid mode via the --parsoid option. The best and most up-to-date documentation of all available options is to run

php tests/parser/parserTests.php --help

Setting global config variables

To set default global variables for all parser tests in an extension, use the ParserTestGlobals hook.

In a specific test, set the config variables as follows:

!! test
Your Test Name
!! config
wgVariableName=true
!! wikitext
...

Siehe auch