1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<?php
use PHPUnit\Framework\TestSuite;
use Wikimedia\ScopedCallback;
/**
* The UnitTest must be either a class that inherits from MediaWikiIntegrationTestCase
* or a class that provides a public static suite() method which returns
* an PHPUnit\Framework\Test object
*
* @group Parser
* @group ParserTests
* @group Database
*/
class ParserTestTopLevelSuite extends TestSuite {
use SuiteEventsTrait;
/** @var PhpunitTestRecorder */
private $ptRecorder;
/** @var ParserTestRunner */
private $ptRunner;
/** @var ScopedCallback */
private $ptTeardownScope;
/**
* @defgroup filtering_constants Filtering constants
*
* Limit inclusion of parser tests files coming from MediaWiki core
* @{
*/
/**
* Include files shipped with MediaWiki core
*/
public const CORE_ONLY = 1;
/** Include non core files returned by
* ParserTestRunner::getParserTestFiles() (that is, parser tests belonging
* to extensions).
*/
public const NO_CORE = 2;
/** Include anything returned by ParserTestRunner::getParserTestFiles(),
* both core and extensions.
*/
public const WITH_ALL = self::CORE_ONLY | self::NO_CORE;
/** @} */
/**
* Get a PHPUnit test suite of parser tests. Optionally filtered with
* $flags.
*
* @par Examples:
* Get a suite of parser tests shipped by MediaWiki core:
* @code
* ParserTestTopLevelSuite::suite( ParserTestTopLevelSuite::CORE_ONLY );
* @endcode
* Get a suite of various parser tests, like extensions:
* @code
* ParserTestTopLevelSuite::suite( ParserTestTopLevelSuite::NO_CORE );
* @endcode
* Get any test returned by ParserTestRunner::getParserTestFiles():
* @code
* ParserTestTopLevelSuite::suite( ParserTestTopLevelSuite::WITH_ALL );
* @endcode
*
* @param int $flags Bitwise flag to filter out the test files that
* will be included. Default: ParserTestTopLevelSuite::CORE_ONLY
*
* @return TestSuite
*/
public static function suite( $flags = self::CORE_ONLY ) {
return new self( $flags );
}
public function __construct( $flags, ?array $parserTestFlags = null ) {
parent::__construct();
$this->ptRecorder = new PhpunitTestRecorder;
$runnerOpts = $parserTestFlags ?? json_decode( getenv( "PARSERTEST_FLAGS" ) ?: "[]", true );
// PHPUnit test runners requires all tests to be pregenerated.
// But, generating Parsoid selser edit trees requires the DOM.
// So, we cannot pregenerate Parsoid selser auto-edit tests.
// They have to be generated dynamically. So, set this to 0.
// We will handle auto-edit selser tests as a composite test.
$runnerOpts['numchanges'] = 0;
$this->ptRunner = new ParserTestRunner(
$this->ptRecorder, $runnerOpts
);
if ( is_string( $flags ) ) {
$flags = self::CORE_ONLY;
}
global $IP;
$mwTestDir = $IP . '/tests/';
# Human friendly helpers
$wantsCore = ( $flags & self::CORE_ONLY );
$wantsRest = ( $flags & self::NO_CORE );
# Will hold the .txt parser test files we will include
$filesToTest = [];
# Filter out .txt files
$files = ParserTestRunner::getParserTestFiles();
foreach ( $files as $extName => $parserTestFile ) {
$isCore = str_starts_with( $parserTestFile, $mwTestDir );
if ( $isCore && $wantsCore ) {
self::debug( "included core parser tests: $parserTestFile" );
$filesToTest[$extName] = $parserTestFile;
} elseif ( !$isCore && $wantsRest ) {
self::debug( "included non core parser tests: $parserTestFile" );
$filesToTest[$extName] = $parserTestFile;
} else {
self::debug( "skipped parser tests: $parserTestFile" );
}
}
self::debug( 'parser tests files: '
. implode( ' ', $filesToTest ) );
$testList = [];
$counter = 0;
foreach ( $filesToTest as $extensionName => $fileName ) {
$isCore = str_starts_with( $fileName, $mwTestDir );
if ( is_int( $extensionName ) ) {
// If there's no extension name because this is coming
// from the legacy global, then assume the next level directory
// is the extension name (e.g. extensions/FooBar/parserTests.txt).
$extensionName = basename( dirname( $fileName ) );
}
$testsName = $extensionName . '__' . basename( $fileName, '.txt' );
$parserTestClassName = ucfirst( $testsName );
// Official spec for class names: https://www.php.net/manual/en/language.oop5.basic.php
// Prepend 'ParserTest_' to be paranoid about it not starting with a number
$parserTestClassName = 'ParserTest_' .
preg_replace( '/[^a-zA-Z0-9_\x7f-\xff]/', '_', $parserTestClassName );
$originalClassName = $parserTestClassName;
while ( isset( $testList[$parserTestClassName] ) ) {
// If there is a conflict, append a number.
$counter++;
$parserTestClassName = $originalClassName . '_' . $counter;
}
$testList[$parserTestClassName] = true;
// Previously we actually created a class here, with eval(). We now
// just override the name.
self::debug( "Adding test class $parserTestClassName" );
// Legacy parser
$this->addTest( new ParserTestFileSuite(
$this->ptRunner, "Legacy$parserTestClassName", $fileName ) );
// Parsoid (only run this on extensions for now, since Parsoid
// has its own copy of core's parser tests which it runs in its
// own test suite)
if ( !$isCore ) {
$this->addTest( new ParsoidTestFileSuite(
$this->ptRunner, "Parsoid$parserTestClassName", $fileName
) );
}
}
}
protected function setUp(): void {
// MediaWikiIntegrationTestCase leaves its test DB hanging around.
// we want to make sure we have a clean instance, so tear down any
// existing test DB. This has no effect if no test DB exists.
MediaWikiIntegrationTestCase::teardownTestDB();
// Similarly, make sure we don't reuse Test users from other tests
TestUserRegistry::clear();
$teardown = $this->ptRunner->setupDatabase( null );
$teardown = $this->ptRunner->staticSetup( $teardown );
$teardown = $this->ptRunner->setupUploads( $teardown );
$this->ptTeardownScope = $teardown;
}
protected function tearDown(): void {
if ( $this->ptTeardownScope ) {
ScopedCallback::consume( $this->ptTeardownScope );
}
TestUserRegistry::clear();
}
/**
* Write $msg under log group 'tests-parser'
* @param string $msg Message to log
*/
protected static function debug( $msg ) {
wfDebugLog( 'tests-parser', wfGetCaller() . ' ' . $msg );
}
}
|
