MediaWiki  1.30.0
backupPrefetchTest.php
Go to the documentation of this file.
1 <?php
2 
3 require_once __DIR__ . "/../../../maintenance/backupPrefetch.inc";
4 
12 
18  private $dump = null;
19 
20  protected function tearDown() {
21  if ( $this->dump !== null ) {
22  $this->dump->close();
23  }
24 
25  // T39458, parent teardown need to be done after closing the
26  // dump or it might cause some permissions errors.
27  parent::tearDown();
28  }
29 
37  private function assertPrefetchEquals( $expected, $page, $revision ) {
38  $this->assertEquals( $expected, $this->dump->prefetch( $page, $revision ),
39  "Prefetch of page $page revision $revision" );
40  }
41 
42  function testSequential() {
43  $fname = $this->setUpPrefetch();
44  $this->dump = new BaseDump( $fname );
45 
46  $this->assertPrefetchEquals( "BackupDumperTestP1Text1", 1, 1 );
47  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
48  $this->assertPrefetchEquals( "BackupDumperTestP2Text4 some additional Text", 2, 5 );
49  $this->assertPrefetchEquals( "Talk about BackupDumperTestP1 Text1", 4, 8 );
50  }
51 
53  $fname = $this->setUpPrefetch();
54  $this->dump = new BaseDump( $fname );
55 
56  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
57  $this->assertPrefetchEquals( null, 2, 3 );
58  $this->assertPrefetchEquals( "BackupDumperTestP2Text4 some additional Text", 2, 5 );
59  }
60 
62  $fname = $this->setUpPrefetch();
63  $this->dump = new BaseDump( $fname );
64 
65  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
66  $this->assertPrefetchEquals( null, 2, 40 );
67  $this->assertPrefetchEquals( "Talk about BackupDumperTestP1 Text1", 4, 8 );
68  }
69 
71  $fname = $this->setUpPrefetch();
72  $this->dump = new BaseDump( $fname );
73 
74  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
75  $this->assertPrefetchEquals( null, 3, 40 );
76  $this->assertPrefetchEquals( "Talk about BackupDumperTestP1 Text1", 4, 8 );
77  }
78 
79  function testPageMissAtEnd() {
80  $fname = $this->setUpPrefetch();
81  $this->dump = new BaseDump( $fname );
82 
83  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
84  $this->assertPrefetchEquals( null, 6, 40 );
85  }
86 
87  function testRevisionMissAtEnd() {
88  $fname = $this->setUpPrefetch();
89  $this->dump = new BaseDump( $fname );
90 
91  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
92  $this->assertPrefetchEquals( null, 4, 40 );
93  }
94 
96  $fname = $this->setUpPrefetch();
97  $this->dump = new BaseDump( $fname );
98 
99  $this->assertPrefetchEquals( null, 0, 2 );
100  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
101  }
102 
104  $fname = $this->setUpPrefetch();
105  $this->dump = new BaseDump( $fname );
106 
107  $this->assertPrefetchEquals( null, 1, -2 );
108  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
109  }
110 
112  $fname1 = $this->setUpPrefetch( [ 1 ] );
113  $fname2 = $this->setUpPrefetch( [ 2, 4 ] );
114  $this->dump = new BaseDump( $fname1 . ";" . $fname2 );
115 
116  $this->assertPrefetchEquals( "BackupDumperTestP1Text1", 1, 1 );
117  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
118  $this->assertPrefetchEquals( "BackupDumperTestP2Text4 some additional Text", 2, 5 );
119  $this->assertPrefetchEquals( "Talk about BackupDumperTestP1 Text1", 4, 8 );
120  }
121 
123  $fname1 = $this->setUpPrefetch( [ 1 ] );
124  $fname2 = $this->setUpPrefetch( [ 2 ] );
125  $fname3 = $this->setUpPrefetch( [ 4 ] );
126  $this->dump = new BaseDump( $fname1 . ";" . $fname2 . ";" . $fname3 );
127 
128  $this->assertPrefetchEquals( "BackupDumperTestP1Text1", 1, 1 );
129  $this->assertPrefetchEquals( "Talk about BackupDumperTestP1 Text1", 4, 8 );
130  }
131 
133  $fname1 = $this->setUpPrefetch( [ 1 ] );
134  $fname2 = $this->setUpPrefetch( [ 2 ] );
135  $this->dump = new BaseDump( $fname1 . ";" . $fname2 );
136 
137  $this->assertPrefetchEquals( "BackupDumperTestP2Text1", 2, 2 );
138  }
139 
149  private function setUpPrefetch( $requested_pages = [ 1, 2, 4 ] ) {
150  // The file name, where we store the prepared prefetch file
151  $fname = $this->getNewTempFile();
152 
153  // The header of every prefetch file
154  // @codingStandardsIgnoreStart Ignore Generic.Files.LineLength.TooLong
155  $header = '<mediawiki xmlns="http://www.mediawiki.org/xml/export-0.7/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mediawiki.org/xml/export-0.7/ http://www.mediawiki.org/xml/export-0.7.xsd" version="0.7" xml:lang="en">
156  <siteinfo>
157  <sitename>wikisvn</sitename>
158  <base>http://localhost/wiki-svn/index.php/Main_Page</base>
159  <generator>MediaWiki 1.21alpha</generator>
160  <case>first-letter</case>
161  <namespaces>
162  <namespace key="-2" case="first-letter">Media</namespace>
163  <namespace key="-1" case="first-letter">Special</namespace>
164  <namespace key="0" case="first-letter" />
165  <namespace key="1" case="first-letter">Talk</namespace>
166  <namespace key="2" case="first-letter">User</namespace>
167  <namespace key="3" case="first-letter">User talk</namespace>
168  <namespace key="4" case="first-letter">Wikisvn</namespace>
169  <namespace key="5" case="first-letter">Wikisvn talk</namespace>
170  <namespace key="6" case="first-letter">File</namespace>
171  <namespace key="7" case="first-letter">File talk</namespace>
172  <namespace key="8" case="first-letter">MediaWiki</namespace>
173  <namespace key="9" case="first-letter">MediaWiki talk</namespace>
174  <namespace key="10" case="first-letter">Template</namespace>
175  <namespace key="11" case="first-letter">Template talk</namespace>
176  <namespace key="12" case="first-letter">Help</namespace>
177  <namespace key="13" case="first-letter">Help talk</namespace>
178  <namespace key="14" case="first-letter">Category</namespace>
179  <namespace key="15" case="first-letter">Category talk</namespace>
180  </namespaces>
181  </siteinfo>
182 ';
183  // @codingStandardsIgnoreEnd
184 
185  // An array holding the pages that are available for prefetch
186  $available_pages = [];
187 
188  // Simple plain page
189  $available_pages[1] = ' <page>
190  <title>BackupDumperTestP1</title>
191  <ns>0</ns>
192  <id>1</id>
193  <revision>
194  <id>1</id>
195  <timestamp>2012-04-01T16:46:05Z</timestamp>
196  <contributor>
197  <ip>127.0.0.1</ip>
198  </contributor>
199  <comment>BackupDumperTestP1Summary1</comment>
200  <sha1>0bolhl6ol7i6x0e7yq91gxgaan39j87</sha1>
201  <text xml:space="preserve">BackupDumperTestP1Text1</text>
202  <model name="wikitext">1</model>
203  <format mime="text/x-wiki">1</format>
204  </revision>
205  </page>
206 ';
207  // Page with more than one revisions. Hole in rev ids.
208  $available_pages[2] = ' <page>
209  <title>BackupDumperTestP2</title>
210  <ns>0</ns>
211  <id>2</id>
212  <revision>
213  <id>2</id>
214  <timestamp>2012-04-01T16:46:05Z</timestamp>
215  <contributor>
216  <ip>127.0.0.1</ip>
217  </contributor>
218  <comment>BackupDumperTestP2Summary1</comment>
219  <sha1>jprywrymfhysqllua29tj3sc7z39dl2</sha1>
220  <text xml:space="preserve">BackupDumperTestP2Text1</text>
221  <model name="wikitext">1</model>
222  <format mime="text/x-wiki">1</format>
223  </revision>
224  <revision>
225  <id>5</id>
226  <parentid>2</parentid>
227  <timestamp>2012-04-01T16:46:05Z</timestamp>
228  <contributor>
229  <ip>127.0.0.1</ip>
230  </contributor>
231  <comment>BackupDumperTestP2Summary4 extra</comment>
232  <sha1>6o1ciaxa6pybnqprmungwofc4lv00wv</sha1>
233  <text xml:space="preserve">BackupDumperTestP2Text4 some additional Text</text>
234  <model name="wikitext">1</model>
235  <format mime="text/x-wiki">1</format>
236  </revision>
237  </page>
238 ';
239  // Page with id higher than previous id + 1
240  $available_pages[4] = ' <page>
241  <title>Talk:BackupDumperTestP1</title>
242  <ns>1</ns>
243  <id>4</id>
244  <revision>
245  <id>8</id>
246  <timestamp>2012-04-01T16:46:05Z</timestamp>
247  <contributor>
248  <ip>127.0.0.1</ip>
249  </contributor>
250  <comment>Talk BackupDumperTestP1 Summary1</comment>
251  <sha1>nktofwzd0tl192k3zfepmlzxoax1lpe</sha1>
252  <model name="wikitext">1</model>
253  <format mime="text/x-wiki">1</format>
254  <text xml:space="preserve">Talk about BackupDumperTestP1 Text1</text>
255  </revision>
256  </page>
257 ';
258 
259  // The common ending for all files
260  $tail = '</mediawiki>
261 ';
262 
263  // Putting together the content of the prefetch files
264  $content = $header;
265  foreach ( $requested_pages as $i ) {
266  $this->assertTrue( array_key_exists( $i, $available_pages ),
267  "Check for availability of requested page " . $i );
268  $content .= $available_pages[$i];
269  }
270  $content .= $tail;
271 
272  $this->assertEquals( strlen( $content ), file_put_contents(
273  $fname, $content ), "Length of prepared prefetch" );
274 
275  return $fname;
276  }
277 }
BaseDumpTest\testSynchronizePageMiss
testSynchronizePageMiss()
Definition: backupPrefetchTest.php:70
BaseDumpTest\testRevisionMissAtEnd
testRevisionMissAtEnd()
Definition: backupPrefetchTest.php:87
BaseDump
Readahead helper for making large MediaWiki data dumps; reads in a previous XML dump to sequentially ...
Definition: backupPrefetch.inc:42
BaseDumpTest\testSynchronizePageMissAtStart
testSynchronizePageMissAtStart()
Definition: backupPrefetchTest.php:95
BaseDumpTest\testSequentialAcrossFiles
testSequentialAcrossFiles()
Definition: backupPrefetchTest.php:111
$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
BaseDumpTest\testSynchronizeSkipAcrossFile
testSynchronizeSkipAcrossFile()
Definition: backupPrefetchTest.php:122
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
BaseDumpTest\$dump
BaseDump $dump
The BaseDump instance used within a test.
Definition: backupPrefetchTest.php:18
BaseDumpTest\tearDown
tearDown()
Definition: backupPrefetchTest.php:20
MediaWikiTestCase\getNewTempFile
getNewTempFile()
Obtains a new temporary file name.
Definition: MediaWikiTestCase.php:457
MediaWikiTestCase
Definition: MediaWikiTestCase.php:15
BaseDumpTest\testSynchronizeMissInWholeFirstFile
testSynchronizeMissInWholeFirstFile()
Definition: backupPrefetchTest.php:132
BaseDumpTest\testSynchronizeRevisionMissToRevision
testSynchronizeRevisionMissToRevision()
Definition: backupPrefetchTest.php:52
$header
$header
Definition: updateCredits.php:35
BaseDumpTest
Tests for BaseDump.
Definition: backupPrefetchTest.php:11
BaseDumpTest\testSynchronizeRevisionMissToPage
testSynchronizeRevisionMissToPage()
Definition: backupPrefetchTest.php:61
BaseDumpTest\assertPrefetchEquals
assertPrefetchEquals( $expected, $page, $revision)
asserts that a prefetch yields an expected string
Definition: backupPrefetchTest.php:37
BaseDumpTest\testSequential
testSequential()
Definition: backupPrefetchTest.php:42
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
BaseDumpTest\testSynchronizeRevisionMissAtStart
testSynchronizeRevisionMissAtStart()
Definition: backupPrefetchTest.php:103
BaseDumpTest\testPageMissAtEnd
testPageMissAtEnd()
Definition: backupPrefetchTest.php:79
BaseDumpTest\setUpPrefetch
setUpPrefetch( $requested_pages=[1, 2, 4])
Constructs a temporary file that can be used for prefetching.
Definition: backupPrefetchTest.php:149