parserTests.php

Go to the documentation of this file.

<?php
// Some methods which are discouraged for normal code throw exceptions unless
// we declare this is just a test.
define( 'MW_PARSER_TEST', true );

require __DIR__ . '/../../maintenance/Maintenance.php';

class ParserTestsMaintenance extends Maintenance {
    function __construct() {
        parent::__construct();
        $this->addDescription( 'Run parser tests' );

        $this->addOption( 'quick', 'Suppress diff output of failed tests' );
        $this->addOption( 'quiet', 'Suppress notification of passed tests (shows only failed tests)' );
        $this->addOption( 'show-output', 'Show expected and actual output' );
        $this->addOption( 'color', '[=yes|no] Override terminal detection and force ' .
            'color output on or off. Use wgCommandLineDarkBg = true; if your term is dark',
            false, true );
        $this->addOption( 'regex', 'Only run tests whose descriptions which match given regex',
            false, true );
        $this->addOption( 'filter', 'Alias for --regex', false, true );
        $this->addOption( 'file', 'Run test cases from a custom file instead of parserTests.txt',
            false, true, false, true );
        $this->addOption( 'record', 'Record tests in database' );
        $this->addOption( 'compare', 'Compare with recorded results, without updating the database.' );
        $this->addOption( 'setversion', 'When using --record, set the version string to use (useful' .
            'with "git rev-parse HEAD" to get the exact revision)',
            false, true );
        $this->addOption( 'keep-uploads', 'Re-use the same upload directory for each ' .
            'test, don\'t delete it' );
        $this->addOption( 'file-backend', 'Use the file backend with the given name,' .
            'and upload files to it, instead of creating a mock file backend.', false, true );
        $this->addOption( 'upload-dir', 'Specify the upload directory to use. Useful in ' .
            'conjunction with --keep-uploads. Causes a real (non-mock) file backend to ' .
            'be used.', false, true );
        $this->addOption( 'run-disabled', 'run disabled tests' );
        $this->addOption( 'run-parsoid', 'run parsoid tests (normally disabled)' );
        $this->addOption( 'dwdiff', 'Use dwdiff to display diff output' );
        $this->addOption( 'mark-ws', 'Mark whitespace in diffs by replacing it with symbols' );
        $this->addOption( 'norm', 'Apply a comma-separated list of normalization functions to ' .
            'both the expected and actual output in order to resolve ' .
            'irrelevant differences. The accepted normalization functions ' .
            'are: removeTbody to remove <tbody> tags; and trimWhitespace ' .
            'to trim whitespace from the start and end of text nodes.',
            false, true );
        $this->addOption( 'use-tidy-config', 'Use the wiki\'s Tidy configuration instead of known-good' .
            'defaults.' );
    }

    public function finalSetup() {
        parent::finalSetup();
        self::requireTestsAutoloader();
        TestSetup::applyInitialConfig();
    }

    public function execute() {
        global $wgParserTestFiles, $wgDBtype;

        // Cases of weird db corruption were encountered when running tests on earlyish
        // versions of SQLite
        if ( $wgDBtype == 'sqlite' ) {
            $db = wfGetDB( DB_MASTER );
            $version = $db->getServerVersion();
            if ( version_compare( $version, '3.6' ) < 0 ) {
                die( "Parser tests require SQLite version 3.6 or later, you have $version\n" );
            }
        }

        // Print out software version to assist with locating regressions
        $version = SpecialVersion::getVersion( 'nodb' );
        echo "This is MediaWiki version {$version}.\n\n";

        // Only colorize output if stdout is a terminal.
        $color = !wfIsWindows() && Maintenance::posix_isatty( 1 );

        if ( $this->hasOption( 'color' ) ) {
            switch ( $this->getOption( 'color' ) ) {
                case 'no':
                    $color = false;
                    break;
                case 'yes':
                default:
                    $color = true;
                    break;
            }
        }

        $record = $this->hasOption( 'record' );
        $compare = $this->hasOption( 'compare' );

        $regex = $this->getOption( 'filter', $this->getOption( 'regex', false ) );
        if ( $regex !== false ) {
            $regex = "/$regex/i";

            if ( $record ) {
                echo "Warning: --record cannot be used with --regex, disabling --record\n";
                $record = false;
            }
        }

        $term = $color
            ? new AnsiTermColorer()
            : new DummyTermColorer();

        $recorder = new MultiTestRecorder;

        $recorder->addRecorder( new ParserTestPrinter(
            $term,
            [
                'showDiffs' => !$this->hasOption( 'quick' ),
                'showProgress' => !$this->hasOption( 'quiet' ),
                'showFailure' => !$this->hasOption( 'quiet' )
                        || ( !$record && !$compare ), // redundant output
                'showOutput' => $this->hasOption( 'show-output' ),
                'useDwdiff' => $this->hasOption( 'dwdiff' ),
                'markWhitespace' => $this->hasOption( 'mark-ws' ),
            ]
        ) );

        $recorderLB = false;
        if ( $record || $compare ) {
            $recorderLB = wfGetLBFactory()->newMainLB();
            // This connection will have the wiki's table prefix, not parsertest_
            $recorderDB = $recorderLB->getConnection( DB_MASTER );

            // Add recorder before previewer because recorder will create the
            // DB table if it doesn't exist
            if ( $record ) {
                $recorder->addRecorder( new DbTestRecorder( $recorderDB ) );
            }
            $recorder->addRecorder( new DbTestPreviewer(
                $recorderDB,
                function ( $name ) use ( $regex ) {
                    // Filter reports of old tests by the filter regex
                    if ( $regex === false ) {
                        return true;
                    } else {
                        return (bool)preg_match( $regex, $name );
                    }
                } ) );
        }

        // Default parser tests and any set from extensions or local config
        $files = $this->getOption( 'file', $wgParserTestFiles );

        $norm = $this->hasOption( 'norm' ) ? explode( ',', $this->getOption( 'norm' ) ) : [];

        $tester = new ParserTestRunner( $recorder, [
            'norm' => $norm,
            'regex' => $regex,
            'keep-uploads' => $this->hasOption( 'keep-uploads' ),
            'run-disabled' => $this->hasOption( 'run-disabled' ),
            'run-parsoid' => $this->hasOption( 'run-parsoid' ),
            'use-tidy-config' => $this->hasOption( 'use-tidy-config' ),
            'file-backend' => $this->getOption( 'file-backend' ),
            'upload-dir' => $this->getOption( 'upload-dir' ),
        ] );

        $ok = $tester->runTestsFromFiles( $files );
        if ( $recorderLB ) {
            $recorderLB->closeAll();
        }
        if ( !$ok ) {
            exit( 1 );
        }
    }
}

$maintClass = 'ParserTestsMaintenance';
require_once RUN_MAINTENANCE_IF_MAIN;