MediaWikiParserTest.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/NewParserTest.php';

class MediaWikiParserTest {

    const CORE_ONLY = 1;
    const NO_CORE = 2;
    const WITH_ALL = 3; # CORE_ONLY | NO_CORE

    public static function suite( $flags = self::CORE_ONLY ) {
        if ( is_string( $flags ) ) {
            $flags = self::CORE_ONLY;
        }
        global $wgParserTestFiles, $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
        foreach ( $wgParserTestFiles as $parserTestFile ) {
            $isCore = ( 0 === strpos( $parserTestFile, $mwTestDir ) );

            if ( $isCore && $wantsCore ) {
                self::debug( "included core parser tests: $parserTestFile" );
                $filesToTest[] = $parserTestFile;
            } elseif ( !$isCore && $wantsRest ) {
                self::debug( "included non core parser tests: $parserTestFile" );
                $filesToTest[] = $parserTestFile;
            } else {
                self::debug( "skipped parser tests: $parserTestFile" );
            }
        }
        self::debug( 'parser tests files: '
            . implode( ' ', $filesToTest ) );

        $suite = new PHPUnit_Framework_TestSuite;
        $testList = [];
        $counter = 0;
        foreach ( $filesToTest as $fileName ) {
            // Call the highest level directory the extension name.
            // It may or may not actually be, but it should be close
            // enough to cause there to be separate names for different
            // things, which is good enough for our purposes.
            $extensionName = basename( dirname( $fileName ) );
            $testsName = $extensionName . '__' . basename( $fileName, '.txt' );
            $escapedFileName = strtr( $fileName, [ "'" => "\\'", '\\' => '\\\\' ] );
            $parserTestClassName = ucfirst( $testsName );

            // Official spec for class names: http://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 );

            if ( isset( $testList[$parserTestClassName] ) ) {
                // If a conflict happens, gives a very unclear fatal.
                // So as a last ditch effort to prevent that eventuality, if there
                // is a conflict, append a number.
                $counter++;
                $parserTestClassName .= $counter;
            }
            $testList[$parserTestClassName] = true;
            $parserTestClassDefinition = <<<EOT
class $parserTestClassName extends NewParserTest {
    protected \$file = '$escapedFileName';
}
EOT;

            eval( $parserTestClassDefinition );
            self::debug( "Adding test class $parserTestClassName" );
            $suite->addTestSuite( $parserTestClassName );
        }
        return $suite;
    }

    protected static function debug( $msg ) {
        return wfDebugLog( 'tests-parser', wfGetCaller() . ' ' . $msg );
    }
}