MediaWiki  REL1_31
ParserTestTopLevelSuite.php
Go to the documentation of this file.
1 <?php
2 use Wikimedia\ScopedCallback;
3 
13 class ParserTestTopLevelSuite extends PHPUnit_Framework_TestSuite {
15  private $ptRunner;
16 
19 
28  const CORE_ONLY = 1;
30  const NO_CORE = 2;
32  const WITH_ALL = 3; # CORE_ONLY | NO_CORE
33 
59  public static function suite( $flags = self::CORE_ONLY ) {
60  return new self( $flags );
61  }
62 
63  function __construct( $flags ) {
64  parent::__construct();
65 
66  $this->ptRecorder = new PhpunitTestRecorder;
67  $this->ptRunner = new ParserTestRunner( $this->ptRecorder );
68 
69  if ( is_string( $flags ) ) {
70  $flags = self::CORE_ONLY;
71  }
72  global $IP;
73 
74  $mwTestDir = $IP . '/tests/';
75 
76  # Human friendly helpers
77  $wantsCore = ( $flags & self::CORE_ONLY );
78  $wantsRest = ( $flags & self::NO_CORE );
79 
80  # Will hold the .txt parser test files we will include
81  $filesToTest = [];
82 
83  # Filter out .txt files
85  foreach ( $files as $extName => $parserTestFile ) {
86  $isCore = ( 0 === strpos( $parserTestFile, $mwTestDir ) );
87 
88  if ( $isCore && $wantsCore ) {
89  self::debug( "included core parser tests: $parserTestFile" );
90  $filesToTest[$extName] = $parserTestFile;
91  } elseif ( !$isCore && $wantsRest ) {
92  self::debug( "included non core parser tests: $parserTestFile" );
93  $filesToTest[$extName] = $parserTestFile;
94  } else {
95  self::debug( "skipped parser tests: $parserTestFile" );
96  }
97  }
98  self::debug( 'parser tests files: '
99  . implode( ' ', $filesToTest ) );
100 
101  $testList = [];
102  $counter = 0;
103  foreach ( $filesToTest as $extensionName => $fileName ) {
104  if ( is_int( $extensionName ) ) {
105  // If there's no extension name because this is coming
106  // from the legacy global, then assume the next level directory
107  // is the extension name (e.g. extensions/FooBar/parserTests.txt).
108  $extensionName = basename( dirname( $fileName ) );
109  }
110  $testsName = $extensionName . '__' . basename( $fileName, '.txt' );
111  $parserTestClassName = ucfirst( $testsName );
112 
113  // Official spec for class names: https://secure.php.net/manual/en/language.oop5.basic.php
114  // Prepend 'ParserTest_' to be paranoid about it not starting with a number
115  $parserTestClassName = 'ParserTest_' .
116  preg_replace( '/[^a-zA-Z0-9_\x7f-\xff]/', '_', $parserTestClassName );
117 
118  if ( isset( $testList[$parserTestClassName] ) ) {
119  // If there is a conflict, append a number.
120  $counter++;
121  $parserTestClassName .= $counter;
122  }
123  $testList[$parserTestClassName] = true;
124 
125  // Previously we actually created a class here, with eval(). We now
126  // just override the name.
127 
128  self::debug( "Adding test class $parserTestClassName" );
129  $this->addTest( new ParserTestFileSuite(
130  $this->ptRunner, $parserTestClassName, $fileName ) );
131  }
132  }
133 
134  public function setUp() {
135  wfDebug( __METHOD__ );
136  $db = wfGetDB( DB_MASTER );
137  $type = $db->getType();
138  $prefix = $type === 'oracle' ?
140  MediaWikiTestCase::setupTestDB( $db, $prefix );
141  $teardown = $this->ptRunner->setDatabase( $db );
142  $teardown = $this->ptRunner->setupUploads( $teardown );
143  $this->ptTeardownScope = $teardown;
144  }
145 
146  public function tearDown() {
147  wfDebug( __METHOD__ );
148  if ( $this->ptTeardownScope ) {
149  ScopedCallback::consume( $this->ptTeardownScope );
150  }
151  }
152 
157  protected static function debug( $msg ) {
158  wfDebugLog( 'tests-parser', wfGetCaller() . ' ' . $msg );
159  }
160 }
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ParserTestTopLevelSuite\debug
static debug( $msg)
Write $msg under log group 'tests-parser'.
Definition: ParserTestTopLevelSuite.php:157
ParserTestRunner\getParserTestFiles
static getParserTestFiles()
Get list of filenames to extension and core parser tests.
Definition: ParserTestRunner.php:167
ParserTestTopLevelSuite
The UnitTest must be either a class that inherits from MediaWikiTestCase or a class that provides a p...
Definition: ParserTestTopLevelSuite.php:13
ParserTestTopLevelSuite\$ptTeardownScope
ScopedCallback $ptTeardownScope
Definition: ParserTestTopLevelSuite.php:18
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1087
ParserTestTopLevelSuite\suite
static suite( $flags=self::CORE_ONLY)
Get a PHPUnit test suite of parser tests.
Definition: ParserTestTopLevelSuite.php:59
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
ParserTestTopLevelSuite\tearDown
tearDown()
Definition: ParserTestTopLevelSuite.php:146
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
ParserTestTopLevelSuite\CORE_ONLY
const CORE_ONLY
Include files shipped with MediaWiki core.
Definition: ParserTestTopLevelSuite.php:28
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
ParserTestTopLevelSuite\WITH_ALL
const WITH_ALL
Include anything set via $wgParserTestFiles.
Definition: ParserTestTopLevelSuite.php:32
ParserTestTopLevelSuite\__construct
__construct( $flags)
Definition: ParserTestTopLevelSuite.php:63
MediaWikiTestCase\setupTestDB
static setupTestDB(Database $db, $prefix)
Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using th...
Definition: MediaWikiTestCase.php:1241
ParserTestFileSuite
This is the suite class for running tests within a single .txt source file.
Definition: ParserTestFileSuite.php:8
ParserTestTopLevelSuite\$ptRunner
ParserTestRunner $ptRunner
Definition: ParserTestTopLevelSuite.php:15
MediaWikiTestCase\DB_PREFIX
const DB_PREFIX
Table name prefixes.
Definition: MediaWikiTestCase.php:109
MediaWikiTestCase\ORA_DB_PREFIX
const ORA_DB_PREFIX
Definition: MediaWikiTestCase.php:110
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
ParserTestTopLevelSuite\NO_CORE
const NO_CORE
Include non core files as set in $wgParserTestFiles.
Definition: ParserTestTopLevelSuite.php:30
PhpunitTestRecorder
Definition: PhpunitTestRecorder.php:3
$IP
$IP
Definition: WebStart.php:52
wfGetCaller
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
Definition: GlobalFunctions.php:1547
ParserTestTopLevelSuite\setUp
setUp()
Definition: ParserTestTopLevelSuite.php:134
ParserTestRunner
Definition: ParserTestRunner.php:36
$type
$type
Definition: testCompression.php:48