MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
8 use Page;
9 use User;
10 use XMLReader;
16 abstract class DumpTestCase extends MediaWikiLangTestCase {
29  protected $exceptionFromAddDBData = null;
36  protected $xml = null;
39  protected static $hasGzip = null;
46  protected function checkHasGzip() {
47  if ( self::$hasGzip === null ) {
48  self::$hasGzip = ( ExecutableFinder::findInDefaultPaths( 'gzip' ) !== false );
49  }
51  if ( !self::$hasGzip ) {
52  $this->markTestSkipped( "Skip test, requires the gzip utility in PATH" );
53  }
55  return self::$hasGzip;
56  }
69  protected function addRevision( Page $page, $text, $summary, $model = CONTENT_MODEL_WIKITEXT ) {
70  $status = $page->doEditContent(
71  ContentHandler::makeContent( $text, $page->getTitle(), $model ),
72  $summary
73  );
75  if ( $status->isGood() ) {
76  $value = $status->getValue();
77  $revision = $value['revision'];
78  $revision_id = $revision->getId();
79  $text_id = $revision->getTextId();
81  if ( ( $revision_id > 0 ) && ( $text_id > 0 ) ) {
82  return [ $revision_id, $text_id ];
83  }
84  }
86  throw new MWException( "Could not determine revision id ("
87  . $status->getWikiText( false, false, 'en' ) . ")" );
88  }
96  protected function gunzip( $fname ) {
97  $gzipped_contents = file_get_contents( $fname );
98  if ( $gzipped_contents === false ) {
99  $this->fail( "Could not get contents of $fname" );
100  }
102  $contents = gzdecode( $gzipped_contents );
104  $this->assertEquals(
105  strlen( $contents ),
106  file_put_contents( $fname, $contents ),
107  '# bytes written'
108  );
109  }
116  protected function setUp() {
117  parent::setUp();
119  // Check if any Exception is stored for rethrowing from addDBData
120  // @see self::exceptionFromAddDBData
121  if ( $this->exceptionFromAddDBData !== null ) {
123  }
125  $this->setMwGlobals( 'wgUser', new User() );
126  }
131  function expectETAOutput() {
132  // Newer PHPUnits require assertion about the output using PHPUnit's own
133  // expectOutput[...] functions. However, the PHPUnit shipped prediactes
134  // do not allow to check /each/ line of the output using /readable/ REs.
135  // So we ...
137  // 1. ... add a dummy output checking to make PHPUnit not complain
138  // about unchecked test output
139  $this->expectOutputRegex( '//' );
141  // 2. Do the real output checking on our own.
142  $lines = explode( "\n", $this->getActualOutput() );
143  $this->assertGreaterThan( 1, count( $lines ), "Minimal lines of produced output" );
144  $this->assertEquals( '', array_pop( $lines ), "Output ends in LF" );
145  $timestamp_re = "[0-9]{4}-[01][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-6][0-9]";
146  foreach ( $lines as $line ) {
147  $this->assertRegExp(
148  "/$timestamp_re: .* \‍(ID [0-9]+\‍) [0-9]* pages .*, [0-9]* revs .*, ETA/",
149  $line
150  );
151  }
152  }
162  protected function skipToNodeEnd( $name ) {
163  while ( $this->xml->read() ) {
164  if ( $this->xml->nodeType == XMLReader::END_ELEMENT &&
165  $this->xml->name == $name
166  ) {
167  return true;
168  }
169  }
171  return false;
172  }
184  protected function skipPastNodeEnd( $name ) {
185  $this->assertTrue( $this->skipToNodeEnd( $name ),
186  "Skipping to end of $name" );
187  while ( $this->xml->read() ) {
188  if ( $this->xml->nodeType == XMLReader::ELEMENT ) {
189  return true;
190  }
191  }
193  return false;
194  }
203  protected function assertDumpStart( $fname, $skip_siteinfo = true ) {
204  $this->xml = new XMLReader();
205  $this->assertTrue( $this->xml->open( $fname ),
206  "Opening temporary file $fname via XMLReader failed" );
207  if ( $skip_siteinfo ) {
208  $this->assertTrue( $this->skipPastNodeEnd( "siteinfo" ),
209  "Skipping past end of siteinfo" );
210  }
211  }
220  protected function assertDumpEnd( $name = "mediawiki" ) {
221  $this->assertNodeEnd( $name, false );
222  if ( $this->xml->read() ) {
223  $this->skipWhitespace();
224  }
225  $this->assertEquals( $this->xml->nodeType, XMLReader::NONE,
226  "No proper entity left to parse" );
227  $this->xml->close();
228  }
233  protected function skipWhitespace() {
234  $cont = true;
235  while ( $cont && ( ( $this->xml->nodeType == XMLReader::WHITESPACE )
236  || ( $this->xml->nodeType == XMLReader::SIGNIFICANT_WHITESPACE ) ) ) {
237  $cont = $this->xml->read();
238  }
239  }
249  protected function assertNodeStart( $name, $skip = true ) {
250  $this->assertEquals( $name, $this->xml->name, "Node name" );
251  $this->assertEquals( XMLReader::ELEMENT, $this->xml->nodeType, "Node type" );
252  if ( $skip ) {
253  $this->assertTrue( $this->xml->read(), "Skipping past start tag" );
254  }
255  }
265  protected function assertNodeEnd( $name, $skip = true ) {
266  $this->assertEquals( $name, $this->xml->name, "Node name" );
267  $this->assertEquals( XMLReader::END_ELEMENT, $this->xml->nodeType, "Node type" );
268  if ( $skip ) {
269  $this->assertTrue( $this->xml->read(), "Skipping past end tag" );
270  }
271  }
284  protected function assertTextNode( $name, $text, $skip_ws = true ) {
285  $this->assertNodeStart( $name );
287  if ( $text !== false ) {
288  $this->assertEquals( $text, $this->xml->value, "Text of node " . $name );
289  }
290  $this->assertTrue( $this->xml->read(), "Skipping past processed text of " . $name );
291  $this->assertNodeEnd( $name );
293  if ( $skip_ws ) {
294  $this->skipWhitespace();
295  }
296  }
310  protected function assertPageStart( $id, $ns, $name ) {
311  $this->assertNodeStart( "page" );
312  $this->skipWhitespace();
314  $this->assertTextNode( "title", $name );
315  $this->assertTextNode( "ns", $ns );
316  $this->assertTextNode( "id", $id );
317  }
323  protected function assertPageEnd() {
324  $this->assertNodeEnd( "page" );
325  $this->skipWhitespace();
326  }
343  protected function assertRevision( $id, $summary, $text_id, $text_bytes,
344  $text_sha1, $text = false, $parentid = false,
346  ) {
347  $this->assertNodeStart( "revision" );
348  $this->skipWhitespace();
350  $this->assertTextNode( "id", $id );
351  if ( $parentid !== false ) {
352  $this->assertTextNode( "parentid", $parentid );
353  }
354  $this->assertTextNode( "timestamp", false );
356  $this->assertNodeStart( "contributor" );
357  $this->skipWhitespace();
358  $this->assertTextNode( "ip", false );
359  $this->assertNodeEnd( "contributor" );
360  $this->skipWhitespace();
362  $this->assertTextNode( "comment", $summary );
363  $this->skipWhitespace();
365  $this->assertTextNode( "model", $model );
366  $this->skipWhitespace();
368  $this->assertTextNode( "format", $format );
369  $this->skipWhitespace();
371  if ( $this->xml->name == "text" ) {
372  // note: <text> tag may occur here or at the very end.
373  $text_found = true;
374  $this->assertText( $id, $text_id, $text_bytes, $text );
375  } else {
376  $text_found = false;
377  }
379  $this->assertTextNode( "sha1", $text_sha1 );
381  if ( !$text_found ) {
382  $this->assertText( $id, $text_id, $text_bytes, $text );
383  }
385  $this->assertNodeEnd( "revision" );
386  $this->skipWhitespace();
387  }
389  protected function assertText( $id, $text_id, $text_bytes, $text ) {
390  $this->assertNodeStart( "text", false );
391  if ( $text_bytes !== false ) {
392  $this->assertEquals( $this->xml->getAttribute( "bytes" ), $text_bytes,
393  "Attribute 'bytes' of revision " . $id );
394  }
396  if ( $text === false ) {
397  // Testing for a stub
398  $this->assertEquals( $this->xml->getAttribute( "id" ), $text_id,
399  "Text id of revision " . $id );
400  $this->assertFalse( $this->xml->hasValue, "Revision has text" );
401  $this->assertTrue( $this->xml->read(), "Skipping text start tag" );
402  if ( ( $this->xml->nodeType == XMLReader::END_ELEMENT )
403  && ( $this->xml->name == "text" )
404  ) {
405  $this->xml->read();
406  }
407  $this->skipWhitespace();
408  } else {
409  // Testing for a real dump
410  $this->assertTrue( $this->xml->read(), "Skipping text start tag" );
411  $this->assertEquals( $text, $this->xml->value, "Text of revision " . $id );
412  $this->assertTrue( $this->xml->read(), "Skipping past text" );
413  $this->assertNodeEnd( "text" );
414  $this->skipWhitespace();
415  }
416  }
417 }
A content handler knows how do deal with a specific type of content on a wiki page.
Definition: ContentHandler.php:49
Interface for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
Definition: Page.php:24
assertDumpStart( $fname, $skip_siteinfo=true)
Opens an XML file to analyze and optionally skips past siteinfo.
Definition: DumpTestCase.php:203
Skip the test if 'gzip' is not in $PATH.
Definition: DumpTestCase.php:46
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
static bool null $hasGzip
Whether the 'gzip' utility is available.
Definition: DumpTestCase.php:39
skipToNodeEnd( $name)
Step the current XML reader until node end of given name is found.
Definition: DumpTestCase.php:162
Steps the xml reader over white space.
Definition: DumpTestCase.php:233
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:265
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:220
Exception null $exceptionFromAddDBData
exception to be rethrown once in sound PHPUnit surrounding
Definition: DumpTestCase.php:29
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:69
Asserts that the xml reader is at the page's closing element and skips to the next element.
Definition: DumpTestCase.php:323
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:310
Definition: All_system_messages.txt:425
Definition: Defines.php:245
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
Definition: backup_LogTest.php:3
Default set up function.
Definition: DumpTestCase.php:116
MediaWiki exception.
Definition: MWException.php:26
assertNodeStart( $name, $skip=true)
Asserts that the xml reader is at an element of given name, and optionally skips past it.
Definition: DumpTestCase.php:249
assertText( $id, $text_id, $text_bytes, $text)
Definition: DumpTestCase.php:389
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:678
Utility class to find executables in likely places.
Definition: ExecutableFinder.php:28
Definition: router.php:61
Definition: Defines.php:260
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
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition: Setup.php:112
Definition: cdb.php:59
Definition: styleTest.css.php:45
gunzip( $fname)
gunzips the given file and stores the result in the original file name
Definition: DumpTestCase.php:96
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:6
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). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. '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:1255
XMLReader null $xml
Holds the XMLReader used for analyzing an XML dump.
Definition: DumpTestCase.php:36
Checks for test output consisting only of lines containing ETA announcements.
Definition: DumpTestCase.php:131
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Base TestCase for dumps.
Definition: DumpTestCase.php:16
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
skipPastNodeEnd( $name)
Step the current XML reader to the first element start after the node end of a given name.
Definition: DumpTestCase.php:184
static findInDefaultPaths( $names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
Definition: ExecutableFinder.php:96
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:284
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:343
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187