MediaWiki  master
ParserTestTopLevelSuite.php
Go to the documentation of this file.
1 <?php
2 
4 
14 class ParserTestTopLevelSuite extends PHPUnit_Framework_TestSuite {
16  private $ptRunner;
17 
20 
21  private $oldTablePrefix = '';
22 
31  const CORE_ONLY = 1;
33  const NO_CORE = 2;
35  const WITH_ALL = self::CORE_ONLY | self::NO_CORE;
36 
62  public static function suite( $flags = self::CORE_ONLY ) {
63  return new self( $flags );
64  }
65 
66  function __construct( $flags ) {
67  parent::__construct();
68 
69  $this->ptRecorder = new PhpunitTestRecorder;
70  $this->ptRunner = new ParserTestRunner( $this->ptRecorder );
71 
72  if ( is_string( $flags ) ) {
73  $flags = self::CORE_ONLY;
74  }
75  global $IP;
76 
77  $mwTestDir = $IP . '/tests/';
78 
79  # Human friendly helpers
80  $wantsCore = ( $flags & self::CORE_ONLY );
81  $wantsRest = ( $flags & self::NO_CORE );
82 
83  # Will hold the .txt parser test files we will include
84  $filesToTest = [];
85 
86  # Filter out .txt files
88  foreach ( $files as $extName => $parserTestFile ) {
89  $isCore = ( strpos( $parserTestFile, $mwTestDir ) === 0 );
90 
91  if ( $isCore && $wantsCore ) {
92  self::debug( "included core parser tests: $parserTestFile" );
93  $filesToTest[$extName] = $parserTestFile;
94  } elseif ( !$isCore && $wantsRest ) {
95  self::debug( "included non core parser tests: $parserTestFile" );
96  $filesToTest[$extName] = $parserTestFile;
97  } else {
98  self::debug( "skipped parser tests: $parserTestFile" );
99  }
100  }
101  self::debug( 'parser tests files: '
102  . implode( ' ', $filesToTest ) );
103 
104  $testList = [];
105  $counter = 0;
106  foreach ( $filesToTest as $extensionName => $fileName ) {
107  if ( is_int( $extensionName ) ) {
108  // If there's no extension name because this is coming
109  // from the legacy global, then assume the next level directory
110  // is the extension name (e.g. extensions/FooBar/parserTests.txt).
111  $extensionName = basename( dirname( $fileName ) );
112  }
113  $testsName = $extensionName . '__' . basename( $fileName, '.txt' );
114  $parserTestClassName = ucfirst( $testsName );
115 
116  // Official spec for class names: https://www.php.net/manual/en/language.oop5.basic.php
117  // Prepend 'ParserTest_' to be paranoid about it not starting with a number
118  $parserTestClassName = 'ParserTest_' .
119  preg_replace( '/[^a-zA-Z0-9_\x7f-\xff]/', '_', $parserTestClassName );
120 
121  if ( isset( $testList[$parserTestClassName] ) ) {
122  // If there is a conflict, append a number.
123  $counter++;
124  $parserTestClassName .= $counter;
125  }
126  $testList[$parserTestClassName] = true;
127 
128  // Previously we actually created a class here, with eval(). We now
129  // just override the name.
130 
131  self::debug( "Adding test class $parserTestClassName" );
132  $this->addTest( new ParserTestFileSuite(
133  $this->ptRunner, $parserTestClassName, $fileName ) );
134  }
135  }
136 
137  public function setUp() {
138  wfDebug( __METHOD__ );
139 
140  $db = wfGetDB( DB_MASTER );
141  $type = $db->getType();
142  $prefix = $type === 'oracle' ?
144  $this->oldTablePrefix = $db->tablePrefix();
145  MediaWikiTestCase::setupTestDB( $db, $prefix );
146  CloneDatabase::changePrefix( $prefix );
147 
148  $this->ptRunner->setDatabase( $db );
149 
151 
153  $teardown = new ScopedCallback( function () {
155  } );
156 
157  $teardown = $this->ptRunner->setupUploads( $teardown );
158  $this->ptTeardownScope = $teardown;
159  }
160 
161  public function tearDown() {
162  wfDebug( __METHOD__ );
163  if ( $this->ptTeardownScope ) {
164  ScopedCallback::consume( $this->ptTeardownScope );
165  }
166  CloneDatabase::changePrefix( $this->oldTablePrefix );
167  }
168 
173  protected static function debug( $msg ) {
174  wfDebugLog( 'tests-parser', wfGetCaller() . ' ' . $msg );
175  }
176 }
static setupTestDB(IMaintainableDatabase $db, $prefix)
Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using th...
const DB_PREFIX
Table name prefixes.
$IP
Definition: WebStart.php:41
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
static debug( $msg)
Write $msg under log group &#39;tests-parser&#39;.
const DB_MASTER
Definition: defines.php:26
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
const CORE_ONLY
Include files shipped with MediaWiki core.
static suite( $flags=self::CORE_ONLY)
Get a PHPUnit test suite of parser tests.
static resetNonServiceCaches()
Resets some non-service singleton instances and other static caches.
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
const WITH_ALL
Include anything set via $wgParserTestFiles.
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:9
static installMockMwServices(Config $configOverrides=null)
Creates a new "mock" MediaWikiServices instance, and installs it.
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:35
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
const NO_CORE
Include non core files as set in $wgParserTestFiles.
This is the suite class for running tests within a single .txt source file.
static getParserTestFiles()
Get list of filenames to extension and core parser tests.
static changePrefix( $prefix)
Change the table prefix on all open DB connections.
The UnitTest must be either a class that inherits from MediaWikiTestCase or a class that provides a p...
static restoreMwServices()
Restores the original, non-mock MediaWikiServices instance.