MediaWiki  1.29.1
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 
302  $this->assertNodeStart( "page" );
303  $this->skipWhitespace();
304 
305  $this->assertTextNode( "title", $name );
306  $this->assertTextNode( "ns", $ns );
307  $this->assertTextNode( "id", $id );
308  }
309 
314  protected function assertPageEnd() {
315  $this->assertNodeEnd( "page" );
316  $this->skipWhitespace();
317  }
318 
334  protected function assertRevision( $id, $summary, $text_id, $text_bytes,
335  $text_sha1, $text = false, $parentid = false,
337  ) {
338  $this->assertNodeStart( "revision" );
339  $this->skipWhitespace();
340 
341  $this->assertTextNode( "id", $id );
342  if ( $parentid !== false ) {
343  $this->assertTextNode( "parentid", $parentid );
344  }
345  $this->assertTextNode( "timestamp", false );
346 
347  $this->assertNodeStart( "contributor" );
348  $this->skipWhitespace();
349  $this->assertTextNode( "ip", false );
350  $this->assertNodeEnd( "contributor" );
351  $this->skipWhitespace();
352 
353  $this->assertTextNode( "comment", $summary );
354  $this->skipWhitespace();
355 
356  $this->assertTextNode( "model", $model );
357  $this->skipWhitespace();
358 
359  $this->assertTextNode( "format", $format );
360  $this->skipWhitespace();
361 
362  if ( $this->xml->name == "text" ) {
363  // note: <text> tag may occur here or at the very end.
364  $text_found = true;
365  $this->assertText( $id, $text_id, $text_bytes, $text );
366  } else {
367  $text_found = false;
368  }
369 
370  $this->assertTextNode( "sha1", $text_sha1 );
371 
372  if ( !$text_found ) {
373  $this->assertText( $id, $text_id, $text_bytes, $text );
374  }
375 
376  $this->assertNodeEnd( "revision" );
377  $this->skipWhitespace();
378  }
379 
380  protected function assertText( $id, $text_id, $text_bytes, $text ) {
381  $this->assertNodeStart( "text", false );
382  if ( $text_bytes !== false ) {
383  $this->assertEquals( $this->xml->getAttribute( "bytes" ), $text_bytes,
384  "Attribute 'bytes' of revision " . $id );
385  }
386 
387  if ( $text === false ) {
388  // Testing for a stub
389  $this->assertEquals( $this->xml->getAttribute( "id" ), $text_id,
390  "Text id of revision " . $id );
391  $this->assertFalse( $this->xml->hasValue, "Revision has text" );
392  $this->assertTrue( $this->xml->read(), "Skipping text start tag" );
393  if ( ( $this->xml->nodeType == XMLReader::END_ELEMENT )
394  && ( $this->xml->name == "text" )
395  ) {
396 
397  $this->xml->read();
398  }
399  $this->skipWhitespace();
400  } else {
401  // Testing for a real dump
402  $this->assertTrue( $this->xml->read(), "Skipping text start tag" );
403  $this->assertEquals( $text, $this->xml->value, "Text of revision " . $id );
404  $this->assertTrue( $this->xml->read(), "Skipping past text" );
405  $this->assertNodeEnd( "text" );
406  $this->skipWhitespace();
407  }
408  }
409 }
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:189
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:314
captcha-old.count
count
Definition: captcha-old.py:225
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
$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:380
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
User
User
Definition: All_system_messages.txt:425
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:233
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:1238
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)
Definition: MediaWikiTestCase.php:658
$page
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2536
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:248
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:334
DumpTestCase\skipToNodeEnd
skipToNodeEnd( $name)
Step the current XML reader until node end of given name is found.
Definition: DumpTestCase.php:152