3 * MediaWiki parser test suite
5 * Copyright © 2004 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
27 // Some methods which are discouraged for normal code throw exceptions unless
28 // we declare this is just a test.
29 define( 'MW_PARSER_TEST', true );
31 require __DIR__
. '/../../maintenance/Maintenance.php';
33 use MediaWiki\MediaWikiServices
;
35 class ParserTestsMaintenance
extends Maintenance
{
36 function __construct() {
37 parent
::__construct();
38 $this->addDescription( 'Run parser tests' );
40 $this->addOption( 'quick', 'Suppress diff output of failed tests' );
41 $this->addOption( 'quiet', 'Suppress notification of passed tests (shows only failed tests)' );
42 $this->addOption( 'show-output', 'Show expected and actual output' );
43 $this->addOption( 'color', '[=yes|no] Override terminal detection and force ' .
44 'color output on or off. Use wgCommandLineDarkBg = true; if your term is dark',
46 $this->addOption( 'regex', 'Only run tests whose descriptions which match given regex',
48 $this->addOption( 'filter', 'Alias for --regex', false, true );
49 $this->addOption( 'file', 'Run test cases from a custom file instead of parserTests.txt',
50 false, true, false, true );
51 $this->addOption( 'record', 'Record tests in database' );
52 $this->addOption( 'compare', 'Compare with recorded results, without updating the database.' );
53 $this->addOption( 'setversion', 'When using --record, set the version string to use (useful' .
54 'with "git rev-parse HEAD" to get the exact revision)',
56 $this->addOption( 'keep-uploads', 'Re-use the same upload directory for each ' .
57 'test, don\'t delete it' );
58 $this->addOption( 'file-backend', 'Use the file backend with the given name,' .
59 'and upload files to it, instead of creating a mock file backend.', false, true );
60 $this->addOption( 'upload-dir', 'Specify the upload directory to use. Useful in ' .
61 'conjunction with --keep-uploads. Causes a real (non-mock) file backend to ' .
62 'be used.', false, true );
63 $this->addOption( 'run-disabled', 'run disabled tests' );
64 $this->addOption( 'run-parsoid', 'run parsoid tests (normally disabled)' );
65 $this->addOption( 'disable-save-parse', 'Don\'t run the parser when ' .
66 'inserting articles into the database' );
67 $this->addOption( 'dwdiff', 'Use dwdiff to display diff output' );
68 $this->addOption( 'mark-ws', 'Mark whitespace in diffs by replacing it with symbols' );
69 $this->addOption( 'norm', 'Apply a comma-separated list of normalization functions to ' .
70 'both the expected and actual output in order to resolve ' .
71 'irrelevant differences. The accepted normalization functions ' .
72 'are: removeTbody to remove <tbody> tags; and trimWhitespace ' .
73 'to trim whitespace from the start and end of text nodes.',
75 $this->addOption( 'use-tidy-config',
76 'Use the wiki\'s Tidy configuration instead of known-good' .
80 public function finalSetup() {
82 self
::requireTestsAutoloader();
83 TestSetup
::applyInitialConfig();
86 public function execute() {
89 // Cases of weird db corruption were encountered when running tests on earlyish
91 if ( $wgDBtype == 'sqlite' ) {
92 $db = wfGetDB( DB_MASTER
);
93 $version = $db->getServerVersion();
94 if ( version_compare( $version, '3.6' ) < 0 ) {
95 die( "Parser tests require SQLite version 3.6 or later, you have $version\n" );
99 // Print out software version to assist with locating regressions
100 $version = SpecialVersion
::getVersion( 'nodb' );
101 echo "This is MediaWiki version {$version}.\n\n";
103 // Only colorize output if stdout is a terminal.
104 $color = !wfIsWindows() && Maintenance
::posix_isatty( 1 );
106 if ( $this->hasOption( 'color' ) ) {
107 switch ( $this->getOption( 'color' ) ) {
118 $record = $this->hasOption( 'record' );
119 $compare = $this->hasOption( 'compare' );
121 $regex = $this->getOption( 'filter', $this->getOption( 'regex', false ) );
122 if ( $regex !== false ) {
123 $regex = "/$regex/i";
126 echo "Warning: --record cannot be used with --regex, disabling --record\n";
132 ?
new AnsiTermColorer()
133 : new DummyTermColorer();
135 $recorder = new MultiTestRecorder
;
137 $recorder->addRecorder( new ParserTestPrinter(
140 'showDiffs' => !$this->hasOption( 'quick' ),
141 'showProgress' => !$this->hasOption( 'quiet' ),
142 'showFailure' => !$this->hasOption( 'quiet' )
143 ||
( !$record && !$compare ), // redundant output
144 'showOutput' => $this->hasOption( 'show-output' ),
145 'useDwdiff' => $this->hasOption( 'dwdiff' ),
146 'markWhitespace' => $this->hasOption( 'mark-ws' ),
151 if ( $record ||
$compare ) {
152 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
153 $recorderLB = $lbFactory->newMainLB();
154 // This connection will have the wiki's table prefix, not parsertest_
155 $recorderDB = $recorderLB->getConnection( DB_MASTER
);
157 // Add recorder before previewer because recorder will create the
158 // DB table if it doesn't exist
160 $recorder->addRecorder( new DbTestRecorder( $recorderDB ) );
162 $recorder->addRecorder( new DbTestPreviewer(
164 function ( $name ) use ( $regex ) {
165 // Filter reports of old tests by the filter regex
166 if ( $regex === false ) {
169 return (bool)preg_match( $regex, $name );
174 // Default parser tests and any set from extensions or local config
175 $files = $this->getOption( 'file', ParserTestRunner
::getParserTestFiles() );
177 $norm = $this->hasOption( 'norm' ) ?
explode( ',', $this->getOption( 'norm' ) ) : [];
179 $tester = new ParserTestRunner( $recorder, [
182 'keep-uploads' => $this->hasOption( 'keep-uploads' ),
183 'run-disabled' => $this->hasOption( 'run-disabled' ),
184 'run-parsoid' => $this->hasOption( 'run-parsoid' ),
185 'disable-save-parse' => $this->hasOption( 'disable-save-parse' ),
186 'use-tidy-config' => $this->hasOption( 'use-tidy-config' ),
187 'file-backend' => $this->getOption( 'file-backend' ),
188 'upload-dir' => $this->getOption( 'upload-dir' ),
191 $ok = $tester->runTestsFromFiles( $files );
193 $recorderLB->closeAll();
201 $maintClass = 'ParserTestsMaintenance';
202 require_once RUN_MAINTENANCE_IF_MAIN
;