8 class FileBackendTest
extends MediaWikiTestCase
{
9 private $backend, $multiBackend;
10 private $filesToPrune = array();
11 private static $backendToUse;
14 global $wgFileBackends;
16 $tmpPrefix = wfTempDir() . '/filebackend-unittest-' . time() . '-' . mt_rand();
17 if ( $this->getCliArg( 'use-filebackend=' ) ) {
18 if ( self
::$backendToUse ) {
19 $this->singleBackend
= self
::$backendToUse;
21 $name = $this->getCliArg( 'use-filebackend=' );
23 foreach ( $wgFileBackends as $conf ) {
24 if ( $conf['name'] == $name ) {
29 $useConfig['name'] = 'localtesting'; // swap name
30 $useConfig['shardViaHashLevels'] = array( // test sharding
31 'unittest-cont1' => array( 'levels' => 1, 'base' => 16, 'repeat' => 1 )
33 $class = $useConfig['class'];
34 self
::$backendToUse = new $class( $useConfig );
35 $this->singleBackend
= self
::$backendToUse;
38 $this->singleBackend
= new FSFileBackend( array(
39 'name' => 'localtesting',
40 'lockManager' => 'fsLockManager',
41 #'parallelize' => 'implicit',
42 'containerPaths' => array(
43 'unittest-cont1' => "{$tmpPrefix}-localtesting-cont1",
44 'unittest-cont2' => "{$tmpPrefix}-localtesting-cont2" )
47 $this->multiBackend
= new FileBackendMultiWrite( array(
48 'name' => 'localtesting',
49 'lockManager' => 'fsLockManager',
50 'parallelize' => 'implicit',
53 'name' => 'localmutlitesting1',
54 'class' => 'FSFileBackend',
55 'lockManager' => 'nullLockManager',
56 'containerPaths' => array(
57 'unittest-cont1' => "{$tmpPrefix}-localtestingmulti1-cont1",
58 'unittest-cont2' => "{$tmpPrefix}-localtestingmulti1-cont2" ),
59 'isMultiMaster' => false
62 'name' => 'localmutlitesting2',
63 'class' => 'FSFileBackend',
64 'lockManager' => 'nullLockManager',
65 'containerPaths' => array(
66 'unittest-cont1' => "{$tmpPrefix}-localtestingmulti2-cont1",
67 'unittest-cont2' => "{$tmpPrefix}-localtestingmulti2-cont2" ),
68 'isMultiMaster' => true
72 $this->filesToPrune
= array();
75 private function baseStorePath() {
76 return 'mwstore://localtesting';
79 private function backendClass() {
80 return get_class( $this->backend
);
84 * @dataProvider provider_testIsStoragePath
86 public function testIsStoragePath( $path, $isStorePath ) {
87 $this->assertEquals( $isStorePath, FileBackend
::isStoragePath( $path ),
88 "FileBackend::isStoragePath on path '$path'" );
91 function provider_testIsStoragePath() {
93 array( 'mwstore://', true ),
94 array( 'mwstore://backend', true ),
95 array( 'mwstore://backend/container', true ),
96 array( 'mwstore://backend/container/', true ),
97 array( 'mwstore://backend/container/path', true ),
98 array( 'mwstore://backend//container/', true ),
99 array( 'mwstore://backend//container//', true ),
100 array( 'mwstore://backend//container//path', true ),
101 array( 'mwstore:///', true ),
102 array( 'mwstore:/', false ),
103 array( 'mwstore:', false ),
108 * @dataProvider provider_testSplitStoragePath
110 public function testSplitStoragePath( $path, $res ) {
111 $this->assertEquals( $res, FileBackend
::splitStoragePath( $path ),
112 "FileBackend::splitStoragePath on path '$path'" );
115 function provider_testSplitStoragePath() {
117 array( 'mwstore://backend/container', array( 'backend', 'container', '' ) ),
118 array( 'mwstore://backend/container/', array( 'backend', 'container', '' ) ),
119 array( 'mwstore://backend/container/path', array( 'backend', 'container', 'path' ) ),
120 array( 'mwstore://backend/container//path', array( 'backend', 'container', '/path' ) ),
121 array( 'mwstore://backend//container/path', array( null, null, null ) ),
122 array( 'mwstore://backend//container//path', array( null, null, null ) ),
123 array( 'mwstore://', array( null, null, null ) ),
124 array( 'mwstore://backend', array( null, null, null ) ),
125 array( 'mwstore:///', array( null, null, null ) ),
126 array( 'mwstore:/', array( null, null, null ) ),
127 array( 'mwstore:', array( null, null, null ) )
132 * @dataProvider provider_normalizeStoragePath
134 public function testNormalizeStoragePath( $path, $res ) {
135 $this->assertEquals( $res, FileBackend
::normalizeStoragePath( $path ),
136 "FileBackend::normalizeStoragePath on path '$path'" );
139 function provider_normalizeStoragePath() {
141 array( 'mwstore://backend/container', 'mwstore://backend/container' ),
142 array( 'mwstore://backend/container/', 'mwstore://backend/container' ),
143 array( 'mwstore://backend/container/path', 'mwstore://backend/container/path' ),
144 array( 'mwstore://backend/container//path', 'mwstore://backend/container/path' ),
145 array( 'mwstore://backend/container///path', 'mwstore://backend/container/path' ),
146 array( 'mwstore://backend/container///path//to///obj', 'mwstore://backend/container/path/to/obj',
147 array( 'mwstore://', null ),
148 array( 'mwstore://backend', null ),
149 array( 'mwstore://backend//container/path', null ),
150 array( 'mwstore://backend//container//path', null ),
151 array( 'mwstore:///', null ),
152 array( 'mwstore:/', null ),
153 array( 'mwstore:', null ), )
158 * @dataProvider provider_testParentStoragePath
160 public function testParentStoragePath( $path, $res ) {
161 $this->assertEquals( $res, FileBackend
::parentStoragePath( $path ),
162 "FileBackend::parentStoragePath on path '$path'" );
165 function provider_testParentStoragePath() {
167 array( 'mwstore://backend/container/path/to/obj', 'mwstore://backend/container/path/to' ),
168 array( 'mwstore://backend/container/path/to', 'mwstore://backend/container/path' ),
169 array( 'mwstore://backend/container/path', 'mwstore://backend/container' ),
170 array( 'mwstore://backend/container', null ),
171 array( 'mwstore://backend/container/path/to/obj/', 'mwstore://backend/container/path/to' ),
172 array( 'mwstore://backend/container/path/to/', 'mwstore://backend/container/path' ),
173 array( 'mwstore://backend/container/path/', 'mwstore://backend/container' ),
174 array( 'mwstore://backend/container/', null ),
179 * @dataProvider provider_testExtensionFromPath
181 public function testExtensionFromPath( $path, $res ) {
182 $this->assertEquals( $res, FileBackend
::extensionFromPath( $path ),
183 "FileBackend::extensionFromPath on path '$path'" );
186 function provider_testExtensionFromPath() {
188 array( 'mwstore://backend/container/path.txt', 'txt' ),
189 array( 'mwstore://backend/container/path.svg.png', 'png' ),
190 array( 'mwstore://backend/container/path', '' ),
191 array( 'mwstore://backend/container/path.', '' ),
196 * @dataProvider provider_testStore
198 public function testStore( $op ) {
199 $this->filesToPrune
[] = $op['src'];
201 $this->backend
= $this->singleBackend
;
202 $this->tearDownFiles();
203 $this->doTestStore( $op );
204 $this->tearDownFiles();
206 $this->backend
= $this->multiBackend
;
207 $this->tearDownFiles();
208 $this->doTestStore( $op );
209 $this->filesToPrune
[] = $op['src']; # avoid file leaking
210 $this->tearDownFiles();
213 private function doTestStore( $op ) {
214 $backendName = $this->backendClass();
216 $source = $op['src'];
218 $this->prepare( array( 'dir' => dirname( $dest ) ) );
220 file_put_contents( $source, "Unit test file" );
222 if ( isset( $op['overwrite'] ) ||
isset( $op['overwriteSame'] ) ) {
223 $this->backend
->store( $op );
226 $status = $this->backend
->doOperation( $op );
228 $this->assertGoodStatus( $status,
229 "Store from $source to $dest succeeded without warnings ($backendName)." );
230 $this->assertEquals( true, $status->isOK(),
231 "Store from $source to $dest succeeded ($backendName)." );
232 $this->assertEquals( array( 0 => true ), $status->success
,
233 "Store from $source to $dest has proper 'success' field in Status ($backendName)." );
234 $this->assertEquals( true, file_exists( $source ),
235 "Source file $source still exists ($backendName)." );
236 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $dest ) ),
237 "Destination file $dest exists ($backendName)." );
239 $this->assertEquals( filesize( $source ),
240 $this->backend
->getFileSize( array( 'src' => $dest ) ),
241 "Destination file $dest has correct size ($backendName)." );
243 $props1 = FSFile
::getPropsFromPath( $source );
244 $props2 = $this->backend
->getFileProps( array( 'src' => $dest ) );
245 $this->assertEquals( $props1, $props2,
246 "Source and destination have the same props ($backendName)." );
248 $this->assertBackendPathsConsistent( array( $dest ) );
251 public function provider_testStore() {
254 $tmpName = TempFSFile
::factory( "unittests_", 'txt' )->getPath();
255 $toPath = $this->baseStorePath() . '/unittest-cont1/e/fun/obj1.txt';
256 $op = array( 'op' => 'store', 'src' => $tmpName, 'dst' => $toPath );
264 $op2['overwrite'] = true;
272 $op2['overwriteSame'] = true;
283 * @dataProvider provider_testCopy
285 public function testCopy( $op ) {
286 $this->backend
= $this->singleBackend
;
287 $this->tearDownFiles();
288 $this->doTestCopy( $op );
289 $this->tearDownFiles();
291 $this->backend
= $this->multiBackend
;
292 $this->tearDownFiles();
293 $this->doTestCopy( $op );
294 $this->tearDownFiles();
297 private function doTestCopy( $op ) {
298 $backendName = $this->backendClass();
300 $source = $op['src'];
302 $this->prepare( array( 'dir' => dirname( $source ) ) );
303 $this->prepare( array( 'dir' => dirname( $dest ) ) );
305 $status = $this->backend
->doOperation(
306 array( 'op' => 'create', 'content' => 'blahblah', 'dst' => $source ) );
307 $this->assertGoodStatus( $status,
308 "Creation of file at $source succeeded ($backendName)." );
310 if ( isset( $op['overwrite'] ) ||
isset( $op['overwriteSame'] ) ) {
311 $this->backend
->copy( $op );
314 $status = $this->backend
->doOperation( $op );
316 $this->assertGoodStatus( $status,
317 "Copy from $source to $dest succeeded without warnings ($backendName)." );
318 $this->assertEquals( true, $status->isOK(),
319 "Copy from $source to $dest succeeded ($backendName)." );
320 $this->assertEquals( array( 0 => true ), $status->success
,
321 "Copy from $source to $dest has proper 'success' field in Status ($backendName)." );
322 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $source ) ),
323 "Source file $source still exists ($backendName)." );
324 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $dest ) ),
325 "Destination file $dest exists after copy ($backendName)." );
328 $this->backend
->getFileSize( array( 'src' => $source ) ),
329 $this->backend
->getFileSize( array( 'src' => $dest ) ),
330 "Destination file $dest has correct size ($backendName)." );
332 $props1 = $this->backend
->getFileProps( array( 'src' => $source ) );
333 $props2 = $this->backend
->getFileProps( array( 'src' => $dest ) );
334 $this->assertEquals( $props1, $props2,
335 "Source and destination have the same props ($backendName)." );
337 $this->assertBackendPathsConsistent( array( $source, $dest ) );
340 public function provider_testCopy() {
343 $source = $this->baseStorePath() . '/unittest-cont1/e/file.txt';
344 $dest = $this->baseStorePath() . '/unittest-cont2/a/fileMoved.txt';
346 $op = array( 'op' => 'copy', 'src' => $source, 'dst' => $dest );
354 $op2['overwrite'] = true;
362 $op2['overwriteSame'] = true;
373 * @dataProvider provider_testMove
375 public function testMove( $op ) {
376 $this->backend
= $this->singleBackend
;
377 $this->tearDownFiles();
378 $this->doTestMove( $op );
379 $this->tearDownFiles();
381 $this->backend
= $this->multiBackend
;
382 $this->tearDownFiles();
383 $this->doTestMove( $op );
384 $this->tearDownFiles();
387 private function doTestMove( $op ) {
388 $backendName = $this->backendClass();
390 $source = $op['src'];
392 $this->prepare( array( 'dir' => dirname( $source ) ) );
393 $this->prepare( array( 'dir' => dirname( $dest ) ) );
395 $status = $this->backend
->doOperation(
396 array( 'op' => 'create', 'content' => 'blahblah', 'dst' => $source ) );
397 $this->assertGoodStatus( $status,
398 "Creation of file at $source succeeded ($backendName)." );
400 if ( isset( $op['overwrite'] ) ||
isset( $op['overwriteSame'] ) ) {
401 $this->backend
->copy( $op );
404 $status = $this->backend
->doOperation( $op );
405 $this->assertGoodStatus( $status,
406 "Move from $source to $dest succeeded without warnings ($backendName)." );
407 $this->assertEquals( true, $status->isOK(),
408 "Move from $source to $dest succeeded ($backendName)." );
409 $this->assertEquals( array( 0 => true ), $status->success
,
410 "Move from $source to $dest has proper 'success' field in Status ($backendName)." );
411 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $source ) ),
412 "Source file $source does not still exists ($backendName)." );
413 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $dest ) ),
414 "Destination file $dest exists after move ($backendName)." );
416 $this->assertNotEquals(
417 $this->backend
->getFileSize( array( 'src' => $source ) ),
418 $this->backend
->getFileSize( array( 'src' => $dest ) ),
419 "Destination file $dest has correct size ($backendName)." );
421 $props1 = $this->backend
->getFileProps( array( 'src' => $source ) );
422 $props2 = $this->backend
->getFileProps( array( 'src' => $dest ) );
423 $this->assertEquals( false, $props1['fileExists'],
424 "Source file does not exist accourding to props ($backendName)." );
425 $this->assertEquals( true, $props2['fileExists'],
426 "Destination file exists accourding to props ($backendName)." );
428 $this->assertBackendPathsConsistent( array( $source, $dest ) );
431 public function provider_testMove() {
434 $source = $this->baseStorePath() . '/unittest-cont1/e/file.txt';
435 $dest = $this->baseStorePath() . '/unittest-cont2/a/fileMoved.txt';
437 $op = array( 'op' => 'move', 'src' => $source, 'dst' => $dest );
445 $op2['overwrite'] = true;
453 $op2['overwriteSame'] = true;
464 * @dataProvider provider_testDelete
466 public function testDelete( $op, $withSource, $okStatus ) {
467 $this->backend
= $this->singleBackend
;
468 $this->tearDownFiles();
469 $this->doTestDelete( $op, $withSource, $okStatus );
470 $this->tearDownFiles();
472 $this->backend
= $this->multiBackend
;
473 $this->tearDownFiles();
474 $this->doTestDelete( $op, $withSource, $okStatus );
475 $this->tearDownFiles();
478 private function doTestDelete( $op, $withSource, $okStatus ) {
479 $backendName = $this->backendClass();
481 $source = $op['src'];
482 $this->prepare( array( 'dir' => dirname( $source ) ) );
485 $status = $this->backend
->doOperation(
486 array( 'op' => 'create', 'content' => 'blahblah', 'dst' => $source ) );
487 $this->assertGoodStatus( $status,
488 "Creation of file at $source succeeded ($backendName)." );
491 $status = $this->backend
->doOperation( $op );
493 $this->assertGoodStatus( $status,
494 "Deletion of file at $source succeeded without warnings ($backendName)." );
495 $this->assertEquals( true, $status->isOK(),
496 "Deletion of file at $source succeeded ($backendName)." );
497 $this->assertEquals( array( 0 => true ), $status->success
,
498 "Deletion of file at $source has proper 'success' field in Status ($backendName)." );
500 $this->assertEquals( false, $status->isOK(),
501 "Deletion of file at $source failed ($backendName)." );
504 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $source ) ),
505 "Source file $source does not exist after move ($backendName)." );
508 $this->backend
->getFileSize( array( 'src' => $source ) ),
509 "Source file $source has correct size (false) ($backendName)." );
511 $props1 = $this->backend
->getFileProps( array( 'src' => $source ) );
512 $this->assertFalse( $props1['fileExists'],
513 "Source file $source does not exist according to props ($backendName)." );
515 $this->assertBackendPathsConsistent( array( $source ) );
518 public function provider_testDelete() {
521 $source = $this->baseStorePath() . '/unittest-cont1/e/myfacefile.txt';
523 $op = array( 'op' => 'delete', 'src' => $source );
532 false, // without source
536 $op['ignoreMissingSource'] = true;
539 false, // without source
547 * @dataProvider provider_testCreate
549 public function testCreate( $op, $alreadyExists, $okStatus, $newSize ) {
550 $this->backend
= $this->singleBackend
;
551 $this->tearDownFiles();
552 $this->doTestCreate( $op, $alreadyExists, $okStatus, $newSize );
553 $this->tearDownFiles();
555 $this->backend
= $this->multiBackend
;
556 $this->tearDownFiles();
557 $this->doTestCreate( $op, $alreadyExists, $okStatus, $newSize );
558 $this->tearDownFiles();
561 private function doTestCreate( $op, $alreadyExists, $okStatus, $newSize ) {
562 $backendName = $this->backendClass();
565 $this->prepare( array( 'dir' => dirname( $dest ) ) );
567 $oldText = 'blah...blah...waahwaah';
568 if ( $alreadyExists ) {
569 $status = $this->backend
->doOperation(
570 array( 'op' => 'create', 'content' => $oldText, 'dst' => $dest ) );
571 $this->assertGoodStatus( $status,
572 "Creation of file at $dest succeeded ($backendName)." );
575 $status = $this->backend
->doOperation( $op );
577 $this->assertGoodStatus( $status,
578 "Creation of file at $dest succeeded without warnings ($backendName)." );
579 $this->assertEquals( true, $status->isOK(),
580 "Creation of file at $dest succeeded ($backendName)." );
581 $this->assertEquals( array( 0 => true ), $status->success
,
582 "Creation of file at $dest has proper 'success' field in Status ($backendName)." );
584 $this->assertEquals( false, $status->isOK(),
585 "Creation of file at $dest failed ($backendName)." );
588 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $dest ) ),
589 "Destination file $dest exists after creation ($backendName)." );
591 $props1 = $this->backend
->getFileProps( array( 'src' => $dest ) );
592 $this->assertEquals( true, $props1['fileExists'],
593 "Destination file $dest exists according to props ($backendName)." );
594 if ( $okStatus ) { // file content is what we saved
595 $this->assertEquals( $newSize, $props1['size'],
596 "Destination file $dest has expected size according to props ($backendName)." );
597 $this->assertEquals( $newSize,
598 $this->backend
->getFileSize( array( 'src' => $dest ) ),
599 "Destination file $dest has correct size ($backendName)." );
600 } else { // file content is some other previous text
601 $this->assertEquals( strlen( $oldText ), $props1['size'],
602 "Destination file $dest has original size according to props ($backendName)." );
603 $this->assertEquals( strlen( $oldText ),
604 $this->backend
->getFileSize( array( 'src' => $dest ) ),
605 "Destination file $dest has original size according to props ($backendName)." );
608 $this->assertBackendPathsConsistent( array( $dest ) );
612 * @dataProvider provider_testCreate
614 public function provider_testCreate() {
617 $dest = $this->baseStorePath() . '/unittest-cont2/a/myspacefile.txt';
619 $op = array( 'op' => 'create', 'content' => 'test test testing', 'dst' => $dest );
622 false, // no dest already exists
624 strlen( $op['content'] )
628 $op2['content'] = "\n";
631 false, // no dest already exists
633 strlen( $op2['content'] )
637 $op2['content'] = "fsf\n waf 3kt";
640 true, // dest already exists
642 strlen( $op2['content'] )
646 $op2['content'] = "egm'g gkpe gpqg eqwgwqg";
647 $op2['overwrite'] = true;
650 true, // dest already exists
652 strlen( $op2['content'] )
656 $op2['content'] = "39qjmg3-qg";
657 $op2['overwriteSame'] = true;
660 true, // dest already exists
662 strlen( $op2['content'] )
668 public function testDoQuickOperations() {
669 $this->backend
= $this->singleBackend
;
670 $this->doTestDoQuickOperations();
671 $this->tearDownFiles();
673 $this->backend
= $this->multiBackend
;
674 $this->doTestDoQuickOperations();
675 $this->tearDownFiles();
678 private function doTestDoQuickOperations() {
679 $backendName = $this->backendClass();
681 $base = $this->baseStorePath();
683 "$base/unittest-cont1/e/fileA.a",
684 "$base/unittest-cont1/e/fileB.a",
685 "$base/unittest-cont1/e/fileC.a"
689 foreach ( $files as $path ) {
690 $status = $this->prepare( array( 'dir' => dirname( $path ) ) );
691 $this->assertGoodStatus( $status,
692 "Preparing $path succeeded without warnings ($backendName)." );
693 $ops[] = array( 'op' => 'create', 'dst' => $path, 'content' => mt_rand(0,50000) );
694 $purgeOps[] = array( 'op' => 'delete', 'src' => $path );
696 $purgeOps[] = array( 'op' => 'null' );
697 $status = $this->backend
->doQuickOperations( $ops );
698 $this->assertGoodStatus( $status,
699 "Creation of source files succeeded ($backendName)." );
701 foreach ( $files as $file ) {
702 $this->assertTrue( $this->backend
->fileExists( array( 'src' => $file ) ),
703 "File $file exists." );
706 $status = $this->backend
->doQuickOperations( $purgeOps );
707 $this->assertGoodStatus( $status,
708 "Quick deletion of source files succeeded ($backendName)." );
710 foreach ( $files as $file ) {
711 $this->assertFalse( $this->backend
->fileExists( array( 'src' => $file ) ),
712 "File $file purged." );
717 * @dataProvider provider_testConcatenate
719 public function testConcatenate( $op, $srcs, $srcsContent, $alreadyExists, $okStatus ) {
720 $this->filesToPrune
[] = $op['dst'];
722 $this->backend
= $this->singleBackend
;
723 $this->tearDownFiles();
724 $this->doTestConcatenate( $op, $srcs, $srcsContent, $alreadyExists, $okStatus );
725 $this->tearDownFiles();
727 $this->backend
= $this->multiBackend
;
728 $this->tearDownFiles();
729 $this->doTestConcatenate( $op, $srcs, $srcsContent, $alreadyExists, $okStatus );
730 $this->filesToPrune
[] = $op['dst']; # avoid file leaking
731 $this->tearDownFiles();
734 private function doTestConcatenate( $params, $srcs, $srcsContent, $alreadyExists, $okStatus ) {
735 $backendName = $this->backendClass();
740 foreach ( $srcs as $i => $source ) {
741 $this->prepare( array( 'dir' => dirname( $source ) ) );
743 'op' => 'create', // operation
744 'dst' => $source, // source
745 'content' => $srcsContent[$i]
747 $expContent .= $srcsContent[$i];
749 $status = $this->backend
->doOperations( $ops );
751 $this->assertGoodStatus( $status,
752 "Creation of source files succeeded ($backendName)." );
754 $dest = $params['dst'];
755 if ( $alreadyExists ) {
756 $ok = file_put_contents( $dest, 'blah...blah...waahwaah' ) !== false;
757 $this->assertEquals( true, $ok,
758 "Creation of file at $dest succeeded ($backendName)." );
760 $ok = file_put_contents( $dest, '' ) !== false;
761 $this->assertEquals( true, $ok,
762 "Creation of 0-byte file at $dest succeeded ($backendName)." );
765 // Combine the files into one
766 $status = $this->backend
->concatenate( $params );
768 $this->assertGoodStatus( $status,
769 "Creation of concat file at $dest succeeded without warnings ($backendName)." );
770 $this->assertEquals( true, $status->isOK(),
771 "Creation of concat file at $dest succeeded ($backendName)." );
773 $this->assertEquals( false, $status->isOK(),
774 "Creation of concat file at $dest failed ($backendName)." );
778 $this->assertEquals( true, is_file( $dest ),
779 "Dest concat file $dest exists after creation ($backendName)." );
781 $this->assertEquals( true, is_file( $dest ),
782 "Dest concat file $dest exists after failed creation ($backendName)." );
785 $contents = file_get_contents( $dest );
786 $this->assertNotEquals( false, $contents, "File at $dest exists ($backendName)." );
789 $this->assertEquals( $expContent, $contents,
790 "Concat file at $dest has correct contents ($backendName)." );
792 $this->assertNotEquals( $expContent, $contents,
793 "Concat file at $dest has correct contents ($backendName)." );
797 function provider_testConcatenate() {
800 $rand = mt_rand( 0, 2000000000 ) . time();
801 $dest = wfTempDir() . "/randomfile!$rand.txt";
803 $this->baseStorePath() . '/unittest-cont1/e/file1.txt',
804 $this->baseStorePath() . '/unittest-cont1/e/file2.txt',
805 $this->baseStorePath() . '/unittest-cont1/e/file3.txt',
806 $this->baseStorePath() . '/unittest-cont1/e/file4.txt',
807 $this->baseStorePath() . '/unittest-cont1/e/file5.txt',
808 $this->baseStorePath() . '/unittest-cont1/e/file6.txt',
809 $this->baseStorePath() . '/unittest-cont1/e/file7.txt',
810 $this->baseStorePath() . '/unittest-cont1/e/file8.txt',
811 $this->baseStorePath() . '/unittest-cont1/e/file9.txt',
812 $this->baseStorePath() . '/unittest-cont1/e/file10.txt'
826 $params = array( 'srcs' => $srcs, 'dst' => $dest );
829 $params, // operation
831 $content, // content for each source
832 false, // no dest already exists
837 $params, // operation
839 $content, // content for each source
840 true, // dest already exists
848 * @dataProvider provider_testGetFileStat
850 public function testGetFileStat( $path, $content, $alreadyExists ) {
851 $this->backend
= $this->singleBackend
;
852 $this->tearDownFiles();
853 $this->doTestGetFileStat( $path, $content, $alreadyExists );
854 $this->tearDownFiles();
856 $this->backend
= $this->multiBackend
;
857 $this->tearDownFiles();
858 $this->doTestGetFileStat( $path, $content, $alreadyExists );
859 $this->tearDownFiles();
862 private function doTestGetFileStat( $path, $content, $alreadyExists ) {
863 $backendName = $this->backendClass();
865 if ( $alreadyExists ) {
866 $this->prepare( array( 'dir' => dirname( $path ) ) );
867 $status = $this->create( array( 'dst' => $path, 'content' => $content ) );
868 $this->assertGoodStatus( $status,
869 "Creation of file at $path succeeded ($backendName)." );
871 $size = $this->backend
->getFileSize( array( 'src' => $path ) );
872 $time = $this->backend
->getFileTimestamp( array( 'src' => $path ) );
873 $stat = $this->backend
->getFileStat( array( 'src' => $path ) );
875 $this->assertEquals( strlen( $content ), $size,
876 "Correct file size of '$path'" );
877 $this->assertTrue( abs( time() - wfTimestamp( TS_UNIX
, $time ) ) < 10,
878 "Correct file timestamp of '$path'" );
880 $size = $stat['size'];
881 $time = $stat['mtime'];
882 $this->assertEquals( strlen( $content ), $size,
883 "Correct file size of '$path'" );
884 $this->assertTrue( abs( time() - wfTimestamp( TS_UNIX
, $time ) ) < 10,
885 "Correct file timestamp of '$path'" );
887 $this->backend
->clearCache( array( $path ) );
889 $size = $this->backend
->getFileSize( array( 'src' => $path ) );
891 $this->assertEquals( strlen( $content ), $size,
892 "Correct file size of '$path'" );
894 $this->backend
->preloadCache( array( $path ) );
896 $size = $this->backend
->getFileSize( array( 'src' => $path ) );
898 $this->assertEquals( strlen( $content ), $size,
899 "Correct file size of '$path'" );
901 $size = $this->backend
->getFileSize( array( 'src' => $path ) );
902 $time = $this->backend
->getFileTimestamp( array( 'src' => $path ) );
903 $stat = $this->backend
->getFileStat( array( 'src' => $path ) );
905 $this->assertFalse( $size, "Correct file size of '$path'" );
906 $this->assertFalse( $time, "Correct file timestamp of '$path'" );
907 $this->assertFalse( $stat, "Correct file stat of '$path'" );
911 function provider_testGetFileStat() {
914 $base = $this->baseStorePath();
915 $cases[] = array( "$base/unittest-cont1/e/b/z/some_file.txt", "some file contents", true );
916 $cases[] = array( "$base/unittest-cont1/e/b/some-other_file.txt", "", true );
917 $cases[] = array( "$base/unittest-cont1/e/b/some-diff_file.txt", null, false );
923 * @dataProvider provider_testGetFileContents
925 public function testGetFileContents( $source, $content ) {
926 $this->backend
= $this->singleBackend
;
927 $this->tearDownFiles();
928 $this->doTestGetFileContents( $source, $content );
929 $this->tearDownFiles();
931 $this->backend
= $this->multiBackend
;
932 $this->tearDownFiles();
933 $this->doTestGetFileContents( $source, $content );
934 $this->tearDownFiles();
937 private function doTestGetFileContents( $source, $content ) {
938 $backendName = $this->backendClass();
940 $this->prepare( array( 'dir' => dirname( $source ) ) );
942 $status = $this->backend
->doOperation(
943 array( 'op' => 'create', 'content' => $content, 'dst' => $source ) );
944 $this->assertGoodStatus( $status,
945 "Creation of file at $source succeeded ($backendName)." );
946 $this->assertEquals( true, $status->isOK(),
947 "Creation of file at $source succeeded with OK status ($backendName)." );
949 $newContents = $this->backend
->getFileContents( array( 'src' => $source, 'latest' => 1 ) );
950 $this->assertNotEquals( false, $newContents,
951 "Read of file at $source succeeded ($backendName)." );
953 $this->assertEquals( $content, $newContents,
954 "Contents read match data at $source ($backendName)." );
957 function provider_testGetFileContents() {
960 $base = $this->baseStorePath();
961 $cases[] = array( "$base/unittest-cont1/e/b/z/some_file.txt", "some file contents" );
962 $cases[] = array( "$base/unittest-cont1/e/b/some-other_file.txt", "more file contents" );
968 * @dataProvider provider_testGetLocalCopy
970 public function testGetLocalCopy( $source, $content ) {
971 $this->backend
= $this->singleBackend
;
972 $this->tearDownFiles();
973 $this->doTestGetLocalCopy( $source, $content );
974 $this->tearDownFiles();
976 $this->backend
= $this->multiBackend
;
977 $this->tearDownFiles();
978 $this->doTestGetLocalCopy( $source, $content );
979 $this->tearDownFiles();
982 private function doTestGetLocalCopy( $source, $content ) {
983 $backendName = $this->backendClass();
985 $srcs = (array)$source;
986 foreach ( $srcs as $src ) {
987 $this->prepare( array( 'dir' => dirname( $src ) ) );
988 $status = $this->backend
->doOperation(
989 array( 'op' => 'create', 'content' => $content, 'dst' => $src ) );
990 $this->assertGoodStatus( $status,
991 "Creation of file at $src succeeded ($backendName)." );
994 if ( is_array( $source ) ) {
995 $tmpFiles = $this->backend
->getLocalCopyMulti( array( 'srcs' => $source ) );
996 foreach ( $tmpFiles as $path => $tmpFile ) {
997 $this->assertNotNull( $tmpFile,
998 "Creation of local copy of $path succeeded ($backendName)." );
999 $contents = file_get_contents( $tmpFile->getPath() );
1000 $this->assertNotEquals( false, $contents, "Local copy of $path exists ($backendName)." );
1001 $this->assertEquals( $content, $contents, "Local copy of $path is correct ($backendName)." );
1003 $this->assertEquals( $source, array_keys( $tmpFiles ), "Local copies in right order ($backendName)." );
1005 $tmpFile = $this->backend
->getLocalCopy( array( 'src' => $source ) );
1006 $this->assertNotNull( $tmpFile,
1007 "Creation of local copy of $source succeeded ($backendName)." );
1008 $contents = file_get_contents( $tmpFile->getPath() );
1009 $this->assertNotEquals( false, $contents, "Local copy of $source exists ($backendName)." );
1010 $this->assertEquals( $content, $contents, "Local copy of $source is correct ($backendName)." );
1014 function provider_testGetLocalCopy() {
1017 $base = $this->baseStorePath();
1018 $cases[] = array( "$base/unittest-cont1/e/a/z/some_file.txt", "some file contents" );
1019 $cases[] = array( "$base/unittest-cont1/e/a/some-other_file.txt", "more file contents" );
1020 $cases[] = array( "$base/unittest-cont1/e/a/\$odd&.txt", "test file contents" );
1022 array( "$base/unittest-cont1/e/a/x.txt", "$base/unittest-cont1/e/a/y.txt",
1023 "$base/unittest-cont1/e/a/z.txt" ),
1024 "clone file contents" );
1030 * @dataProvider provider_testGetLocalReference
1032 public function testGetLocalReference( $source, $content ) {
1033 $this->backend
= $this->singleBackend
;
1034 $this->tearDownFiles();
1035 $this->doTestGetLocalReference( $source, $content );
1036 $this->tearDownFiles();
1038 $this->backend
= $this->multiBackend
;
1039 $this->tearDownFiles();
1040 $this->doTestGetLocalReference( $source, $content );
1041 $this->tearDownFiles();
1044 private function doTestGetLocalReference( $source, $content ) {
1045 $backendName = $this->backendClass();
1047 $srcs = (array)$source;
1048 foreach ( $srcs as $src ) {
1049 $this->prepare( array( 'dir' => dirname( $src ) ) );
1050 $status = $this->backend
->doOperation(
1051 array( 'op' => 'create', 'content' => $content, 'dst' => $src ) );
1052 $this->assertGoodStatus( $status,
1053 "Creation of file at $src succeeded ($backendName)." );
1056 if ( is_array( $source ) ) {
1057 $tmpFiles = $this->backend
->getLocalReferenceMulti( array( 'srcs' => $source ) );
1058 foreach ( $tmpFiles as $path => $tmpFile ) {
1059 $this->assertNotNull( $tmpFile,
1060 "Creation of local copy of $path succeeded ($backendName)." );
1061 $contents = file_get_contents( $tmpFile->getPath() );
1062 $this->assertNotEquals( false, $contents, "Local ref of $path exists ($backendName)." );
1063 $this->assertEquals( $content, $contents, "Local ref of $path is correct ($backendName)." );
1065 $this->assertEquals( $source, array_keys( $tmpFiles ), "Local refs in right order ($backendName)." );
1067 $tmpFile = $this->backend
->getLocalReference( array( 'src' => $source ) );
1068 $this->assertNotNull( $tmpFile,
1069 "Creation of local copy of $source succeeded ($backendName)." );
1070 $contents = file_get_contents( $tmpFile->getPath() );
1071 $this->assertNotEquals( false, $contents, "Local ref of $source exists ($backendName)." );
1072 $this->assertEquals( $content, $contents, "Local ref of $source is correct ($backendName)." );
1076 function provider_testGetLocalReference() {
1079 $base = $this->baseStorePath();
1080 $cases[] = array( "$base/unittest-cont1/e/a/z/some_file.txt", "some file contents" );
1081 $cases[] = array( "$base/unittest-cont1/e/a/some-other_file.txt", "more file contents" );
1082 $cases[] = array( "$base/unittest-cont1/e/a/\$odd&.txt", "test file contents" );
1084 array( "$base/unittest-cont1/e/a/x.txt", "$base/unittest-cont1/e/a/y.txt",
1085 "$base/unittest-cont1/e/a/z.txt" ),
1086 "clone file contents" );
1092 * @dataProvider provider_testPrepareAndClean
1094 public function testPrepareAndClean( $path, $isOK ) {
1095 $this->backend
= $this->singleBackend
;
1096 $this->doTestPrepareAndClean( $path, $isOK );
1097 $this->tearDownFiles();
1099 $this->backend
= $this->multiBackend
;
1100 $this->doTestPrepareAndClean( $path, $isOK );
1101 $this->tearDownFiles();
1104 function provider_testPrepareAndClean() {
1105 $base = $this->baseStorePath();
1107 array( "$base/unittest-cont1/e/a/z/some_file1.txt", true ),
1108 array( "$base/unittest-cont2/a/z/some_file2.txt", true ),
1109 # Specific to FS backend with no basePath field set
1110 #array( "$base/unittest-cont3/a/z/some_file3.txt", false ),
1114 private function doTestPrepareAndClean( $path, $isOK ) {
1115 $backendName = $this->backendClass();
1117 $status = $this->prepare( array( 'dir' => dirname( $path ) ) );
1119 $this->assertGoodStatus( $status,
1120 "Preparing dir $path succeeded without warnings ($backendName)." );
1121 $this->assertEquals( true, $status->isOK(),
1122 "Preparing dir $path succeeded ($backendName)." );
1124 $this->assertEquals( false, $status->isOK(),
1125 "Preparing dir $path failed ($backendName)." );
1128 $status = $this->backend
->clean( array( 'dir' => dirname( $path ) ) );
1130 $this->assertGoodStatus( $status,
1131 "Cleaning dir $path succeeded without warnings ($backendName)." );
1132 $this->assertEquals( true, $status->isOK(),
1133 "Cleaning dir $path succeeded ($backendName)." );
1135 $this->assertEquals( false, $status->isOK(),
1136 "Cleaning dir $path failed ($backendName)." );
1140 public function testRecursiveClean() {
1141 $this->backend
= $this->singleBackend
;
1142 $this->doTestRecursiveClean();
1143 $this->tearDownFiles();
1145 $this->backend
= $this->multiBackend
;
1146 $this->doTestRecursiveClean();
1147 $this->tearDownFiles();
1150 private function doTestRecursiveClean() {
1151 $backendName = $this->backendClass();
1153 $base = $this->baseStorePath();
1155 "$base/unittest-cont1/e/a",
1156 "$base/unittest-cont1/e/a/b",
1157 "$base/unittest-cont1/e/a/b/c",
1158 "$base/unittest-cont1/e/a/b/c/d0",
1159 "$base/unittest-cont1/e/a/b/c/d1",
1160 "$base/unittest-cont1/e/a/b/c/d2",
1161 "$base/unittest-cont1/e/a/b/c/d0/1",
1162 "$base/unittest-cont1/e/a/b/c/d0/2",
1163 "$base/unittest-cont1/e/a/b/c/d1/3",
1164 "$base/unittest-cont1/e/a/b/c/d1/4",
1165 "$base/unittest-cont1/e/a/b/c/d2/5",
1166 "$base/unittest-cont1/e/a/b/c/d2/6"
1168 foreach ( $dirs as $dir ) {
1169 $status = $this->prepare( array( 'dir' => $dir ) );
1170 $this->assertGoodStatus( $status,
1171 "Preparing dir $dir succeeded without warnings ($backendName)." );
1174 if ( $this->backend
instanceof FSFileBackend
) {
1175 foreach ( $dirs as $dir ) {
1176 $this->assertEquals( true, $this->backend
->directoryExists( array( 'dir' => $dir ) ),
1177 "Dir $dir exists ($backendName)." );
1181 $status = $this->backend
->clean(
1182 array( 'dir' => "$base/unittest-cont1", 'recursive' => 1 ) );
1183 $this->assertGoodStatus( $status,
1184 "Recursive cleaning of dir $dir succeeded without warnings ($backendName)." );
1186 foreach ( $dirs as $dir ) {
1187 $this->assertEquals( false, $this->backend
->directoryExists( array( 'dir' => $dir ) ),
1188 "Dir $dir no longer exists ($backendName)." );
1192 // @TODO: testSecure
1194 public function testDoOperations() {
1195 $this->backend
= $this->singleBackend
;
1196 $this->tearDownFiles();
1197 $this->doTestDoOperations();
1198 $this->tearDownFiles();
1200 $this->backend
= $this->multiBackend
;
1201 $this->tearDownFiles();
1202 $this->doTestDoOperations();
1203 $this->tearDownFiles();
1206 private function doTestDoOperations() {
1207 $base = $this->baseStorePath();
1209 $fileA = "$base/unittest-cont1/e/a/b/fileA.txt";
1210 $fileAContents = '3tqtmoeatmn4wg4qe-mg3qt3 tq';
1211 $fileB = "$base/unittest-cont1/e/a/b/fileB.txt";
1212 $fileBContents = 'g-jmq3gpqgt3qtg q3GT ';
1213 $fileC = "$base/unittest-cont1/e/a/b/fileC.txt";
1214 $fileCContents = 'eigna[ogmewt 3qt g3qg flew[ag';
1215 $fileD = "$base/unittest-cont1/e/a/b/fileD.txt";
1217 $this->prepare( array( 'dir' => dirname( $fileA ) ) );
1218 $this->create( array( 'dst' => $fileA, 'content' => $fileAContents ) );
1219 $this->prepare( array( 'dir' => dirname( $fileB ) ) );
1220 $this->create( array( 'dst' => $fileB, 'content' => $fileBContents ) );
1221 $this->prepare( array( 'dir' => dirname( $fileC ) ) );
1222 $this->create( array( 'dst' => $fileC, 'content' => $fileCContents ) );
1223 $this->prepare( array( 'dir' => dirname( $fileD ) ) );
1225 $status = $this->backend
->doOperations( array(
1226 array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC, 'overwrite' => 1 ),
1227 // Now: A:<A>, B:<B>, C:<A>, D:<empty> (file:<orginal contents>)
1228 array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileA, 'overwriteSame' => 1 ),
1229 // Now: A:<A>, B:<B>, C:<A>, D:<empty>
1230 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileD, 'overwrite' => 1 ),
1231 // Now: A:<A>, B:<B>, C:<empty>, D:<A>
1232 array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileC ),
1233 // Now: A:<A>, B:<empty>, C:<B>, D:<A>
1234 array( 'op' => 'move', 'src' => $fileD, 'dst' => $fileA, 'overwriteSame' => 1 ),
1235 // Now: A:<A>, B:<empty>, C:<B>, D:<empty>
1236 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileA, 'overwrite' => 1 ),
1237 // Now: A:<B>, B:<empty>, C:<empty>, D:<empty>
1238 array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC ),
1239 // Now: A:<B>, B:<empty>, C:<B>, D:<empty>
1240 array( 'op' => 'move', 'src' => $fileA, 'dst' => $fileC, 'overwriteSame' => 1 ),
1241 // Now: A:<empty>, B:<empty>, C:<B>, D:<empty>
1242 array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1244 array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1246 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1248 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1250 array( 'op' => 'null' ),
1254 $this->assertGoodStatus( $status, "Operation batch succeeded" );
1255 $this->assertEquals( true, $status->isOK(), "Operation batch succeeded" );
1256 $this->assertEquals( 13, count( $status->success
),
1257 "Operation batch has correct success array" );
1259 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileA ) ),
1260 "File does not exist at $fileA" );
1261 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileB ) ),
1262 "File does not exist at $fileB" );
1263 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileD ) ),
1264 "File does not exist at $fileD" );
1266 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $fileC ) ),
1267 "File exists at $fileC" );
1268 $this->assertEquals( $fileBContents,
1269 $this->backend
->getFileContents( array( 'src' => $fileC ) ),
1270 "Correct file contents of $fileC" );
1271 $this->assertEquals( strlen( $fileBContents ),
1272 $this->backend
->getFileSize( array( 'src' => $fileC ) ),
1273 "Correct file size of $fileC" );
1274 $this->assertEquals( wfBaseConvert( sha1( $fileBContents ), 16, 36, 31 ),
1275 $this->backend
->getFileSha1Base36( array( 'src' => $fileC ) ),
1276 "Correct file SHA-1 of $fileC" );
1279 public function testDoOperationsPipeline() {
1280 $this->backend
= $this->singleBackend
;
1281 $this->tearDownFiles();
1282 $this->doTestDoOperationsPipeline();
1283 $this->tearDownFiles();
1285 $this->backend
= $this->multiBackend
;
1286 $this->tearDownFiles();
1287 $this->doTestDoOperationsPipeline();
1288 $this->tearDownFiles();
1291 // concurrency orientated
1292 private function doTestDoOperationsPipeline() {
1293 $base = $this->baseStorePath();
1295 $fileAContents = '3tqtmoeatmn4wg4qe-mg3qt3 tq';
1296 $fileBContents = 'g-jmq3gpqgt3qtg q3GT ';
1297 $fileCContents = 'eigna[ogmewt 3qt g3qg flew[ag';
1299 $tmpNameA = TempFSFile
::factory( "unittests_", 'txt' )->getPath();
1300 file_put_contents( $tmpNameA, $fileAContents );
1301 $tmpNameB = TempFSFile
::factory( "unittests_", 'txt' )->getPath();
1302 file_put_contents( $tmpNameB, $fileBContents );
1303 $tmpNameC = TempFSFile
::factory( "unittests_", 'txt' )->getPath();
1304 file_put_contents( $tmpNameC, $fileCContents );
1306 $this->filesToPrune
[] = $tmpNameA; # avoid file leaking
1307 $this->filesToPrune
[] = $tmpNameB; # avoid file leaking
1308 $this->filesToPrune
[] = $tmpNameC; # avoid file leaking
1310 $fileA = "$base/unittest-cont1/e/a/b/fileA.txt";
1311 $fileB = "$base/unittest-cont1/e/a/b/fileB.txt";
1312 $fileC = "$base/unittest-cont1/e/a/b/fileC.txt";
1313 $fileD = "$base/unittest-cont1/e/a/b/fileD.txt";
1315 $this->prepare( array( 'dir' => dirname( $fileA ) ) );
1316 $this->create( array( 'dst' => $fileA, 'content' => $fileAContents ) );
1317 $this->prepare( array( 'dir' => dirname( $fileB ) ) );
1318 $this->prepare( array( 'dir' => dirname( $fileC ) ) );
1319 $this->prepare( array( 'dir' => dirname( $fileD ) ) );
1321 $status = $this->backend
->doOperations( array(
1322 array( 'op' => 'store', 'src' => $tmpNameA, 'dst' => $fileA, 'overwriteSame' => 1 ),
1323 array( 'op' => 'store', 'src' => $tmpNameB, 'dst' => $fileB, 'overwrite' => 1 ),
1324 array( 'op' => 'store', 'src' => $tmpNameC, 'dst' => $fileC, 'overwrite' => 1 ),
1325 array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC, 'overwrite' => 1 ),
1326 // Now: A:<A>, B:<B>, C:<A>, D:<empty> (file:<orginal contents>)
1327 array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileA, 'overwriteSame' => 1 ),
1328 // Now: A:<A>, B:<B>, C:<A>, D:<empty>
1329 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileD, 'overwrite' => 1 ),
1330 // Now: A:<A>, B:<B>, C:<empty>, D:<A>
1331 array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileC ),
1332 // Now: A:<A>, B:<empty>, C:<B>, D:<A>
1333 array( 'op' => 'move', 'src' => $fileD, 'dst' => $fileA, 'overwriteSame' => 1 ),
1334 // Now: A:<A>, B:<empty>, C:<B>, D:<empty>
1335 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileA, 'overwrite' => 1 ),
1336 // Now: A:<B>, B:<empty>, C:<empty>, D:<empty>
1337 array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC ),
1338 // Now: A:<B>, B:<empty>, C:<B>, D:<empty>
1339 array( 'op' => 'move', 'src' => $fileA, 'dst' => $fileC, 'overwriteSame' => 1 ),
1340 // Now: A:<empty>, B:<empty>, C:<B>, D:<empty>
1341 array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1343 array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1345 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1347 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1349 array( 'op' => 'null' ),
1353 $this->assertGoodStatus( $status, "Operation batch succeeded" );
1354 $this->assertEquals( true, $status->isOK(), "Operation batch succeeded" );
1355 $this->assertEquals( 16, count( $status->success
),
1356 "Operation batch has correct success array" );
1358 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileA ) ),
1359 "File does not exist at $fileA" );
1360 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileB ) ),
1361 "File does not exist at $fileB" );
1362 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileD ) ),
1363 "File does not exist at $fileD" );
1365 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $fileC ) ),
1366 "File exists at $fileC" );
1367 $this->assertEquals( $fileBContents,
1368 $this->backend
->getFileContents( array( 'src' => $fileC ) ),
1369 "Correct file contents of $fileC" );
1370 $this->assertEquals( strlen( $fileBContents ),
1371 $this->backend
->getFileSize( array( 'src' => $fileC ) ),
1372 "Correct file size of $fileC" );
1373 $this->assertEquals( wfBaseConvert( sha1( $fileBContents ), 16, 36, 31 ),
1374 $this->backend
->getFileSha1Base36( array( 'src' => $fileC ) ),
1375 "Correct file SHA-1 of $fileC" );
1378 public function testDoOperationsFailing() {
1379 $this->backend
= $this->singleBackend
;
1380 $this->tearDownFiles();
1381 $this->doTestDoOperationsFailing();
1382 $this->tearDownFiles();
1384 $this->backend
= $this->multiBackend
;
1385 $this->tearDownFiles();
1386 $this->doTestDoOperationsFailing();
1387 $this->tearDownFiles();
1390 private function doTestDoOperationsFailing() {
1391 $base = $this->baseStorePath();
1393 $fileA = "$base/unittest-cont2/a/b/fileA.txt";
1394 $fileAContents = '3tqtmoeatmn4wg4qe-mg3qt3 tq';
1395 $fileB = "$base/unittest-cont2/a/b/fileB.txt";
1396 $fileBContents = 'g-jmq3gpqgt3qtg q3GT ';
1397 $fileC = "$base/unittest-cont2/a/b/fileC.txt";
1398 $fileCContents = 'eigna[ogmewt 3qt g3qg flew[ag';
1399 $fileD = "$base/unittest-cont2/a/b/fileD.txt";
1401 $this->prepare( array( 'dir' => dirname( $fileA ) ) );
1402 $this->create( array( 'dst' => $fileA, 'content' => $fileAContents ) );
1403 $this->prepare( array( 'dir' => dirname( $fileB ) ) );
1404 $this->create( array( 'dst' => $fileB, 'content' => $fileBContents ) );
1405 $this->prepare( array( 'dir' => dirname( $fileC ) ) );
1406 $this->create( array( 'dst' => $fileC, 'content' => $fileCContents ) );
1408 $status = $this->backend
->doOperations( array(
1409 array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC, 'overwrite' => 1 ),
1410 // Now: A:<A>, B:<B>, C:<A>, D:<empty> (file:<orginal contents>)
1411 array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileA, 'overwriteSame' => 1 ),
1412 // Now: A:<A>, B:<B>, C:<A>, D:<empty>
1413 array( 'op' => 'copy', 'src' => $fileB, 'dst' => $fileD, 'overwrite' => 1 ),
1414 // Now: A:<A>, B:<B>, C:<A>, D:<B>
1415 array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileD ),
1416 // Now: A:<A>, B:<B>, C:<A>, D:<empty> (failed)
1417 array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileC, 'overwriteSame' => 1 ),
1418 // Now: A:<A>, B:<B>, C:<A>, D:<empty> (failed)
1419 array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileA, 'overwrite' => 1 ),
1420 // Now: A:<B>, B:<empty>, C:<A>, D:<empty>
1421 array( 'op' => 'delete', 'src' => $fileD ),
1422 // Now: A:<B>, B:<empty>, C:<A>, D:<empty>
1423 array( 'op' => 'null' ),
1425 ), array( 'force' => 1 ) );
1427 $this->assertNotEquals( array(), $status->errors
, "Operation had warnings" );
1428 $this->assertEquals( true, $status->isOK(), "Operation batch succeeded" );
1429 $this->assertEquals( 8, count( $status->success
),
1430 "Operation batch has correct success array" );
1432 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileB ) ),
1433 "File does not exist at $fileB" );
1434 $this->assertEquals( false, $this->backend
->fileExists( array( 'src' => $fileD ) ),
1435 "File does not exist at $fileD" );
1437 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $fileA ) ),
1438 "File does not exist at $fileA" );
1439 $this->assertEquals( true, $this->backend
->fileExists( array( 'src' => $fileC ) ),
1440 "File exists at $fileC" );
1441 $this->assertEquals( $fileBContents,
1442 $this->backend
->getFileContents( array( 'src' => $fileA ) ),
1443 "Correct file contents of $fileA" );
1444 $this->assertEquals( strlen( $fileBContents ),
1445 $this->backend
->getFileSize( array( 'src' => $fileA ) ),
1446 "Correct file size of $fileA" );
1447 $this->assertEquals( wfBaseConvert( sha1( $fileBContents ), 16, 36, 31 ),
1448 $this->backend
->getFileSha1Base36( array( 'src' => $fileA ) ),
1449 "Correct file SHA-1 of $fileA" );
1452 public function testGetFileList() {
1453 $this->backend
= $this->singleBackend
;
1454 $this->tearDownFiles();
1455 $this->doTestGetFileList();
1456 $this->tearDownFiles();
1458 $this->backend
= $this->multiBackend
;
1459 $this->tearDownFiles();
1460 $this->doTestGetFileList();
1461 $this->tearDownFiles();
1464 private function doTestGetFileList() {
1465 $backendName = $this->backendClass();
1466 $base = $this->baseStorePath();
1468 // Should have no errors
1469 $iter = $this->backend
->getFileList( array( 'dir' => "$base/unittest-cont-notexists" ) );
1472 "$base/unittest-cont1/e/test1.txt",
1473 "$base/unittest-cont1/e/test2.txt",
1474 "$base/unittest-cont1/e/test3.txt",
1475 "$base/unittest-cont1/e/subdir1/test1.txt",
1476 "$base/unittest-cont1/e/subdir1/test2.txt",
1477 "$base/unittest-cont1/e/subdir2/test3.txt",
1478 "$base/unittest-cont1/e/subdir2/test4.txt",
1479 "$base/unittest-cont1/e/subdir2/subdir/test1.txt",
1480 "$base/unittest-cont1/e/subdir2/subdir/test2.txt",
1481 "$base/unittest-cont1/e/subdir2/subdir/test3.txt",
1482 "$base/unittest-cont1/e/subdir2/subdir/test4.txt",
1483 "$base/unittest-cont1/e/subdir2/subdir/test5.txt",
1484 "$base/unittest-cont1/e/subdir2/subdir/sub/test0.txt",
1485 "$base/unittest-cont1/e/subdir2/subdir/sub/120-px-file.txt",
1490 foreach ( $files as $file ) {
1491 $this->prepare( array( 'dir' => dirname( $file ) ) );
1492 $ops[] = array( 'op' => 'create', 'content' => 'xxy', 'dst' => $file );
1494 $status = $this->backend
->doQuickOperations( $ops );
1495 $this->assertGoodStatus( $status,
1496 "Creation of files succeeded ($backendName)." );
1497 $this->assertEquals( true, $status->isOK(),
1498 "Creation of files succeeded with OK status ($backendName)." );
1505 "e/subdir1/test1.txt",
1506 "e/subdir1/test2.txt",
1507 "e/subdir2/test3.txt",
1508 "e/subdir2/test4.txt",
1509 "e/subdir2/subdir/test1.txt",
1510 "e/subdir2/subdir/test2.txt",
1511 "e/subdir2/subdir/test3.txt",
1512 "e/subdir2/subdir/test4.txt",
1513 "e/subdir2/subdir/test5.txt",
1514 "e/subdir2/subdir/sub/test0.txt",
1515 "e/subdir2/subdir/sub/120-px-file.txt",
1519 // Actual listing (no trailing slash)
1521 $iter = $this->backend
->getFileList( array( 'dir' => "$base/unittest-cont1" ) );
1522 foreach ( $iter as $file ) {
1527 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1529 // Actual listing (with trailing slash)
1531 $iter = $this->backend
->getFileList( array( 'dir' => "$base/unittest-cont1/" ) );
1532 foreach ( $iter as $file ) {
1537 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1547 "sub/120-px-file.txt",
1551 // Actual listing (no trailing slash)
1553 $iter = $this->backend
->getFileList( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir" ) );
1554 foreach ( $iter as $file ) {
1559 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1561 // Actual listing (with trailing slash)
1563 $iter = $this->backend
->getFileList( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir/" ) );
1564 foreach ( $iter as $file ) {
1569 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1571 // Actual listing (using iterator second time)
1573 foreach ( $iter as $file ) {
1578 $this->assertEquals( $expected, $list, "Correct file listing ($backendName), second iteration." );
1580 // Expected listing (top files only)
1590 // Actual listing (top files only)
1592 $iter = $this->backend
->getTopFileList( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir" ) );
1593 foreach ( $iter as $file ) {
1598 $this->assertEquals( $expected, $list, "Correct top file listing ($backendName)." );
1600 foreach ( $files as $file ) { // clean up
1601 $this->backend
->doOperation( array( 'op' => 'delete', 'src' => $file ) );
1604 $iter = $this->backend
->getFileList( array( 'dir' => "$base/unittest-cont1/not/exists" ) );
1605 foreach ( $iter as $iter ) {} // no errors
1608 public function testGetDirectoryList() {
1609 $this->backend
= $this->singleBackend
;
1610 $this->tearDownFiles();
1611 $this->doTestGetDirectoryList();
1612 $this->tearDownFiles();
1614 $this->backend
= $this->multiBackend
;
1615 $this->tearDownFiles();
1616 $this->doTestGetDirectoryList();
1617 $this->tearDownFiles();
1620 private function doTestGetDirectoryList() {
1621 $backendName = $this->backendClass();
1623 $base = $this->baseStorePath();
1625 "$base/unittest-cont1/e/test1.txt",
1626 "$base/unittest-cont1/e/test2.txt",
1627 "$base/unittest-cont1/e/test3.txt",
1628 "$base/unittest-cont1/e/subdir1/test1.txt",
1629 "$base/unittest-cont1/e/subdir1/test2.txt",
1630 "$base/unittest-cont1/e/subdir2/test3.txt",
1631 "$base/unittest-cont1/e/subdir2/test4.txt",
1632 "$base/unittest-cont1/e/subdir2/subdir/test1.txt",
1633 "$base/unittest-cont1/e/subdir3/subdir/test2.txt",
1634 "$base/unittest-cont1/e/subdir4/subdir/test3.txt",
1635 "$base/unittest-cont1/e/subdir4/subdir/test4.txt",
1636 "$base/unittest-cont1/e/subdir4/subdir/test5.txt",
1637 "$base/unittest-cont1/e/subdir4/subdir/sub/test0.txt",
1638 "$base/unittest-cont1/e/subdir4/subdir/sub/120-px-file.txt",
1643 foreach ( $files as $file ) {
1644 $this->prepare( array( 'dir' => dirname( $file ) ) );
1645 $ops[] = array( 'op' => 'create', 'content' => 'xxy', 'dst' => $file );
1647 $status = $this->backend
->doQuickOperations( $ops );
1648 $this->assertGoodStatus( $status,
1649 "Creation of files succeeded ($backendName)." );
1650 $this->assertEquals( true, $status->isOK(),
1651 "Creation of files succeeded with OK status ($backendName)." );
1653 $this->assertEquals( true,
1654 $this->backend
->directoryExists( array( 'dir' => "$base/unittest-cont1/e/subdir1" ) ),
1655 "Directory exists in ($backendName)." );
1656 $this->assertEquals( true,
1657 $this->backend
->directoryExists( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir" ) ),
1658 "Directory exists in ($backendName)." );
1659 $this->assertEquals( false,
1660 $this->backend
->directoryExists( array( 'dir' => "$base/unittest-cont1/e/subdir2/test1.txt" ) ),
1661 "Directory does not exists in ($backendName)." );
1669 // Actual listing (no trailing slash)
1671 $iter = $this->backend
->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1" ) );
1672 foreach ( $iter as $file ) {
1677 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1688 // Actual listing (no trailing slash)
1690 $iter = $this->backend
->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e" ) );
1691 foreach ( $iter as $file ) {
1696 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1698 // Actual listing (with trailing slash)
1700 $iter = $this->backend
->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e/" ) );
1701 foreach ( $iter as $file ) {
1706 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1714 // Actual listing (no trailing slash)
1716 $iter = $this->backend
->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e/subdir2" ) );
1717 foreach ( $iter as $file ) {
1722 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1724 // Actual listing (with trailing slash)
1726 $iter = $this->backend
->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e/subdir2/" ) );
1727 foreach ( $iter as $file ) {
1732 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1734 // Actual listing (using iterator second time)
1736 foreach ( $iter as $file ) {
1741 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName), second iteration." );
1743 // Expected listing (recursive)
1753 "e/subdir4/subdir/sub",
1757 // Actual listing (recursive)
1759 $iter = $this->backend
->getDirectoryList( array( 'dir' => "$base/unittest-cont1/" ) );
1760 foreach ( $iter as $file ) {
1765 $this->assertEquals( $expected, $list, "Correct dir listing ($backendName)." );
1767 // Expected listing (recursive)
1774 // Actual listing (recursive)
1776 $iter = $this->backend
->getDirectoryList( array( 'dir' => "$base/unittest-cont1/e/subdir4" ) );
1777 foreach ( $iter as $file ) {
1782 $this->assertEquals( $expected, $list, "Correct dir listing ($backendName)." );
1784 // Actual listing (recursive, second time)
1786 foreach ( $iter as $file ) {
1791 $this->assertEquals( $expected, $list, "Correct dir listing ($backendName)." );
1793 foreach ( $files as $file ) { // clean up
1794 $this->backend
->doOperation( array( 'op' => 'delete', 'src' => $file ) );
1797 $iter = $this->backend
->getDirectoryList( array( 'dir' => "$base/unittest-cont1/not/exists" ) );
1798 foreach ( $iter as $iter ) {} // no errors
1801 public function testLockCalls() {
1802 $this->backend
= $this->singleBackend
;
1803 $this->doTestLockCalls();
1806 private function doTestLockCalls() {
1807 $backendName = $this->backendClass();
1809 for ( $i=0; $i<50; $i++
) {
1815 "subdir1", // duplicate
1816 "subdir1/test1.txt",
1817 "subdir1/test2.txt",
1819 "subdir2", // duplicate
1820 "subdir2/test3.txt",
1821 "subdir2/test4.txt",
1823 "subdir2/subdir/test1.txt",
1824 "subdir2/subdir/test2.txt",
1825 "subdir2/subdir/test3.txt",
1826 "subdir2/subdir/test4.txt",
1827 "subdir2/subdir/test5.txt",
1828 "subdir2/subdir/sub",
1829 "subdir2/subdir/sub/test0.txt",
1830 "subdir2/subdir/sub/120-px-file.txt",
1833 $status = $this->backend
->lockFiles( $paths, LockManager
::LOCK_EX
);
1834 $this->assertEquals( array(), $status->errors
,
1835 "Locking of files succeeded ($backendName)." );
1836 $this->assertEquals( true, $status->isOK(),
1837 "Locking of files succeeded with OK status ($backendName)." );
1839 $status = $this->backend
->lockFiles( $paths, LockManager
::LOCK_SH
);
1840 $this->assertEquals( array(), $status->errors
,
1841 "Locking of files succeeded ($backendName)." );
1842 $this->assertEquals( true, $status->isOK(),
1843 "Locking of files succeeded with OK status ($backendName)." );
1845 $status = $this->backend
->unlockFiles( $paths, LockManager
::LOCK_SH
);
1846 $this->assertEquals( array(), $status->errors
,
1847 "Locking of files succeeded ($backendName)." );
1848 $this->assertEquals( true, $status->isOK(),
1849 "Locking of files succeeded with OK status ($backendName)." );
1851 $status = $this->backend
->unlockFiles( $paths, LockManager
::LOCK_EX
);
1852 $this->assertEquals( array(), $status->errors
,
1853 "Locking of files succeeded ($backendName)." );
1854 $this->assertEquals( true, $status->isOK(),
1855 "Locking of files succeeded with OK status ($backendName)." );
1859 // test helper wrapper for backend prepare() function
1860 private function prepare( array $params ) {
1861 return $this->backend
->prepare( $params );
1864 // test helper wrapper for backend prepare() function
1865 private function create( array $params ) {
1866 $params['op'] = 'create';
1867 return $this->backend
->doQuickOperations( array( $params ) );
1870 function tearDownFiles() {
1871 foreach ( $this->filesToPrune
as $file ) {
1874 $containers = array( 'unittest-cont1', 'unittest-cont2', 'unittest-cont3' );
1875 foreach ( $containers as $container ) {
1876 $this->deleteFiles( $container );
1878 $this->filesToPrune
= array();
1881 private function deleteFiles( $container ) {
1882 $base = $this->baseStorePath();
1883 $iter = $this->backend
->getFileList( array( 'dir' => "$base/$container" ) );
1885 foreach ( $iter as $file ) {
1886 $this->backend
->delete( array( 'src' => "$base/$container/$file" ),
1887 array( 'force' => 1, 'nonLocking' => 1 ) );
1890 $this->backend
->clean( array( 'dir' => "$base/$container", 'recursive' => 1 ) );
1893 function assertBackendPathsConsistent( array $paths ) {
1894 if ( $this->backend
instanceof FileBackendMultiWrite
) {
1895 $status = $this->backend
->consistencyCheck( $paths );
1896 $this->assertGoodStatus( $status, "Files synced: " . implode( ',', $paths ) );
1900 function assertGoodStatus( $status, $msg ) {
1901 $this->assertEquals( print_r( array(), 1 ), print_r( $status->errors
, 1 ), $msg );
1904 function tearDown() {