tests/parser/parserTests.php

   1 <?php
   2 /**
   3  * MediaWiki parser test suite
   4  *
   5  * Copyright © 2004 Brion Vibber <brion@pobox.com>
   6  * https://www.mediawiki.org/
   7  *
   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.
  12  *
  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.
  17  *
  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
  22  *
  23  * @file
  24  * @ingroup Testing
  25  */
  26
  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 );
  30
  31 require __DIR__ . '/../../maintenance/Maintenance.php';
  32
  33 use MediaWiki\MediaWikiServices;
  34
  35 class ParserTestsMaintenance extends Maintenance {
  36         function __construct() {
  37                 parent::__construct();
  38                 $this->addDescription( 'Run parser tests' );
  39
  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',
  45                         false, true );
  46                 $this->addOption( 'regex', 'Only run tests whose descriptions which match given regex',
  47                         false, true );
  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)',
  55                         false, true );
  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( 'dwdiff', 'Use dwdiff to display diff output' );
  66                 $this->addOption( 'mark-ws', 'Mark whitespace in diffs by replacing it with symbols' );
  67                 $this->addOption( 'norm', 'Apply a comma-separated list of normalization functions to ' .
  68                         'both the expected and actual output in order to resolve ' .
  69                         'irrelevant differences. The accepted normalization functions ' .
  70                         'are: removeTbody to remove <tbody> tags; and trimWhitespace ' .
  71                         'to trim whitespace from the start and end of text nodes.',
  72                         false, true );
  73                 $this->addOption( 'use-tidy-config',
  74                         'Use the wiki\'s Tidy configuration instead of known-good' .
  75                         'defaults.' );
  76         }
  77
  78         public function finalSetup() {
  79                 parent::finalSetup();
  80                 self::requireTestsAutoloader();
  81                 TestSetup::applyInitialConfig();
  82         }
  83
  84         public function execute() {
  85                 global $wgDBtype;
  86
  87                 // Cases of weird db corruption were encountered when running tests on earlyish
  88                 // versions of SQLite
  89                 if ( $wgDBtype == 'sqlite' ) {
  90                         $db = wfGetDB( DB_MASTER );
  91                         $version = $db->getServerVersion();
  92                         if ( version_compare( $version, '3.6' ) < 0 ) {
  93                                 die( "Parser tests require SQLite version 3.6 or later, you have $version\n" );
  94                         }
  95                 }
  96
  97                 // Print out software version to assist with locating regressions
  98                 $version = SpecialVersion::getVersion( 'nodb' );
  99                 echo "This is MediaWiki version {$version}.\n\n";
 100
 101                 // Only colorize output if stdout is a terminal.
 102                 $color = !wfIsWindows() && Maintenance::posix_isatty( 1 );
 103
 104                 if ( $this->hasOption( 'color' ) ) {
 105                         switch ( $this->getOption( 'color' ) ) {
 106                                 case 'no':
 107                                         $color = false;
 108                                         break;
 109                                 case 'yes':
 110                                 default:
 111                                         $color = true;
 112                                         break;
 113                         }
 114                 }
 115
 116                 $record = $this->hasOption( 'record' );
 117                 $compare = $this->hasOption( 'compare' );
 118
 119                 $regex = $this->getOption( 'filter', $this->getOption( 'regex', false ) );
 120                 if ( $regex !== false ) {
 121                         $regex = "/$regex/i";
 122
 123                         if ( $record ) {
 124                                 echo "Warning: --record cannot be used with --regex, disabling --record\n";
 125                                 $record = false;
 126                         }
 127                 }
 128
 129                 $term = $color
 130                         ? new AnsiTermColorer()
 131                         : new DummyTermColorer();
 132
 133                 $recorder = new MultiTestRecorder;
 134
 135                 $recorder->addRecorder( new ParserTestPrinter(
 136                         $term,
 137                         [
 138                                 'showDiffs' => !$this->hasOption( 'quick' ),
 139                                 'showProgress' => !$this->hasOption( 'quiet' ),
 140                                 'showFailure' => !$this->hasOption( 'quiet' )
 141                                                 || ( !$record && !$compare ), // redundant output
 142                                 'showOutput' => $this->hasOption( 'show-output' ),
 143                                 'useDwdiff' => $this->hasOption( 'dwdiff' ),
 144                                 'markWhitespace' => $this->hasOption( 'mark-ws' ),
 145                         ]
 146                 ) );
 147
 148                 $recorderLB = false;
 149                 if ( $record || $compare ) {
 150                         $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 151                         $recorderLB = $lbFactory->newMainLB();
 152                         // This connection will have the wiki's table prefix, not parsertest_
 153                         $recorderDB = $recorderLB->getConnection( DB_MASTER );
 154
 155                         // Add recorder before previewer because recorder will create the
 156                         // DB table if it doesn't exist
 157                         if ( $record ) {
 158                                 $recorder->addRecorder( new DbTestRecorder( $recorderDB ) );
 159                         }
 160                         $recorder->addRecorder( new DbTestPreviewer(
 161                                 $recorderDB,
 162                                 function ( $name ) use ( $regex ) {
 163                                         // Filter reports of old tests by the filter regex
 164                                         if ( $regex === false ) {
 165                                                 return true;
 166                                         } else {
 167                                                 return (bool)preg_match( $regex, $name );
 168                                         }
 169                                 } ) );
 170                 }
 171
 172                 // Default parser tests and any set from extensions or local config
 173                 $files = $this->getOption( 'file', ParserTestRunner::getParserTestFiles() );
 174
 175                 $norm = $this->hasOption( 'norm' ) ? explode( ',', $this->getOption( 'norm' ) ) : [];
 176
 177                 $tester = new ParserTestRunner( $recorder, [
 178                         'norm' => $norm,
 179                         'regex' => $regex,
 180                         'keep-uploads' => $this->hasOption( 'keep-uploads' ),
 181                         'run-disabled' => $this->hasOption( 'run-disabled' ),
 182                         'run-parsoid' => $this->hasOption( 'run-parsoid' ),
 183                         'use-tidy-config' => $this->hasOption( 'use-tidy-config' ),
 184                         'file-backend' => $this->getOption( 'file-backend' ),
 185                         'upload-dir' => $this->getOption( 'upload-dir' ),
 186                 ] );
 187
 188                 $ok = $tester->runTestsFromFiles( $files );
 189                 if ( $recorderLB ) {
 190                         $recorderLB->closeAll();
 191                 }
 192                 if ( !$ok ) {
 193                         exit( 1 );
 194                 }
 195         }
 196 }
 197
 198 $maintClass = 'ParserTestsMaintenance';
 199 require_once RUN_MAINTENANCE_IF_MAIN;