a5a04f56bd
We introduced a new type for "ParserTestMode" and then uniformly pass this around alongside the ParserTest object itself. (We started by using a string for the $mode but the "explicit changetree" mode requires more structured data. We *could* encode this in JSON just to keep the string type around, but it seems cleaner and more future proof to wrap this in a proper class type.) Removed the old TestFileReader wrapper class, which served only as a thunk to convert the new Test class into the same sort of array which the legacy parser test runner code expected. There's still some remaining ::testToArray() usage here for the TestRecorder framework, but that will be cleaned up in a future patch. Also updated the TestRecorder with stronger types: use the same <Test,TestMode> pair when invoking the TestRecorder, instead of the loosely typed array we'd used previously. Change-Id: Iec4c0c7972a655b4faccacc67bdc3ca66d4c163d
113 lines
3.1 KiB
PHP
113 lines
3.1 KiB
PHP
<?php
|
|
declare( strict_types = 1 );
|
|
|
|
// This belongs in Wikimedia\Parsoid\ParserTests
|
|
namespace MediaWiki\Tests;
|
|
|
|
/**
|
|
* Represents a parser test mode, that is, a certain way of executing a
|
|
* parser tests and evaluating the result.
|
|
*
|
|
* As a trivial example, a parser test will typically have a
|
|
* "wikitext" section and an "html" section. Two possible modes for
|
|
* evaluating the test are "wt2html" (where you programatically
|
|
* convert the "wikitext" section to HTML and verify that the result
|
|
* matches the "html" section, after normalization) and "html2wt"
|
|
* (where you programmatically convert the "html" section back to
|
|
* wikitext and verify that the result matches the "wikitext" section,
|
|
* after normalization).
|
|
*/
|
|
class TestMode {
|
|
|
|
/** Valid test modes, as keys for efficient query/set intersection. */
|
|
public const TEST_MODES = [
|
|
'legacy' => true, // wt2html with legacy parser
|
|
'wt2html' => true,
|
|
'wt2wt' => true,
|
|
'html2html' => true,
|
|
'html2wt' => true,
|
|
'selser' => true,
|
|
];
|
|
|
|
/**
|
|
* Selected test mode, typically one of the values from self::TEST_MODES.
|
|
* @var string
|
|
*/
|
|
public $mode;
|
|
|
|
/**
|
|
* The "selser" test mode can operate with an explicit changetree
|
|
* provided in this property.
|
|
* @var ?array
|
|
*/
|
|
public $changetree;
|
|
|
|
/**
|
|
* Create a new test mode
|
|
* @param string $mode The test mode. An external caller should use
|
|
* one of `self::TEST_MODES`, although ParserTestRunner uses a few
|
|
* additional values internally.
|
|
* @param ?array $changetree The specific changes to apply in selser test
|
|
* mode.
|
|
*/
|
|
public function __construct(
|
|
string $mode,
|
|
?array $changetree = null
|
|
) {
|
|
$this->mode = $mode;
|
|
$this->changetree = $changetree;
|
|
}
|
|
|
|
/**
|
|
* Helper function: returns true if this test mode is 'legacy'; that is,
|
|
* is this test to run with the legacy parser.
|
|
* @return bool
|
|
*/
|
|
public function isLegacy() {
|
|
return $this->mode === 'legacy';
|
|
}
|
|
|
|
/**
|
|
* Returns a string representation of this test mode, which can also
|
|
* be used as an array key or for human-friendly output.
|
|
* @return string
|
|
*/
|
|
public function __toString(): string {
|
|
$s = $this->mode;
|
|
if ( $this->changetree !== null ) {
|
|
$s .= ' ' . json_encode(
|
|
$this->changetree,
|
|
JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE
|
|
);
|
|
}
|
|
return $s;
|
|
}
|
|
|
|
/**
|
|
* Helper function: filter a given set of options against the
|
|
* TEST_MODES. Optionally ensure that all modes are returned if
|
|
* none are explicitly set.
|
|
*
|
|
* @param string[] $options The user-specified test modes
|
|
* @param bool $ifEmptySetAll If true, ensure that the result always
|
|
* includes at least one set test mode by setting all available test
|
|
* modes if the passed $options array does not contain any.
|
|
* @return string[] A filtered set of test modes
|
|
*/
|
|
public static function requestedTestModes( array $options, bool $ifEmptySetAll = true ) {
|
|
if ( $ifEmptySetAll ) {
|
|
$allModes = true;
|
|
foreach ( self::TEST_MODES as $mode => $ignore ) {
|
|
if ( $options[$mode] ?? false ) {
|
|
$allModes = false;
|
|
}
|
|
}
|
|
if ( $allModes ) {
|
|
return array_keys( self::TEST_MODES );
|
|
}
|
|
}
|
|
return array_keys( array_intersect_assoc(
|
|
$options, self::TEST_MODES
|
|
) );
|
|
}
|
|
}
|