MediaWiki  1.30.0
DumpTestCase.php
Go to the documentation of this file.
1 <?php
2 
6 abstract class DumpTestCase extends MediaWikiLangTestCase {
7 
19  protected $exceptionFromAddDBData = null;
20 
26  protected $xml = null;
27 
29  protected static $hasGzip = null;
30 
36  protected function checkHasGzip() {
37  if ( self::$hasGzip === null ) {
38  self::$hasGzip = ( Installer::locateExecutableInDefaultPaths( 'gzip' ) !== false );
39  }
40 
41  if ( !self::$hasGzip ) {
42  $this->markTestSkipped( "Skip test, requires the gzip utility in PATH" );
43  }
44 
45  return self::$hasGzip;
46  }
47 
59  protected function addRevision( Page $page, $text, $summary, $model = CONTENT_MODEL_WIKITEXT ) {
60  $status = $page->doEditContent(
61  ContentHandler::makeContent( $text, $page->getTitle(), $model ),
62  $summary
63  );
64 
65  if ( $status->isGood() ) {
66  $value = $status->getValue();
67  $revision = $value['revision'];
68  $revision_id = $revision->getId();
69  $text_id = $revision->getTextId();
70 
71  if ( ( $revision_id > 0 ) && ( $text_id > 0 ) ) {
72  return [ $revision_id, $text_id ];
73  }
74  }
75 
76  throw new MWException( "Could not determine revision id ("
77  . $status->getWikiText( false, false, 'en' ) . ")" );
78  }
79 
86  protected function gunzip( $fname ) {
87  $gzipped_contents = file_get_contents( $fname );
88  if ( $gzipped_contents === false ) {
89  $this->fail( "Could not get contents of $fname" );
90  }
91 
92  $contents = gzdecode( $gzipped_contents );
93 
94  $this->assertEquals(
95  strlen( $contents ),
96  file_put_contents( $fname, $contents ),
97  '# bytes written'
98  );
99  }
100 
106  protected function setUp() {
107  parent::setUp();
108 
109  // Check if any Exception is stored for rethrowing from addDBData
110  // @see self::exceptionFromAddDBData
111  if ( $this->exceptionFromAddDBData !== null ) {
113  }
114 
115  $this->setMwGlobals( 'wgUser', new User() );
116  }
117 
121  function expectETAOutput() {
122  // Newer PHPUnits require assertion about the output using PHPUnit's own
123  // expectOutput[...] functions. However, the PHPUnit shipped prediactes
124  // do not allow to check /each/ line of the output using /readable/ REs.
125  // So we ...
126 
127  // 1. ... add a dummy output checking to make PHPUnit not complain
128  // about unchecked test output
129  $this->expectOutputRegex( '//' );
130 
131  // 2. Do the real output checking on our own.
132  $lines = explode( "\n", $this->getActualOutput() );
133  $this->assertGreaterThan( 1, count( $lines ), "Minimal lines of produced output" );
134  $this->assertEquals( '', array_pop( $lines ), "Output ends in LF" );
135  $timestamp_re = "[0-9]{4}-[01][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-6][0-9]";
136  foreach ( $lines as $line ) {
137  $this->assertRegExp(
138  "/$timestamp_re: .* \(ID [0-9]+\) [0-9]* pages .*, [0-9]* revs .*, ETA/",
139  $line
140  );
141  }
142  }
143 
152  protected function skipToNodeEnd( $name ) {
153  while ( $this->xml->read() ) {
154  if ( $this->xml->nodeType == XMLReader::END_ELEMENT &&
155  $this->xml->name == $name
156  ) {
157  return true;
158  }
159  }
160 
161  return false;
162  }
163 
174  protected function skipPastNodeEnd( $name ) {
175  $this->assertTrue( $this->skipToNodeEnd( $name ),
176  "Skipping to end of $name" );
177  while ( $this->xml->read() ) {
178  if ( $this->xml->nodeType == XMLReader::ELEMENT ) {
179  return true;
180  }
181  }
182 
183  return false;
184  }
185 
193  protected function assertDumpStart( $fname, $skip_siteinfo = true ) {
194  $this->xml = new XMLReader();
195  $this->assertTrue( $this->xml->open( $fname ),
196  "Opening temporary file $fname via XMLReader failed" );
197  if ( $skip_siteinfo ) {
198  $this->assertTrue( $this->skipPastNodeEnd( "siteinfo" ),
199  "Skipping past end of siteinfo" );
200  }
201  }
202 
210  protected function assertDumpEnd( $name = "mediawiki" ) {
211  $this->assertNodeEnd( $name, false );
212  if ( $this->xml->read() ) {
213  $this->skipWhitespace();
214  }
215  $this->assertEquals( $this->xml->nodeType, XMLReader::NONE,
216  "No proper entity left to parse" );
217  $this->xml->close();
218  }
219 
223  protected function skipWhitespace() {
224  $cont = true;
225  while ( $cont && ( ( $this->xml->nodeType == XMLReader::WHITESPACE )
226  || ( $this->xml->nodeType == XMLReader::SIGNIFICANT_WHITESPACE ) ) ) {
227  $cont = $this->xml->read();
228  }
229  }
230 
239  protected function assertNodeStart( $name, $skip = true ) {
240  $this->assertEquals( $name, $this->xml->name, "Node name" );
241  $this->assertEquals( XMLReader::ELEMENT, $this->xml->nodeType, "Node type" );
242  if ( $skip ) {
243  $this->assertTrue( $this->xml->read(), "Skipping past start tag" );
244  }
245  }
246 
255  protected function assertNodeEnd( $name, $skip = true ) {
256  $this->assertEquals( $name, $this->xml->name, "Node name" );
257  $this->assertEquals( XMLReader::END_ELEMENT, $this->xml->nodeType, "Node type" );
258  if ( $skip ) {
259  $this->assertTrue( $this->xml->read(), "Skipping past end tag" );
260  }
261  }
262 
274  protected function assertTextNode( $name, $text, $skip_ws = true ) {
275  $this->assertNodeStart( $name );
276 
277  if ( $text !== false ) {
278  $this->assertEquals( $text, $this->xml->value, "Text of node " . $name );
279  }
280  $this->assertTrue( $this->xml->read(), "Skipping past processed text of " . $name );
281  $this->assertNodeEnd( $name );
282 
283  if ( $skip_ws ) {
284  $this->skipWhitespace();
285  }
286  }
287 
300  protected function assertPageStart( $id, $ns, $name ) {
301  $this->assertNodeStart( "page" );
302  $this->skipWhitespace();
303 
304  $this->assertTextNode( "title", $name );
305  $this->assertTextNode( "ns", $ns );
306  $this->assertTextNode( "id", $id );
307  }
308 
313  protected function assertPageEnd() {
314  $this->assertNodeEnd( "page" );
315  $this->skipWhitespace();
316  }
317 
333  protected function assertRevision( $id, $summary, $text_id, $text_bytes,
334  $text_sha1, $text = false, $parentid = false,
336  ) {
337  $this->assertNodeStart( "revision" );
338  $this->skipWhitespace();
339 
340  $this->assertTextNode( "id", $id );
341  if ( $parentid !== false ) {
342  $this->assertTextNode( "parentid", $parentid );
343  }
344  $this->assertTextNode( "timestamp", false );
345 
346  $this->assertNodeStart( "contributor" );
347  $this->skipWhitespace();
348  $this->assertTextNode( "ip", false );
349  $this->assertNodeEnd( "contributor" );
350  $this->skipWhitespace();
351 
352  $this->assertTextNode( "comment", $summary );
353  $this->skipWhitespace();
354 
355  $this->assertTextNode( "model", $model );
356  $this->skipWhitespace();
357 
358  $this->assertTextNode( "format", $format );
359  $this->skipWhitespace();
360 
361  if ( $this->xml->name == "text" ) {
362  // note: <text> tag may occur here or at the very end.
363  $text_found = true;
364  $this->assertText( $id, $text_id, $text_bytes, $text );
365  } else {
366  $text_found = false;
367  }
368 
369  $this->assertTextNode( "sha1", $text_sha1 );
370 
371  if ( !$text_found ) {
372  $this->assertText( $id, $text_id, $text_bytes, $text );
373  }
374 
375  $this->assertNodeEnd( "revision" );
376  $this->skipWhitespace();
377  }
378 
379  protected function assertText( $id, $text_id, $text_bytes, $text ) {
380  $this->assertNodeStart( "text", false );
381  if ( $text_bytes !== false ) {
382  $this->assertEquals( $this->xml->getAttribute( "bytes" ), $text_bytes,
383  "Attribute 'bytes' of revision " . $id );
384  }
385 
386  if ( $text === false ) {
387  // Testing for a stub
388  $this->assertEquals( $this->xml->getAttribute( "id" ), $text_id,
389  "Text id of revision " . $id );
390  $this->assertFalse( $this->xml->hasValue, "Revision has text" );
391  $this->assertTrue( $this->xml->read(), "Skipping text start tag" );
392  if ( ( $this->xml->nodeType == XMLReader::END_ELEMENT )
393  && ( $this->xml->name == "text" )
394  ) {
395  $this->xml->read();
396  }
397  $this->skipWhitespace();
398  } else {
399  // Testing for a real dump
400  $this->assertTrue( $this->xml->read(), "Skipping text start tag" );
401  $this->assertEquals( $text, $this->xml->value, "Text of revision " . $id );
402  $this->assertTrue( $this->xml->read(), "Skipping past text" );
403  $this->assertNodeEnd( "text" );
404  $this->skipWhitespace();
405  }
406  }
407 }
Page
Interface for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
Definition: Page.php:24
DumpTestCase\$hasGzip
static bool null $hasGzip
Whether the 'gzip' utility is available.
Definition: DumpTestCase.php:29
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
DumpTestCase
Base TestCase for dumps.
Definition: DumpTestCase.php:6
DumpTestCase\assertPageEnd
assertPageEnd()
Asserts that the xml reader is at the page's closing element and skips to the next element.
Definition: DumpTestCase.php:313
captcha-old.count
count
Definition: captcha-old.py:249
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1245
$fname
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Definition: Setup.php:36
DumpTestCase\assertTextNode
assertTextNode( $name, $text, $skip_ws=true)
Asserts that the xml reader is at an element of given tag that contains a given text,...
Definition: DumpTestCase.php:274
DumpTestCase\assertText
assertText( $id, $text_id, $text_bytes, $text)
Definition: DumpTestCase.php:379
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
User
User
Definition: All_system_messages.txt:425
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:236
DumpTestCase\assertDumpEnd
assertDumpEnd( $name="mediawiki")
Asserts that the xml reader is at the final closing tag of an xml file and closes the reader.
Definition: DumpTestCase.php:210
DumpTestCase\setUp
setUp()
Default set up function.
Definition: DumpTestCase.php:106
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:35
Installer\locateExecutableInDefaultPaths
static locateExecutableInDefaultPaths( $names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
Definition: Installer.php:1265
DumpTestCase\addRevision
addRevision(Page $page, $text, $summary, $model=CONTENT_MODEL_WIKITEXT)
Adds a revision to a page, while returning the resuting revision's id.
Definition: DumpTestCase.php:59
MWException
MediaWiki exception.
Definition: MWException.php:26
DumpTestCase\assertNodeEnd
assertNodeEnd( $name, $skip=true)
Asserts that the xml reader is at an closing element of given name, and optionally skips past it.
Definition: DumpTestCase.php:255
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:672
DumpTestCase\assertPageStart
assertPageStart( $id, $ns, $name)
Asserts that the xml reader is at the start of a page element and skips over the first tags,...
Definition: DumpTestCase.php:300
DumpTestCase\assertNodeStart
assertNodeStart( $name, $skip=true)
Asserts that the xml reader is at an element of given name, and optionally skips past it.
Definition: DumpTestCase.php:239
$lines
$lines
Definition: router.php:67
DumpTestCase\expectETAOutput
expectETAOutput()
Checks for test output consisting only of lines containing ETA announcements.
Definition: DumpTestCase.php:121
CONTENT_FORMAT_WIKITEXT
const CONTENT_FORMAT_WIKITEXT
Definition: Defines.php:251
ContentHandler\makeContent
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Definition: ContentHandler.php:129
$line
$line
Definition: cdb.php:58
$value
$value
Definition: styleTest.css.php:45
MediaWikiLangTestCase
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:6
DumpTestCase\skipPastNodeEnd
skipPastNodeEnd( $name)
Step the current XML reader to the first element start after the node end of a given name.
Definition: DumpTestCase.php:174
DumpTestCase\checkHasGzip
checkHasGzip()
Skip the test if 'gzip' is not in $PATH.
Definition: DumpTestCase.php:36
DumpTestCase\assertDumpStart
assertDumpStart( $fname, $skip_siteinfo=true)
Opens an XML file to analyze and optionally skips past siteinfo.
Definition: DumpTestCase.php:193
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:9
DumpTestCase\gunzip
gunzip( $fname)
gunzips the given file and stores the result in the original file name
Definition: DumpTestCase.php:86
DumpTestCase\$xml
XMLReader null $xml
Holds the XMLReader used for analyzing an XML dump.
Definition: DumpTestCase.php:26
DumpTestCase\skipWhitespace
skipWhitespace()
Steps the xml reader over white space.
Definition: DumpTestCase.php:223
DumpTestCase\$exceptionFromAddDBData
Exception null $exceptionFromAddDBData
exception to be rethrown once in sound PHPUnit surrounding
Definition: DumpTestCase.php:19
DumpTestCase\assertRevision
assertRevision( $id, $summary, $text_id, $text_bytes, $text_sha1, $text=false, $parentid=false, $model=CONTENT_MODEL_WIKITEXT, $format=CONTENT_FORMAT_WIKITEXT)
Asserts that the xml reader is at a revision and checks its representation before skipping over it.
Definition: DumpTestCase.php:333
DumpTestCase\skipToNodeEnd
skipToNodeEnd( $name)
Step the current XML reader until node end of given name is found.
Definition: DumpTestCase.php:152