tests/phpunit/includes/filerepo/FileBackendTest.php

   1 <?php
   2
   3 /**
   4  * @group FileRepo
   5  * @group FileBackend
   6  * @group medium
   7  */
   8 class FileBackendTest extends MediaWikiTestCase {
   9         private $backend, $multiBackend;
  10         private $filesToPrune = array();
  11         private static $backendToUse;
  12
  13         function setUp() {
  14                 global $wgFileBackends;
  15                 parent::setUp();
  16                 $tmpPrefix = wfTempDir() . '/filebackend-unittest-' . time() . '-' . mt_rand();
  17                 if ( $this->getCliArg( 'use-filebackend=' ) ) {
  18                         if ( self::$backendToUse ) {
  19                                 $this->singleBackend = self::$backendToUse;
  20                         } else {
  21                                 $name = $this->getCliArg( 'use-filebackend=' );
  22                                 $useConfig = array();
  23                                 foreach ( $wgFileBackends as $conf ) {
  24                                         if ( $conf['name'] == $name ) {
  25                                                 $useConfig = $conf;
  26                                                 break;
  27                                         }
  28                                 }
  29                                 $useConfig['name'] = 'localtesting'; // swap name
  30                                 $useConfig['shardViaHashLevels'] = array( // test sharding
  31                                         'unittest-cont1' => array( 'levels' => 1, 'base' => 16, 'repeat' => 1 )
  32                                 );
  33                                 $class = $useConfig['class'];
  34                                 self::$backendToUse = new $class( $useConfig );
  35                                 $this->singleBackend = self::$backendToUse;
  36                         }
  37                 } else {
  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" )
  45                         ) );
  46                 }
  47                 $this->multiBackend = new FileBackendMultiWrite( array(
  48                         'name'        => 'localtesting',
  49                         'lockManager' => 'fsLockManager',
  50                         'parallelize' => 'implicit',
  51                         'backends'    => array(
  52                                 array(
  53                                         'name'          => 'localmultitesting1',
  54                                         'class'         => 'FSFileBackend',
  55                                         'lockManager'   => 'nullLockManager',
  56                                         'containerPaths' => array(
  57                                                 'unittest-cont1' => "{$tmpPrefix}-localtestingmulti1-cont1",
  58                                                 'unittest-cont2' => "{$tmpPrefix}-localtestingmulti1-cont2" ),
  59                                         'isMultiMaster' => false
  60                                 ),
  61                                 array(
  62                                         'name'          => 'localmultitesting2',
  63                                         'class'         => 'FSFileBackend',
  64                                         'lockManager'   => 'nullLockManager',
  65                                         'containerPaths' => array(
  66                                                 'unittest-cont1' => "{$tmpPrefix}-localtestingmulti2-cont1",
  67                                                 'unittest-cont2' => "{$tmpPrefix}-localtestingmulti2-cont2" ),
  68                                         'isMultiMaster' => true
  69                                 )
  70                         )
  71                 ) );
  72                 $this->filesToPrune = array();
  73         }
  74
  75         private function baseStorePath() {
  76                 return 'mwstore://localtesting';
  77         }
  78
  79         private function backendClass() {
  80                 return get_class( $this->backend );
  81         }
  82
  83         /**
  84          * @dataProvider provider_testIsStoragePath
  85          */
  86         public function testIsStoragePath( $path, $isStorePath ) {
  87                 $this->assertEquals( $isStorePath, FileBackend::isStoragePath( $path ),
  88                         "FileBackend::isStoragePath on path '$path'" );
  89         }
  90
  91         function provider_testIsStoragePath() {
  92                 return array(
  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 ),
 104                 );
 105         }
 106
 107         /**
 108          * @dataProvider provider_testSplitStoragePath
 109          */
 110         public function testSplitStoragePath( $path, $res ) {
 111                 $this->assertEquals( $res, FileBackend::splitStoragePath( $path ),
 112                         "FileBackend::splitStoragePath on path '$path'" );
 113         }
 114
 115         function provider_testSplitStoragePath() {
 116                 return array(
 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 ) )
 128                 );
 129         }
 130
 131         /**
 132          * @dataProvider provider_normalizeStoragePath
 133          */
 134         public function testNormalizeStoragePath( $path, $res ) {
 135                 $this->assertEquals( $res, FileBackend::normalizeStoragePath( $path ),
 136                         "FileBackend::normalizeStoragePath on path '$path'" );
 137         }
 138
 139         function provider_normalizeStoragePath() {
 140                 return array(
 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 ), )
 154                 );
 155         }
 156
 157         /**
 158          * @dataProvider provider_testParentStoragePath
 159          */
 160         public function testParentStoragePath( $path, $res ) {
 161                 $this->assertEquals( $res, FileBackend::parentStoragePath( $path ),
 162                         "FileBackend::parentStoragePath on path '$path'" );
 163         }
 164
 165         function provider_testParentStoragePath() {
 166                 return array(
 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 ),
 175                 );
 176         }
 177
 178         /**
 179          * @dataProvider provider_testExtensionFromPath
 180          */
 181         public function testExtensionFromPath( $path, $res ) {
 182                 $this->assertEquals( $res, FileBackend::extensionFromPath( $path ),
 183                         "FileBackend::extensionFromPath on path '$path'" );
 184         }
 185
 186         function provider_testExtensionFromPath() {
 187                 return array(
 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.', '' ),
 192                 );
 193         }
 194
 195         /**
 196          * @dataProvider provider_testStore
 197          */
 198         public function testStore( $op ) {
 199                 $this->filesToPrune[] = $op['src'];
 200
 201                 $this->backend = $this->singleBackend;
 202                 $this->tearDownFiles();
 203                 $this->doTestStore( $op );
 204                 $this->tearDownFiles();
 205
 206                 $this->backend = $this->multiBackend;
 207                 $this->tearDownFiles();
 208                 $this->doTestStore( $op );
 209                 $this->filesToPrune[] = $op['src']; # avoid file leaking
 210                 $this->tearDownFiles();
 211         }
 212
 213         private function doTestStore( $op ) {
 214                 $backendName = $this->backendClass();
 215
 216                 $source = $op['src'];
 217                 $dest = $op['dst'];
 218                 $this->prepare( array( 'dir' => dirname( $dest ) ) );
 219
 220                 file_put_contents( $source, "Unit test file" );
 221
 222                 if ( isset( $op['overwrite'] ) || isset( $op['overwriteSame'] ) ) {
 223                         $this->backend->store( $op );
 224                 }
 225
 226                 $status = $this->backend->doOperation( $op );
 227
 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)." );
 238
 239                 $this->assertEquals( filesize( $source ),
 240                         $this->backend->getFileSize( array( 'src' => $dest ) ),
 241                         "Destination file $dest has correct size ($backendName)." );
 242
 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)." );
 247
 248                 $this->assertBackendPathsConsistent( array( $dest ) );
 249         }
 250
 251         public function provider_testStore() {
 252                 $cases = array();
 253
 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 );
 257                 $cases[] = array(
 258                         $op, // operation
 259                         $tmpName, // source
 260                         $toPath, // dest
 261                 );
 262
 263                 $op2 = $op;
 264                 $op2['overwrite'] = true;
 265                 $cases[] = array(
 266                         $op2, // operation
 267                         $tmpName, // source
 268                         $toPath, // dest
 269                 );
 270
 271                 $op2 = $op;
 272                 $op2['overwriteSame'] = true;
 273                 $cases[] = array(
 274                         $op2, // operation
 275                         $tmpName, // source
 276                         $toPath, // dest
 277                 );
 278
 279                 return $cases;
 280         }
 281
 282         /**
 283          * @dataProvider provider_testCopy
 284          */
 285         public function testCopy( $op ) {
 286                 $this->backend = $this->singleBackend;
 287                 $this->tearDownFiles();
 288                 $this->doTestCopy( $op );
 289                 $this->tearDownFiles();
 290
 291                 $this->backend = $this->multiBackend;
 292                 $this->tearDownFiles();
 293                 $this->doTestCopy( $op );
 294                 $this->tearDownFiles();
 295         }
 296
 297         private function doTestCopy( $op ) {
 298                 $backendName = $this->backendClass();
 299
 300                 $source = $op['src'];
 301                 $dest = $op['dst'];
 302                 $this->prepare( array( 'dir' => dirname( $source ) ) );
 303                 $this->prepare( array( 'dir' => dirname( $dest ) ) );
 304
 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)." );
 309
 310                 if ( isset( $op['overwrite'] ) || isset( $op['overwriteSame'] ) ) {
 311                         $this->backend->copy( $op );
 312                 }
 313
 314                 $status = $this->backend->doOperation( $op );
 315
 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)." );
 326
 327                 $this->assertEquals(
 328                         $this->backend->getFileSize( array( 'src' => $source ) ),
 329                         $this->backend->getFileSize( array( 'src' => $dest ) ),
 330                         "Destination file $dest has correct size ($backendName)." );
 331
 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)." );
 336
 337                 $this->assertBackendPathsConsistent( array( $source, $dest ) );
 338         }
 339
 340         public function provider_testCopy() {
 341                 $cases = array();
 342
 343                 $source = $this->baseStorePath() . '/unittest-cont1/e/file.txt';
 344                 $dest = $this->baseStorePath() . '/unittest-cont2/a/fileMoved.txt';
 345
 346                 $op = array( 'op' => 'copy', 'src' => $source, 'dst' => $dest );
 347                 $cases[] = array(
 348                         $op, // operation
 349                         $source, // source
 350                         $dest, // dest
 351                 );
 352
 353                 $op2 = $op;
 354                 $op2['overwrite'] = true;
 355                 $cases[] = array(
 356                         $op2, // operation
 357                         $source, // source
 358                         $dest, // dest
 359                 );
 360
 361                 $op2 = $op;
 362                 $op2['overwriteSame'] = true;
 363                 $cases[] = array(
 364                         $op2, // operation
 365                         $source, // source
 366                         $dest, // dest
 367                 );
 368
 369                 return $cases;
 370         }
 371
 372         /**
 373          * @dataProvider provider_testMove
 374          */
 375         public function testMove( $op ) {
 376                 $this->backend = $this->singleBackend;
 377                 $this->tearDownFiles();
 378                 $this->doTestMove( $op );
 379                 $this->tearDownFiles();
 380
 381                 $this->backend = $this->multiBackend;
 382                 $this->tearDownFiles();
 383                 $this->doTestMove( $op );
 384                 $this->tearDownFiles();
 385         }
 386
 387         private function doTestMove( $op ) {
 388                 $backendName = $this->backendClass();
 389
 390                 $source = $op['src'];
 391                 $dest = $op['dst'];
 392                 $this->prepare( array( 'dir' => dirname( $source ) ) );
 393                 $this->prepare( array( 'dir' => dirname( $dest ) ) );
 394
 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)." );
 399
 400                 if ( isset( $op['overwrite'] ) || isset( $op['overwriteSame'] ) ) {
 401                         $this->backend->copy( $op );
 402                 }
 403
 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)." );
 415
 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)." );
 420
 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)." );
 427
 428                 $this->assertBackendPathsConsistent( array( $source, $dest ) );
 429         }
 430
 431         public function provider_testMove() {
 432                 $cases = array();
 433
 434                 $source = $this->baseStorePath() . '/unittest-cont1/e/file.txt';
 435                 $dest = $this->baseStorePath() . '/unittest-cont2/a/fileMoved.txt';
 436
 437                 $op = array( 'op' => 'move', 'src' => $source, 'dst' => $dest );
 438                 $cases[] = array(
 439                         $op, // operation
 440                         $source, // source
 441                         $dest, // dest
 442                 );
 443
 444                 $op2 = $op;
 445                 $op2['overwrite'] = true;
 446                 $cases[] = array(
 447                         $op2, // operation
 448                         $source, // source
 449                         $dest, // dest
 450                 );
 451
 452                 $op2 = $op;
 453                 $op2['overwriteSame'] = true;
 454                 $cases[] = array(
 455                         $op2, // operation
 456                         $source, // source
 457                         $dest, // dest
 458                 );
 459
 460                 return $cases;
 461         }
 462
 463         /**
 464          * @dataProvider provider_testDelete
 465          */
 466         public function testDelete( $op, $withSource, $okStatus ) {
 467                 $this->backend = $this->singleBackend;
 468                 $this->tearDownFiles();
 469                 $this->doTestDelete( $op, $withSource, $okStatus );
 470                 $this->tearDownFiles();
 471
 472                 $this->backend = $this->multiBackend;
 473                 $this->tearDownFiles();
 474                 $this->doTestDelete( $op, $withSource, $okStatus );
 475                 $this->tearDownFiles();
 476         }
 477
 478         private function doTestDelete( $op, $withSource, $okStatus ) {
 479                 $backendName = $this->backendClass();
 480
 481                 $source = $op['src'];
 482                 $this->prepare( array( 'dir' => dirname( $source ) ) );
 483
 484                 if ( $withSource ) {
 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)." );
 489                 }
 490
 491                 $status = $this->backend->doOperation( $op );
 492                 if ( $okStatus ) {
 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)." );
 499                 } else {
 500                         $this->assertEquals( false, $status->isOK(),
 501                                 "Deletion of file at $source failed ($backendName)." );
 502                 }
 503
 504                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $source ) ),
 505                         "Source file $source does not exist after move ($backendName)." );
 506
 507                 $this->assertFalse(
 508                         $this->backend->getFileSize( array( 'src' => $source ) ),
 509                         "Source file $source has correct size (false) ($backendName)." );
 510
 511                 $props1 = $this->backend->getFileProps( array( 'src' => $source ) );
 512                 $this->assertFalse( $props1['fileExists'],
 513                         "Source file $source does not exist according to props ($backendName)." );
 514
 515                 $this->assertBackendPathsConsistent( array( $source ) );
 516         }
 517
 518         public function provider_testDelete() {
 519                 $cases = array();
 520
 521                 $source = $this->baseStorePath() . '/unittest-cont1/e/myfacefile.txt';
 522
 523                 $op = array( 'op' => 'delete', 'src' => $source );
 524                 $cases[] = array(
 525                         $op, // operation
 526                         true, // with source
 527                         true // succeeds
 528                 );
 529
 530                 $cases[] = array(
 531                         $op, // operation
 532                         false, // without source
 533                         false // fails
 534                 );
 535
 536                 $op['ignoreMissingSource'] = true;
 537                 $cases[] = array(
 538                         $op, // operation
 539                         false, // without source
 540                         true // succeeds
 541                 );
 542
 543                 return $cases;
 544         }
 545
 546         /**
 547          * @dataProvider provider_testCreate
 548          */
 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();
 554
 555                 $this->backend = $this->multiBackend;
 556                 $this->tearDownFiles();
 557                 $this->doTestCreate( $op, $alreadyExists, $okStatus, $newSize );
 558                 $this->tearDownFiles();
 559         }
 560
 561         private function doTestCreate( $op, $alreadyExists, $okStatus, $newSize ) {
 562                 $backendName = $this->backendClass();
 563
 564                 $dest = $op['dst'];
 565                 $this->prepare( array( 'dir' => dirname( $dest ) ) );
 566
 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)." );
 573                 }
 574
 575                 $status = $this->backend->doOperation( $op );
 576                 if ( $okStatus ) {
 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)." );
 583                 } else {
 584                         $this->assertEquals( false, $status->isOK(),
 585                                 "Creation of file at $dest failed ($backendName)." );
 586                 }
 587
 588                 $this->assertEquals( true, $this->backend->fileExists( array( 'src' => $dest ) ),
 589                         "Destination file $dest exists after creation ($backendName)." );
 590
 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)." );
 606                 }
 607
 608                 $this->assertBackendPathsConsistent( array( $dest ) );
 609         }
 610
 611         /**
 612          * @dataProvider provider_testCreate
 613          */
 614         public function provider_testCreate() {
 615                 $cases = array();
 616
 617                 $dest = $this->baseStorePath() . '/unittest-cont2/a/myspacefile.txt';
 618
 619                 $op = array( 'op' => 'create', 'content' => 'test test testing', 'dst' => $dest );
 620                 $cases[] = array(
 621                         $op, // operation
 622                         false, // no dest already exists
 623                         true, // succeeds
 624                         strlen( $op['content'] )
 625                 );
 626
 627                 $op2 = $op;
 628                 $op2['content'] = "\n";
 629                 $cases[] = array(
 630                         $op2, // operation
 631                         false, // no dest already exists
 632                         true, // succeeds
 633                         strlen( $op2['content'] )
 634                 );
 635
 636                 $op2 = $op;
 637                 $op2['content'] = "fsf\n waf 3kt";
 638                 $cases[] = array(
 639                         $op2, // operation
 640                         true, // dest already exists
 641                         false, // fails
 642                         strlen( $op2['content'] )
 643                 );
 644
 645                 $op2 = $op;
 646                 $op2['content'] = "egm'g gkpe gpqg eqwgwqg";
 647                 $op2['overwrite'] = true;
 648                 $cases[] = array(
 649                         $op2, // operation
 650                         true, // dest already exists
 651                         true, // succeeds
 652                         strlen( $op2['content'] )
 653                 );
 654
 655                 $op2 = $op;
 656                 $op2['content'] = "39qjmg3-qg";
 657                 $op2['overwriteSame'] = true;
 658                 $cases[] = array(
 659                         $op2, // operation
 660                         true, // dest already exists
 661                         false, // succeeds
 662                         strlen( $op2['content'] )
 663                 );
 664
 665                 return $cases;
 666         }
 667
 668         public function testDoQuickOperations() {
 669                 $this->backend = $this->singleBackend;
 670                 $this->doTestDoQuickOperations();
 671                 $this->tearDownFiles();
 672
 673                 $this->backend = $this->multiBackend;
 674                 $this->doTestDoQuickOperations();
 675                 $this->tearDownFiles();
 676         }
 677
 678         private function doTestDoQuickOperations() {
 679                 $backendName = $this->backendClass();
 680
 681                 $base = $this->baseStorePath();
 682                 $files = array(
 683                         "$base/unittest-cont1/e/fileA.a",
 684                         "$base/unittest-cont1/e/fileB.a",
 685                         "$base/unittest-cont1/e/fileC.a"
 686                 );
 687                 $ops = array();
 688                 $purgeOps = array();
 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 );
 695                 }
 696                 $purgeOps[] = array( 'op' => 'null' );
 697                 $status = $this->backend->doQuickOperations( $ops );
 698                 $this->assertGoodStatus( $status,
 699                         "Creation of source files succeeded ($backendName)." );
 700
 701                 foreach ( $files as $file ) {
 702                         $this->assertTrue( $this->backend->fileExists( array( 'src' => $file ) ),
 703                                 "File $file exists." );
 704                 }
 705
 706                 $status = $this->backend->doQuickOperations( $purgeOps );
 707                 $this->assertGoodStatus( $status,
 708                         "Quick deletion of source files succeeded ($backendName)." );
 709
 710                 foreach ( $files as $file ) {
 711                         $this->assertFalse( $this->backend->fileExists( array( 'src' => $file ) ),
 712                                 "File $file purged." );
 713                 }
 714         }
 715
 716         /**
 717          * @dataProvider provider_testConcatenate
 718          */
 719         public function testConcatenate( $op, $srcs, $srcsContent, $alreadyExists, $okStatus ) {
 720                 $this->filesToPrune[] = $op['dst'];
 721
 722                 $this->backend = $this->singleBackend;
 723                 $this->tearDownFiles();
 724                 $this->doTestConcatenate( $op, $srcs, $srcsContent, $alreadyExists, $okStatus );
 725                 $this->tearDownFiles();
 726
 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();
 732         }
 733
 734         private function doTestConcatenate( $params, $srcs, $srcsContent, $alreadyExists, $okStatus ) {
 735                 $backendName = $this->backendClass();
 736
 737                 $expContent = '';
 738                 // Create sources
 739                 $ops = array();
 740                 foreach ( $srcs as $i => $source ) {
 741                         $this->prepare( array( 'dir' => dirname( $source ) ) );
 742                         $ops[] = array(
 743                                 'op'      => 'create', // operation
 744                                 'dst'     => $source, // source
 745                                 'content' => $srcsContent[$i]
 746                         );
 747                         $expContent .= $srcsContent[$i];
 748                 }
 749                 $status = $this->backend->doOperations( $ops );
 750
 751                 $this->assertGoodStatus( $status,
 752                         "Creation of source files succeeded ($backendName)." );
 753
 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)." );
 759                 } else {
 760                         $ok = file_put_contents( $dest, '' ) !== false;
 761                         $this->assertEquals( true, $ok,
 762                                 "Creation of 0-byte file at $dest succeeded ($backendName)." );
 763                 }
 764
 765                 // Combine the files into one
 766                 $status = $this->backend->concatenate( $params );
 767                 if ( $okStatus ) {
 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)." );
 772                 } else {
 773                         $this->assertEquals( false, $status->isOK(),
 774                                 "Creation of concat file at $dest failed ($backendName)." );
 775                 }
 776
 777                 if ( $okStatus ) {
 778                         $this->assertEquals( true, is_file( $dest ),
 779                                 "Dest concat file $dest exists after creation ($backendName)." );
 780                 } else {
 781                         $this->assertEquals( true, is_file( $dest ),
 782                                 "Dest concat file $dest exists after failed creation ($backendName)." );
 783                 }
 784
 785                 $contents = file_get_contents( $dest );
 786                 $this->assertNotEquals( false, $contents, "File at $dest exists ($backendName)." );
 787
 788                 if ( $okStatus ) {
 789                         $this->assertEquals( $expContent, $contents,
 790                                 "Concat file at $dest has correct contents ($backendName)." );
 791                 } else {
 792                         $this->assertNotEquals( $expContent, $contents,
 793                                 "Concat file at $dest has correct contents ($backendName)." );
 794                 }
 795         }
 796
 797         function provider_testConcatenate() {
 798                 $cases = array();
 799
 800                 $rand = mt_rand( 0, 2000000000 ) . time();
 801                 $dest = wfTempDir() . "/randomfile!$rand.txt";
 802                 $srcs = array(
 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'
 813                 );
 814                 $content = array(
 815                         'egfage',
 816                         'ageageag',
 817                         'rhokohlr',
 818                         'shgmslkg',
 819                         'kenga',
 820                         'owagmal',
 821                         'kgmae',
 822                         'g eak;g',
 823                         'lkaem;a',
 824                         'legma'
 825                 );
 826                 $params = array( 'srcs' => $srcs, 'dst' => $dest );
 827
 828                 $cases[] = array(
 829                         $params, // operation
 830                         $srcs, // sources
 831                         $content, // content for each source
 832                         false, // no dest already exists
 833                         true, // succeeds
 834                 );
 835
 836                 $cases[] = array(
 837                         $params, // operation
 838                         $srcs, // sources
 839                         $content, // content for each source
 840                         true, // dest already exists
 841                         false, // succeeds
 842                 );
 843
 844                 return $cases;
 845         }
 846
 847         /**
 848          * @dataProvider provider_testGetFileStat
 849          */
 850         public function testGetFileStat( $path, $content, $alreadyExists ) {
 851                 $this->backend = $this->singleBackend;
 852                 $this->tearDownFiles();
 853                 $this->doTestGetFileStat( $path, $content, $alreadyExists );
 854                 $this->tearDownFiles();
 855
 856                 $this->backend = $this->multiBackend;
 857                 $this->tearDownFiles();
 858                 $this->doTestGetFileStat( $path, $content, $alreadyExists );
 859                 $this->tearDownFiles();
 860         }
 861
 862         private function doTestGetFileStat( $path, $content, $alreadyExists ) {
 863                 $backendName = $this->backendClass();
 864
 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)." );
 870
 871                         $size = $this->backend->getFileSize( array( 'src' => $path ) );
 872                         $time = $this->backend->getFileTimestamp( array( 'src' => $path ) );
 873                         $stat = $this->backend->getFileStat( array( 'src' => $path ) );
 874
 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'" );
 879
 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'" );
 886
 887                         $this->backend->clearCache( array( $path ) );
 888
 889                         $size = $this->backend->getFileSize( array( 'src' => $path ) );
 890
 891                         $this->assertEquals( strlen( $content ), $size,
 892                                 "Correct file size of '$path'" );
 893
 894                         $this->backend->preloadCache( array( $path ) );
 895
 896                         $size = $this->backend->getFileSize( array( 'src' => $path ) );
 897
 898                         $this->assertEquals( strlen( $content ), $size,
 899                                 "Correct file size of '$path'" );
 900                 } else {
 901                         $size = $this->backend->getFileSize( array( 'src' => $path ) );
 902                         $time = $this->backend->getFileTimestamp( array( 'src' => $path ) );
 903                         $stat = $this->backend->getFileStat( array( 'src' => $path ) );
 904
 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'" );
 908                 }
 909         }
 910
 911         function provider_testGetFileStat() {
 912                 $cases = array();
 913
 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 );
 918
 919                 return $cases;
 920         }
 921
 922         /**
 923          * @dataProvider provider_testGetFileContents
 924          */
 925         public function testGetFileContents( $source, $content ) {
 926                 $this->backend = $this->singleBackend;
 927                 $this->tearDownFiles();
 928                 $this->doTestGetFileContents( $source, $content );
 929                 $this->tearDownFiles();
 930
 931                 $this->backend = $this->multiBackend;
 932                 $this->tearDownFiles();
 933                 $this->doTestGetFileContents( $source, $content );
 934                 $this->tearDownFiles();
 935         }
 936
 937         private function doTestGetFileContents( $source, $content ) {
 938                 $backendName = $this->backendClass();
 939
 940                 $srcs = (array)$source;
 941                 $content = (array)$content;
 942                 foreach ( $srcs as $i => $src ) {
 943                         $this->prepare( array( 'dir' => dirname( $src ) ) );
 944                         $status = $this->backend->doOperation(
 945                                 array( 'op' => 'create', 'content' => $content[$i], 'dst' => $src ) );
 946                         $this->assertGoodStatus( $status,
 947                                 "Creation of file at $src succeeded ($backendName)." );
 948                 }
 949
 950                 if ( is_array( $source ) ) {
 951                         $contents = $this->backend->getFileContentsMulti( array( 'srcs' => $source ) );
 952                         foreach ( $contents as $path => $data ) {
 953                                 $this->assertNotEquals( false, $data, "Contents of $path exists ($backendName)." );
 954                                 $this->assertEquals( current( $content ), $data, "Contents of $path is correct ($backendName)." );
 955                                 next( $content );
 956                         }
 957                         $this->assertEquals( $source, array_keys( $contents ), "Contents in right order ($backendName)." );
 958                         $this->assertEquals( count( $source ), count( $contents ), "Contents array size correct ($backendName)." );
 959                 } else {
 960                         $data = $this->backend->getFileContents( array( 'src' => $source ) );
 961                         $this->assertNotEquals( false, $data, "Contents of $source exists ($backendName)." );
 962                         $this->assertEquals( $content[0], $data, "Contents of $source is correct ($backendName)." );
 963                 }
 964         }
 965
 966         function provider_testGetFileContents() {
 967                 $cases = array();
 968
 969                 $base = $this->baseStorePath();
 970                 $cases[] = array( "$base/unittest-cont1/e/b/z/some_file.txt", "some file contents" );
 971                 $cases[] = array( "$base/unittest-cont1/e/b/some-other_file.txt", "more file contents" );
 972                 $cases[] = array(
 973                         array( "$base/unittest-cont1/e/a/x.txt", "$base/unittest-cont1/e/a/y.txt",
 974                                  "$base/unittest-cont1/e/a/z.txt" ),
 975                         array( "contents xx", "contents xy", "contents xz" )
 976                 );
 977
 978                 return $cases;
 979         }
 980
 981         /**
 982          * @dataProvider provider_testGetLocalCopy
 983          */
 984         public function testGetLocalCopy( $source, $content ) {
 985                 $this->backend = $this->singleBackend;
 986                 $this->tearDownFiles();
 987                 $this->doTestGetLocalCopy( $source, $content );
 988                 $this->tearDownFiles();
 989
 990                 $this->backend = $this->multiBackend;
 991                 $this->tearDownFiles();
 992                 $this->doTestGetLocalCopy( $source, $content );
 993                 $this->tearDownFiles();
 994         }
 995
 996         private function doTestGetLocalCopy( $source, $content ) {
 997                 $backendName = $this->backendClass();
 998
 999                 $srcs = (array)$source;
1000                 $content = (array)$content;
1001                 foreach ( $srcs as $i => $src ) {
1002                         $this->prepare( array( 'dir' => dirname( $src ) ) );
1003                         $status = $this->backend->doOperation(
1004                                 array( 'op' => 'create', 'content' => $content[$i], 'dst' => $src ) );
1005                         $this->assertGoodStatus( $status,
1006                                 "Creation of file at $src succeeded ($backendName)." );
1007                 }
1008
1009                 if ( is_array( $source ) ) {
1010                         $tmpFiles = $this->backend->getLocalCopyMulti( array( 'srcs' => $source ) );
1011                         foreach ( $tmpFiles as $path => $tmpFile ) {
1012                                 $this->assertNotNull( $tmpFile,
1013                                         "Creation of local copy of $path succeeded ($backendName)." );
1014                                 $contents = file_get_contents( $tmpFile->getPath() );
1015                                 $this->assertNotEquals( false, $contents, "Local copy of $path exists ($backendName)." );
1016                                 $this->assertEquals( current( $content ), $contents, "Local copy of $path is correct ($backendName)." );
1017                                 next( $content );
1018                         }
1019                         $this->assertEquals( $source, array_keys( $tmpFiles ), "Local copies in right order ($backendName)." );
1020                         $this->assertEquals( count( $source ), count( $tmpFiles ), "Local copies array size correct ($backendName)." );
1021                 } else {
1022                         $tmpFile = $this->backend->getLocalCopy( array( 'src' => $source ) );
1023                         $this->assertNotNull( $tmpFile,
1024                                 "Creation of local copy of $source succeeded ($backendName)." );
1025                         $contents = file_get_contents( $tmpFile->getPath() );
1026                         $this->assertNotEquals( false, $contents, "Local copy of $source exists ($backendName)." );
1027                         $this->assertEquals( $content[0], $contents, "Local copy of $source is correct ($backendName)." );
1028                 }
1029         }
1030
1031         function provider_testGetLocalCopy() {
1032                 $cases = array();
1033
1034                 $base = $this->baseStorePath();
1035                 $cases[] = array( "$base/unittest-cont1/e/a/z/some_file.txt", "some file contents" );
1036                 $cases[] = array( "$base/unittest-cont1/e/a/some-other_file.txt", "more file contents" );
1037                 $cases[] = array( "$base/unittest-cont1/e/a/\$odd&.txt", "test file contents" );
1038                 $cases[] = array(
1039                         array( "$base/unittest-cont1/e/a/x.txt", "$base/unittest-cont1/e/a/y.txt",
1040                                  "$base/unittest-cont1/e/a/z.txt" ),
1041                         array( "contents xx", "contents xy", "contents xz" )
1042                 );
1043
1044                 return $cases;
1045         }
1046
1047         /**
1048          * @dataProvider provider_testGetLocalReference
1049          */
1050         public function testGetLocalReference( $source, $content ) {
1051                 $this->backend = $this->singleBackend;
1052                 $this->tearDownFiles();
1053                 $this->doTestGetLocalReference( $source, $content );
1054                 $this->tearDownFiles();
1055
1056                 $this->backend = $this->multiBackend;
1057                 $this->tearDownFiles();
1058                 $this->doTestGetLocalReference( $source, $content );
1059                 $this->tearDownFiles();
1060         }
1061
1062         private function doTestGetLocalReference( $source, $content ) {
1063                 $backendName = $this->backendClass();
1064
1065                 $srcs = (array)$source;
1066                 $content = (array)$content;
1067                 foreach ( $srcs as $i => $src ) {
1068                         $this->prepare( array( 'dir' => dirname( $src ) ) );
1069                         $status = $this->backend->doOperation(
1070                                 array( 'op' => 'create', 'content' => $content[$i], 'dst' => $src ) );
1071                         $this->assertGoodStatus( $status,
1072                                 "Creation of file at $src succeeded ($backendName)." );
1073                 }
1074
1075                 if ( is_array( $source ) ) {
1076                         $tmpFiles = $this->backend->getLocalReferenceMulti( array( 'srcs' => $source ) );
1077                         foreach ( $tmpFiles as $path => $tmpFile ) {
1078                                 $this->assertNotNull( $tmpFile,
1079                                         "Creation of local copy of $path succeeded ($backendName)." );
1080                                 $contents = file_get_contents( $tmpFile->getPath() );
1081                                 $this->assertNotEquals( false, $contents, "Local ref of $path exists ($backendName)." );
1082                                 $this->assertEquals( current( $content ), $contents, "Local ref of $path is correct ($backendName)." );
1083                                 next( $content );
1084                         }
1085                         $this->assertEquals( $source, array_keys( $tmpFiles ), "Local refs in right order ($backendName)." );
1086                         $this->assertEquals( count( $source ), count( $tmpFiles ), "Local refs array size correct ($backendName)." );
1087                 } else {
1088                         $tmpFile = $this->backend->getLocalReference( array( 'src' => $source ) );
1089                         $this->assertNotNull( $tmpFile,
1090                                 "Creation of local copy of $source succeeded ($backendName)." );
1091                         $contents = file_get_contents( $tmpFile->getPath() );
1092                         $this->assertNotEquals( false, $contents, "Local ref of $source exists ($backendName)." );
1093                         $this->assertEquals( $content[0], $contents, "Local ref of $source is correct ($backendName)." );
1094                 }
1095         }
1096
1097         function provider_testGetLocalReference() {
1098                 $cases = array();
1099
1100                 $base = $this->baseStorePath();
1101                 $cases[] = array( "$base/unittest-cont1/e/a/z/some_file.txt", "some file contents" );
1102                 $cases[] = array( "$base/unittest-cont1/e/a/some-other_file.txt", "more file contents" );
1103                 $cases[] = array( "$base/unittest-cont1/e/a/\$odd&.txt", "test file contents" );
1104                 $cases[] = array(
1105                         array( "$base/unittest-cont1/e/a/x.txt", "$base/unittest-cont1/e/a/y.txt",
1106                                  "$base/unittest-cont1/e/a/z.txt" ),
1107                         array( "contents xx", "contents xy", "contents xz" )
1108                 );
1109
1110                 return $cases;
1111         }
1112
1113         /**
1114          * @dataProvider provider_testPrepareAndClean
1115          */
1116         public function testPrepareAndClean( $path, $isOK ) {
1117                 $this->backend = $this->singleBackend;
1118                 $this->doTestPrepareAndClean( $path, $isOK );
1119                 $this->tearDownFiles();
1120
1121                 $this->backend = $this->multiBackend;
1122                 $this->doTestPrepareAndClean( $path, $isOK );
1123                 $this->tearDownFiles();
1124         }
1125
1126         function provider_testPrepareAndClean() {
1127                 $base = $this->baseStorePath();
1128                 return array(
1129                         array( "$base/unittest-cont1/e/a/z/some_file1.txt", true ),
1130                         array( "$base/unittest-cont2/a/z/some_file2.txt", true ),
1131                         # Specific to FS backend with no basePath field set
1132                         #array( "$base/unittest-cont3/a/z/some_file3.txt", false ),
1133                 );
1134         }
1135
1136         private function doTestPrepareAndClean( $path, $isOK ) {
1137                 $backendName = $this->backendClass();
1138
1139                 $status = $this->prepare( array( 'dir' => dirname( $path ) ) );
1140                 if ( $isOK ) {
1141                         $this->assertGoodStatus( $status,
1142                                 "Preparing dir $path succeeded without warnings ($backendName)." );
1143                         $this->assertEquals( true, $status->isOK(),
1144                                 "Preparing dir $path succeeded ($backendName)." );
1145                 } else {
1146                         $this->assertEquals( false, $status->isOK(),
1147                                 "Preparing dir $path failed ($backendName)." );
1148                 }
1149
1150                 $status = $this->backend->clean( array( 'dir' => dirname( $path ) ) );
1151                 if ( $isOK ) {
1152                         $this->assertGoodStatus( $status,
1153                                 "Cleaning dir $path succeeded without warnings ($backendName)." );
1154                         $this->assertEquals( true, $status->isOK(),
1155                                 "Cleaning dir $path succeeded ($backendName)." );
1156                 } else {
1157                         $this->assertEquals( false, $status->isOK(),
1158                                 "Cleaning dir $path failed ($backendName)." );
1159                 }
1160         }
1161
1162         public function testRecursiveClean() {
1163                 $this->backend = $this->singleBackend;
1164                 $this->doTestRecursiveClean();
1165                 $this->tearDownFiles();
1166
1167                 $this->backend = $this->multiBackend;
1168                 $this->doTestRecursiveClean();
1169                 $this->tearDownFiles();
1170         }
1171
1172         private function doTestRecursiveClean() {
1173                 $backendName = $this->backendClass();
1174
1175                 $base = $this->baseStorePath();
1176                 $dirs = array(
1177                         "$base/unittest-cont1/e/a",
1178                         "$base/unittest-cont1/e/a/b",
1179                         "$base/unittest-cont1/e/a/b/c",
1180                         "$base/unittest-cont1/e/a/b/c/d0",
1181                         "$base/unittest-cont1/e/a/b/c/d1",
1182                         "$base/unittest-cont1/e/a/b/c/d2",
1183                         "$base/unittest-cont1/e/a/b/c/d0/1",
1184                         "$base/unittest-cont1/e/a/b/c/d0/2",
1185                         "$base/unittest-cont1/e/a/b/c/d1/3",
1186                         "$base/unittest-cont1/e/a/b/c/d1/4",
1187                         "$base/unittest-cont1/e/a/b/c/d2/5",
1188                         "$base/unittest-cont1/e/a/b/c/d2/6"
1189                 );
1190                 foreach ( $dirs as $dir ) {
1191                         $status = $this->prepare( array( 'dir' => $dir ) );
1192                         $this->assertGoodStatus( $status,
1193                                 "Preparing dir $dir succeeded without warnings ($backendName)." );
1194                 }
1195
1196                 if ( $this->backend instanceof FSFileBackend ) {
1197                         foreach ( $dirs as $dir ) {
1198                                 $this->assertEquals( true, $this->backend->directoryExists( array( 'dir' => $dir ) ),
1199                                         "Dir $dir exists ($backendName)." );
1200                         }
1201                 }
1202
1203                 $status = $this->backend->clean(
1204                         array( 'dir' => "$base/unittest-cont1", 'recursive' => 1 ) );
1205                 $this->assertGoodStatus( $status,
1206                         "Recursive cleaning of dir $dir succeeded without warnings ($backendName)." );
1207
1208                 foreach ( $dirs as $dir ) {
1209                         $this->assertEquals( false, $this->backend->directoryExists( array( 'dir' => $dir ) ),
1210                                 "Dir $dir no longer exists ($backendName)." );
1211                 }
1212         }
1213
1214         // @TODO: testSecure
1215
1216         public function testDoOperations() {
1217                 $this->backend = $this->singleBackend;
1218                 $this->tearDownFiles();
1219                 $this->doTestDoOperations();
1220                 $this->tearDownFiles();
1221
1222                 $this->backend = $this->multiBackend;
1223                 $this->tearDownFiles();
1224                 $this->doTestDoOperations();
1225                 $this->tearDownFiles();
1226         }
1227
1228         private function doTestDoOperations() {
1229                 $base = $this->baseStorePath();
1230
1231                 $fileA = "$base/unittest-cont1/e/a/b/fileA.txt";
1232                 $fileAContents = '3tqtmoeatmn4wg4qe-mg3qt3 tq';
1233                 $fileB = "$base/unittest-cont1/e/a/b/fileB.txt";
1234                 $fileBContents = 'g-jmq3gpqgt3qtg q3GT ';
1235                 $fileC = "$base/unittest-cont1/e/a/b/fileC.txt";
1236                 $fileCContents = 'eigna[ogmewt 3qt g3qg flew[ag';
1237                 $fileD = "$base/unittest-cont1/e/a/b/fileD.txt";
1238
1239                 $this->prepare( array( 'dir' => dirname( $fileA ) ) );
1240                 $this->create( array( 'dst' => $fileA, 'content' => $fileAContents ) );
1241                 $this->prepare( array( 'dir' => dirname( $fileB ) ) );
1242                 $this->create( array( 'dst' => $fileB, 'content' => $fileBContents ) );
1243                 $this->prepare( array( 'dir' => dirname( $fileC ) ) );
1244                 $this->create( array( 'dst' => $fileC, 'content' => $fileCContents ) );
1245                 $this->prepare( array( 'dir' => dirname( $fileD ) ) );
1246
1247                 $status = $this->backend->doOperations( array(
1248                         array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC, 'overwrite' => 1 ),
1249                         // Now: A:<A>, B:<B>, C:<A>, D:<empty> (file:<orginal contents>)
1250                         array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileA, 'overwriteSame' => 1 ),
1251                         // Now: A:<A>, B:<B>, C:<A>, D:<empty>
1252                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileD, 'overwrite' => 1 ),
1253                         // Now: A:<A>, B:<B>, C:<empty>, D:<A>
1254                         array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileC ),
1255                         // Now: A:<A>, B:<empty>, C:<B>, D:<A>
1256                         array( 'op' => 'move', 'src' => $fileD, 'dst' => $fileA, 'overwriteSame' => 1 ),
1257                         // Now: A:<A>, B:<empty>, C:<B>, D:<empty>
1258                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileA, 'overwrite' => 1 ),
1259                         // Now: A:<B>, B:<empty>, C:<empty>, D:<empty>
1260                         array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC ),
1261                         // Now: A:<B>, B:<empty>, C:<B>, D:<empty>
1262                         array( 'op' => 'move', 'src' => $fileA, 'dst' => $fileC, 'overwriteSame' => 1 ),
1263                         // Now: A:<empty>, B:<empty>, C:<B>, D:<empty>
1264                         array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1265                         // Does nothing
1266                         array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1267                         // Does nothing
1268                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1269                         // Does nothing
1270                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1271                         // Does nothing
1272                         array( 'op' => 'null' ),
1273                         // Does nothing
1274                 ) );
1275
1276                 $this->assertGoodStatus( $status, "Operation batch succeeded" );
1277                 $this->assertEquals( true, $status->isOK(), "Operation batch succeeded" );
1278                 $this->assertEquals( 13, count( $status->success ),
1279                         "Operation batch has correct success array" );
1280
1281                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileA ) ),
1282                         "File does not exist at $fileA" );
1283                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileB ) ),
1284                         "File does not exist at $fileB" );
1285                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileD ) ),
1286                         "File does not exist at $fileD" );
1287
1288                 $this->assertEquals( true, $this->backend->fileExists( array( 'src' => $fileC ) ),
1289                         "File exists at $fileC" );
1290                 $this->assertEquals( $fileBContents,
1291                         $this->backend->getFileContents( array( 'src' => $fileC ) ),
1292                         "Correct file contents of $fileC" );
1293                 $this->assertEquals( strlen( $fileBContents ),
1294                         $this->backend->getFileSize( array( 'src' => $fileC ) ),
1295                         "Correct file size of $fileC" );
1296                 $this->assertEquals( wfBaseConvert( sha1( $fileBContents ), 16, 36, 31 ),
1297                         $this->backend->getFileSha1Base36( array( 'src' => $fileC ) ),
1298                         "Correct file SHA-1 of $fileC" );
1299         }
1300
1301         public function testDoOperationsPipeline() {
1302                 $this->backend = $this->singleBackend;
1303                 $this->tearDownFiles();
1304                 $this->doTestDoOperationsPipeline();
1305                 $this->tearDownFiles();
1306
1307                 $this->backend = $this->multiBackend;
1308                 $this->tearDownFiles();
1309                 $this->doTestDoOperationsPipeline();
1310                 $this->tearDownFiles();
1311         }
1312
1313         // concurrency orientated
1314         private function doTestDoOperationsPipeline() {
1315                 $base = $this->baseStorePath();
1316
1317                 $fileAContents = '3tqtmoeatmn4wg4qe-mg3qt3 tq';
1318                 $fileBContents = 'g-jmq3gpqgt3qtg q3GT ';
1319                 $fileCContents = 'eigna[ogmewt 3qt g3qg flew[ag';
1320
1321                 $tmpNameA = TempFSFile::factory( "unittests_", 'txt' )->getPath();
1322                 file_put_contents( $tmpNameA, $fileAContents );
1323                 $tmpNameB = TempFSFile::factory( "unittests_", 'txt' )->getPath();
1324                 file_put_contents( $tmpNameB, $fileBContents );
1325                 $tmpNameC = TempFSFile::factory( "unittests_", 'txt' )->getPath();
1326                 file_put_contents( $tmpNameC, $fileCContents );
1327
1328                 $this->filesToPrune[] = $tmpNameA; # avoid file leaking
1329                 $this->filesToPrune[] = $tmpNameB; # avoid file leaking
1330                 $this->filesToPrune[] = $tmpNameC; # avoid file leaking
1331
1332                 $fileA = "$base/unittest-cont1/e/a/b/fileA.txt";
1333                 $fileB = "$base/unittest-cont1/e/a/b/fileB.txt";
1334                 $fileC = "$base/unittest-cont1/e/a/b/fileC.txt";
1335                 $fileD = "$base/unittest-cont1/e/a/b/fileD.txt";
1336
1337                 $this->prepare( array( 'dir' => dirname( $fileA ) ) );
1338                 $this->create( array( 'dst' => $fileA, 'content' => $fileAContents ) );
1339                 $this->prepare( array( 'dir' => dirname( $fileB ) ) );
1340                 $this->prepare( array( 'dir' => dirname( $fileC ) ) );
1341                 $this->prepare( array( 'dir' => dirname( $fileD ) ) );
1342
1343                 $status = $this->backend->doOperations( array(
1344                         array( 'op' => 'store', 'src' => $tmpNameA, 'dst' => $fileA, 'overwriteSame' => 1 ),
1345                         array( 'op' => 'store', 'src' => $tmpNameB, 'dst' => $fileB, 'overwrite' => 1 ),
1346                         array( 'op' => 'store', 'src' => $tmpNameC, 'dst' => $fileC, 'overwrite' => 1 ),
1347                         array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC, 'overwrite' => 1 ),
1348                         // Now: A:<A>, B:<B>, C:<A>, D:<empty> (file:<orginal contents>)
1349                         array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileA, 'overwriteSame' => 1 ),
1350                         // Now: A:<A>, B:<B>, C:<A>, D:<empty>
1351                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileD, 'overwrite' => 1 ),
1352                         // Now: A:<A>, B:<B>, C:<empty>, D:<A>
1353                         array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileC ),
1354                         // Now: A:<A>, B:<empty>, C:<B>, D:<A>
1355                         array( 'op' => 'move', 'src' => $fileD, 'dst' => $fileA, 'overwriteSame' => 1 ),
1356                         // Now: A:<A>, B:<empty>, C:<B>, D:<empty>
1357                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileA, 'overwrite' => 1 ),
1358                         // Now: A:<B>, B:<empty>, C:<empty>, D:<empty>
1359                         array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC ),
1360                         // Now: A:<B>, B:<empty>, C:<B>, D:<empty>
1361                         array( 'op' => 'move', 'src' => $fileA, 'dst' => $fileC, 'overwriteSame' => 1 ),
1362                         // Now: A:<empty>, B:<empty>, C:<B>, D:<empty>
1363                         array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1364                         // Does nothing
1365                         array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1366                         // Does nothing
1367                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwrite' => 1 ),
1368                         // Does nothing
1369                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileC, 'overwriteSame' => 1 ),
1370                         // Does nothing
1371                         array( 'op' => 'null' ),
1372                         // Does nothing
1373                 ) );
1374
1375                 $this->assertGoodStatus( $status, "Operation batch succeeded" );
1376                 $this->assertEquals( true, $status->isOK(), "Operation batch succeeded" );
1377                 $this->assertEquals( 16, count( $status->success ),
1378                         "Operation batch has correct success array" );
1379
1380                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileA ) ),
1381                         "File does not exist at $fileA" );
1382                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileB ) ),
1383                         "File does not exist at $fileB" );
1384                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileD ) ),
1385                         "File does not exist at $fileD" );
1386
1387                 $this->assertEquals( true, $this->backend->fileExists( array( 'src' => $fileC ) ),
1388                         "File exists at $fileC" );
1389                 $this->assertEquals( $fileBContents,
1390                         $this->backend->getFileContents( array( 'src' => $fileC ) ),
1391                         "Correct file contents of $fileC" );
1392                 $this->assertEquals( strlen( $fileBContents ),
1393                         $this->backend->getFileSize( array( 'src' => $fileC ) ),
1394                         "Correct file size of $fileC" );
1395                 $this->assertEquals( wfBaseConvert( sha1( $fileBContents ), 16, 36, 31 ),
1396                         $this->backend->getFileSha1Base36( array( 'src' => $fileC ) ),
1397                         "Correct file SHA-1 of $fileC" );
1398         }
1399
1400         public function testDoOperationsFailing() {
1401                 $this->backend = $this->singleBackend;
1402                 $this->tearDownFiles();
1403                 $this->doTestDoOperationsFailing();
1404                 $this->tearDownFiles();
1405
1406                 $this->backend = $this->multiBackend;
1407                 $this->tearDownFiles();
1408                 $this->doTestDoOperationsFailing();
1409                 $this->tearDownFiles();
1410         }
1411
1412         private function doTestDoOperationsFailing() {
1413                 $base = $this->baseStorePath();
1414
1415                 $fileA = "$base/unittest-cont2/a/b/fileA.txt";
1416                 $fileAContents = '3tqtmoeatmn4wg4qe-mg3qt3 tq';
1417                 $fileB = "$base/unittest-cont2/a/b/fileB.txt";
1418                 $fileBContents = 'g-jmq3gpqgt3qtg q3GT ';
1419                 $fileC = "$base/unittest-cont2/a/b/fileC.txt";
1420                 $fileCContents = 'eigna[ogmewt 3qt g3qg flew[ag';
1421                 $fileD = "$base/unittest-cont2/a/b/fileD.txt";
1422
1423                 $this->prepare( array( 'dir' => dirname( $fileA ) ) );
1424                 $this->create( array( 'dst' => $fileA, 'content' => $fileAContents ) );
1425                 $this->prepare( array( 'dir' => dirname( $fileB ) ) );
1426                 $this->create( array( 'dst' => $fileB, 'content' => $fileBContents ) );
1427                 $this->prepare( array( 'dir' => dirname( $fileC ) ) );
1428                 $this->create( array( 'dst' => $fileC, 'content' => $fileCContents ) );
1429
1430                 $status = $this->backend->doOperations( array(
1431                         array( 'op' => 'copy', 'src' => $fileA, 'dst' => $fileC, 'overwrite' => 1 ),
1432                         // Now: A:<A>, B:<B>, C:<A>, D:<empty> (file:<orginal contents>)
1433                         array( 'op' => 'copy', 'src' => $fileC, 'dst' => $fileA, 'overwriteSame' => 1 ),
1434                         // Now: A:<A>, B:<B>, C:<A>, D:<empty>
1435                         array( 'op' => 'copy', 'src' => $fileB, 'dst' => $fileD, 'overwrite' => 1 ),
1436                         // Now: A:<A>, B:<B>, C:<A>, D:<B>
1437                         array( 'op' => 'move', 'src' => $fileC, 'dst' => $fileD ),
1438                         // Now: A:<A>, B:<B>, C:<A>, D:<empty> (failed)
1439                         array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileC, 'overwriteSame' => 1 ),
1440                         // Now: A:<A>, B:<B>, C:<A>, D:<empty> (failed)
1441                         array( 'op' => 'move', 'src' => $fileB, 'dst' => $fileA, 'overwrite' => 1 ),
1442                         // Now: A:<B>, B:<empty>, C:<A>, D:<empty>
1443                         array( 'op' => 'delete', 'src' => $fileD ),
1444                         // Now: A:<B>, B:<empty>, C:<A>, D:<empty>
1445                         array( 'op' => 'null' ),
1446                         // Does nothing
1447                 ), array( 'force' => 1 ) );
1448
1449                 $this->assertNotEquals( array(), $status->errors, "Operation had warnings" );
1450                 $this->assertEquals( true, $status->isOK(), "Operation batch succeeded" );
1451                 $this->assertEquals( 8, count( $status->success ),
1452                         "Operation batch has correct success array" );
1453
1454                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileB ) ),
1455                         "File does not exist at $fileB" );
1456                 $this->assertEquals( false, $this->backend->fileExists( array( 'src' => $fileD ) ),
1457                         "File does not exist at $fileD" );
1458
1459                 $this->assertEquals( true, $this->backend->fileExists( array( 'src' => $fileA ) ),
1460                         "File does not exist at $fileA" );
1461                 $this->assertEquals( true, $this->backend->fileExists( array( 'src' => $fileC ) ),
1462                         "File exists at $fileC" );
1463                 $this->assertEquals( $fileBContents,
1464                         $this->backend->getFileContents( array( 'src' => $fileA ) ),
1465                         "Correct file contents of $fileA" );
1466                 $this->assertEquals( strlen( $fileBContents ),
1467                         $this->backend->getFileSize( array( 'src' => $fileA ) ),
1468                         "Correct file size of $fileA" );
1469                 $this->assertEquals( wfBaseConvert( sha1( $fileBContents ), 16, 36, 31 ),
1470                         $this->backend->getFileSha1Base36( array( 'src' => $fileA ) ),
1471                         "Correct file SHA-1 of $fileA" );
1472         }
1473
1474         public function testGetFileList() {
1475                 $this->backend = $this->singleBackend;
1476                 $this->tearDownFiles();
1477                 $this->doTestGetFileList();
1478                 $this->tearDownFiles();
1479
1480                 $this->backend = $this->multiBackend;
1481                 $this->tearDownFiles();
1482                 $this->doTestGetFileList();
1483                 $this->tearDownFiles();
1484         }
1485
1486         private function doTestGetFileList() {
1487                 $backendName = $this->backendClass();
1488                 $base = $this->baseStorePath();
1489
1490                 // Should have no errors
1491                 $iter = $this->backend->getFileList( array( 'dir' => "$base/unittest-cont-notexists" ) );
1492
1493                 $files = array(
1494                         "$base/unittest-cont1/e/test1.txt",
1495                         "$base/unittest-cont1/e/test2.txt",
1496                         "$base/unittest-cont1/e/test3.txt",
1497                         "$base/unittest-cont1/e/subdir1/test1.txt",
1498                         "$base/unittest-cont1/e/subdir1/test2.txt",
1499                         "$base/unittest-cont1/e/subdir2/test3.txt",
1500                         "$base/unittest-cont1/e/subdir2/test4.txt",
1501                         "$base/unittest-cont1/e/subdir2/subdir/test1.txt",
1502                         "$base/unittest-cont1/e/subdir2/subdir/test2.txt",
1503                         "$base/unittest-cont1/e/subdir2/subdir/test3.txt",
1504                         "$base/unittest-cont1/e/subdir2/subdir/test4.txt",
1505                         "$base/unittest-cont1/e/subdir2/subdir/test5.txt",
1506                         "$base/unittest-cont1/e/subdir2/subdir/sub/test0.txt",
1507                         "$base/unittest-cont1/e/subdir2/subdir/sub/120-px-file.txt",
1508                 );
1509
1510                 // Add the files
1511                 $ops = array();
1512                 foreach ( $files as $file ) {
1513                         $this->prepare( array( 'dir' => dirname( $file ) ) );
1514                         $ops[] = array( 'op' => 'create', 'content' => 'xxy', 'dst' => $file );
1515                 }
1516                 $status = $this->backend->doQuickOperations( $ops );
1517                 $this->assertGoodStatus( $status,
1518                         "Creation of files succeeded ($backendName)." );
1519                 $this->assertEquals( true, $status->isOK(),
1520                         "Creation of files succeeded with OK status ($backendName)." );
1521
1522                 // Expected listing
1523                 $expected = array(
1524                         "e/test1.txt",
1525                         "e/test2.txt",
1526                         "e/test3.txt",
1527                         "e/subdir1/test1.txt",
1528                         "e/subdir1/test2.txt",
1529                         "e/subdir2/test3.txt",
1530                         "e/subdir2/test4.txt",
1531                         "e/subdir2/subdir/test1.txt",
1532                         "e/subdir2/subdir/test2.txt",
1533                         "e/subdir2/subdir/test3.txt",
1534                         "e/subdir2/subdir/test4.txt",
1535                         "e/subdir2/subdir/test5.txt",
1536                         "e/subdir2/subdir/sub/test0.txt",
1537                         "e/subdir2/subdir/sub/120-px-file.txt",
1538                 );
1539                 sort( $expected );
1540
1541                 // Actual listing (no trailing slash)
1542                 $list = array();
1543                 $iter = $this->backend->getFileList( array( 'dir' => "$base/unittest-cont1" ) );
1544                 foreach ( $iter as $file ) {
1545                         $list[] = $file;
1546                 }
1547                 sort( $list );
1548
1549                 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1550
1551                 // Actual listing (with trailing slash)
1552                 $list = array();
1553                 $iter = $this->backend->getFileList( array( 'dir' => "$base/unittest-cont1/" ) );
1554                 foreach ( $iter as $file ) {
1555                         $list[] = $file;
1556                 }
1557                 sort( $list );
1558
1559                 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1560
1561                 // Expected listing
1562                 $expected = array(
1563                         "test1.txt",
1564                         "test2.txt",
1565                         "test3.txt",
1566                         "test4.txt",
1567                         "test5.txt",
1568                         "sub/test0.txt",
1569                         "sub/120-px-file.txt",
1570                 );
1571                 sort( $expected );
1572
1573                 // Actual listing (no trailing slash)
1574                 $list = array();
1575                 $iter = $this->backend->getFileList( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir" ) );
1576                 foreach ( $iter as $file ) {
1577                         $list[] = $file;
1578                 }
1579                 sort( $list );
1580
1581                 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1582
1583                 // Actual listing (with trailing slash)
1584                 $list = array();
1585                 $iter = $this->backend->getFileList( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir/" ) );
1586                 foreach ( $iter as $file ) {
1587                         $list[] = $file;
1588                 }
1589                 sort( $list );
1590
1591                 $this->assertEquals( $expected, $list, "Correct file listing ($backendName)." );
1592
1593                 // Actual listing (using iterator second time)
1594                 $list = array();
1595                 foreach ( $iter as $file ) {
1596                         $list[] = $file;
1597                 }
1598                 sort( $list );
1599
1600                 $this->assertEquals( $expected, $list, "Correct file listing ($backendName), second iteration." );
1601
1602                 // Expected listing (top files only)
1603                 $expected = array(
1604                         "test1.txt",
1605                         "test2.txt",
1606                         "test3.txt",
1607                         "test4.txt",
1608                         "test5.txt"
1609                 );
1610                 sort( $expected );
1611
1612                 // Actual listing (top files only)
1613                 $list = array();
1614                 $iter = $this->backend->getTopFileList( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir" ) );
1615                 foreach ( $iter as $file ) {
1616                         $list[] = $file;
1617                 }
1618                 sort( $list );
1619
1620                 $this->assertEquals( $expected, $list, "Correct top file listing ($backendName)." );
1621
1622                 foreach ( $files as $file ) { // clean up
1623                         $this->backend->doOperation( array( 'op' => 'delete', 'src' => $file ) );
1624                 }
1625
1626                 $iter = $this->backend->getFileList( array( 'dir' => "$base/unittest-cont1/not/exists" ) );
1627                 foreach ( $iter as $iter ) {} // no errors
1628         }
1629
1630         public function testGetDirectoryList() {
1631                 $this->backend = $this->singleBackend;
1632                 $this->tearDownFiles();
1633                 $this->doTestGetDirectoryList();
1634                 $this->tearDownFiles();
1635
1636                 $this->backend = $this->multiBackend;
1637                 $this->tearDownFiles();
1638                 $this->doTestGetDirectoryList();
1639                 $this->tearDownFiles();
1640         }
1641
1642         private function doTestGetDirectoryList() {
1643                 $backendName = $this->backendClass();
1644
1645                 $base = $this->baseStorePath();
1646                 $files = array(
1647                         "$base/unittest-cont1/e/test1.txt",
1648                         "$base/unittest-cont1/e/test2.txt",
1649                         "$base/unittest-cont1/e/test3.txt",
1650                         "$base/unittest-cont1/e/subdir1/test1.txt",
1651                         "$base/unittest-cont1/e/subdir1/test2.txt",
1652                         "$base/unittest-cont1/e/subdir2/test3.txt",
1653                         "$base/unittest-cont1/e/subdir2/test4.txt",
1654                         "$base/unittest-cont1/e/subdir2/subdir/test1.txt",
1655                         "$base/unittest-cont1/e/subdir3/subdir/test2.txt",
1656                         "$base/unittest-cont1/e/subdir4/subdir/test3.txt",
1657                         "$base/unittest-cont1/e/subdir4/subdir/test4.txt",
1658                         "$base/unittest-cont1/e/subdir4/subdir/test5.txt",
1659                         "$base/unittest-cont1/e/subdir4/subdir/sub/test0.txt",
1660                         "$base/unittest-cont1/e/subdir4/subdir/sub/120-px-file.txt",
1661                 );
1662
1663                 // Add the files
1664                 $ops = array();
1665                 foreach ( $files as $file ) {
1666                         $this->prepare( array( 'dir' => dirname( $file ) ) );
1667                         $ops[] = array( 'op' => 'create', 'content' => 'xxy', 'dst' => $file );
1668                 }
1669                 $status = $this->backend->doQuickOperations( $ops );
1670                 $this->assertGoodStatus( $status,
1671                         "Creation of files succeeded ($backendName)." );
1672                 $this->assertEquals( true, $status->isOK(),
1673                         "Creation of files succeeded with OK status ($backendName)." );
1674
1675                 $this->assertEquals( true,
1676                         $this->backend->directoryExists( array( 'dir' => "$base/unittest-cont1/e/subdir1" ) ),
1677                         "Directory exists in ($backendName)." );
1678                 $this->assertEquals( true,
1679                         $this->backend->directoryExists( array( 'dir' => "$base/unittest-cont1/e/subdir2/subdir" ) ),
1680                         "Directory exists in ($backendName)." );
1681                 $this->assertEquals( false,
1682                         $this->backend->directoryExists( array( 'dir' => "$base/unittest-cont1/e/subdir2/test1.txt" ) ),
1683                         "Directory does not exists in ($backendName)." );
1684
1685                 // Expected listing
1686                 $expected = array(
1687                         "e",
1688                 );
1689                 sort( $expected );
1690
1691                 // Actual listing (no trailing slash)
1692                 $list = array();
1693                 $iter = $this->backend->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1" ) );
1694                 foreach ( $iter as $file ) {
1695                         $list[] = $file;
1696                 }
1697                 sort( $list );
1698
1699                 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1700
1701                 // Expected listing
1702                 $expected = array(
1703                         "subdir1",
1704                         "subdir2",
1705                         "subdir3",
1706                         "subdir4",
1707                 );
1708                 sort( $expected );
1709
1710                 // Actual listing (no trailing slash)
1711                 $list = array();
1712                 $iter = $this->backend->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e" ) );
1713                 foreach ( $iter as $file ) {
1714                         $list[] = $file;
1715                 }
1716                 sort( $list );
1717
1718                 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1719
1720                 // Actual listing (with trailing slash)
1721                 $list = array();
1722                 $iter = $this->backend->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e/" ) );
1723                 foreach ( $iter as $file ) {
1724                         $list[] = $file;
1725                 }
1726                 sort( $list );
1727
1728                 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1729
1730                 // Expected listing
1731                 $expected = array(
1732                         "subdir",
1733                 );
1734                 sort( $expected );
1735
1736                 // Actual listing (no trailing slash)
1737                 $list = array();
1738                 $iter = $this->backend->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e/subdir2" ) );
1739                 foreach ( $iter as $file ) {
1740                         $list[] = $file;
1741                 }
1742                 sort( $list );
1743
1744                 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1745
1746                 // Actual listing (with trailing slash)
1747                 $list = array();
1748                 $iter = $this->backend->getTopDirectoryList( array( 'dir' => "$base/unittest-cont1/e/subdir2/" ) );
1749                 foreach ( $iter as $file ) {
1750                         $list[] = $file;
1751                 }
1752                 sort( $list );
1753
1754                 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName)." );
1755
1756                 // Actual listing (using iterator second time)
1757                 $list = array();
1758                 foreach ( $iter as $file ) {
1759                         $list[] = $file;
1760                 }
1761                 sort( $list );
1762
1763                 $this->assertEquals( $expected, $list, "Correct top dir listing ($backendName), second iteration." );
1764
1765                 // Expected listing (recursive)
1766                 $expected = array(
1767                         "e",
1768                         "e/subdir1",
1769                         "e/subdir2",
1770                         "e/subdir3",
1771                         "e/subdir4",
1772                         "e/subdir2/subdir",
1773                         "e/subdir3/subdir",
1774                         "e/subdir4/subdir",
1775                         "e/subdir4/subdir/sub",
1776                 );
1777                 sort( $expected );
1778
1779                 // Actual listing (recursive)
1780                 $list = array();
1781                 $iter = $this->backend->getDirectoryList( array( 'dir' => "$base/unittest-cont1/" ) );
1782                 foreach ( $iter as $file ) {
1783                         $list[] = $file;
1784                 }
1785                 sort( $list );
1786
1787                 $this->assertEquals( $expected, $list, "Correct dir listing ($backendName)." );
1788
1789                 // Expected listing (recursive)
1790                 $expected = array(
1791                         "subdir",
1792                         "subdir/sub",
1793                 );
1794                 sort( $expected );
1795
1796                 // Actual listing (recursive)
1797                 $list = array();
1798                 $iter = $this->backend->getDirectoryList( array( 'dir' => "$base/unittest-cont1/e/subdir4" ) );
1799                 foreach ( $iter as $file ) {
1800                         $list[] = $file;
1801                 }
1802                 sort( $list );
1803
1804                 $this->assertEquals( $expected, $list, "Correct dir listing ($backendName)." );
1805
1806                 // Actual listing (recursive, second time)
1807                 $list = array();
1808                 foreach ( $iter as $file ) {
1809                         $list[] = $file;
1810                 }
1811                 sort( $list );
1812
1813                 $this->assertEquals( $expected, $list, "Correct dir listing ($backendName)." );
1814
1815                 foreach ( $files as $file ) { // clean up
1816                         $this->backend->doOperation( array( 'op' => 'delete', 'src' => $file ) );
1817                 }
1818
1819                 $iter = $this->backend->getDirectoryList( array( 'dir' => "$base/unittest-cont1/not/exists" ) );
1820                 foreach ( $iter as $iter ) {} // no errors
1821         }
1822
1823         public function testLockCalls() {
1824                 $this->backend = $this->singleBackend;
1825                 $this->doTestLockCalls();
1826         }
1827
1828         private function doTestLockCalls() {
1829                 $backendName = $this->backendClass();
1830
1831                 for ( $i=0; $i<50; $i++ ) {
1832                         $paths = array(
1833                                 "test1.txt",
1834                                 "test2.txt",
1835                                 "test3.txt",
1836                                 "subdir1",
1837                                 "subdir1", // duplicate
1838                                 "subdir1/test1.txt",
1839                                 "subdir1/test2.txt",
1840                                 "subdir2",
1841                                 "subdir2", // duplicate
1842                                 "subdir2/test3.txt",
1843                                 "subdir2/test4.txt",
1844                                 "subdir2/subdir",
1845                                 "subdir2/subdir/test1.txt",
1846                                 "subdir2/subdir/test2.txt",
1847                                 "subdir2/subdir/test3.txt",
1848                                 "subdir2/subdir/test4.txt",
1849                                 "subdir2/subdir/test5.txt",
1850                                 "subdir2/subdir/sub",
1851                                 "subdir2/subdir/sub/test0.txt",
1852                                 "subdir2/subdir/sub/120-px-file.txt",
1853                         );
1854
1855                         $status = $this->backend->lockFiles( $paths, LockManager::LOCK_EX );
1856                         $this->assertEquals( array(), $status->errors,
1857                                 "Locking of files succeeded ($backendName)." );
1858                         $this->assertEquals( true, $status->isOK(),
1859                                 "Locking of files succeeded with OK status ($backendName)." );
1860
1861                         $status = $this->backend->lockFiles( $paths, LockManager::LOCK_SH );
1862                         $this->assertEquals( array(), $status->errors,
1863                                 "Locking of files succeeded ($backendName)." );
1864                         $this->assertEquals( true, $status->isOK(),
1865                                 "Locking of files succeeded with OK status ($backendName)." );
1866
1867                         $status = $this->backend->unlockFiles( $paths, LockManager::LOCK_SH );
1868                         $this->assertEquals( array(), $status->errors,
1869                                 "Locking of files succeeded ($backendName)." );
1870                         $this->assertEquals( true, $status->isOK(),
1871                                 "Locking of files succeeded with OK status ($backendName)." );
1872
1873                         $status = $this->backend->unlockFiles( $paths, LockManager::LOCK_EX );
1874                         $this->assertEquals( array(), $status->errors,
1875                                 "Locking of files succeeded ($backendName)." );
1876                         $this->assertEquals( true, $status->isOK(),
1877                                 "Locking of files succeeded with OK status ($backendName)." );
1878                 }
1879         }
1880
1881         // test helper wrapper for backend prepare() function
1882         private function prepare( array $params ) {
1883                 return $this->backend->prepare( $params );
1884         }
1885
1886         // test helper wrapper for backend prepare() function
1887         private function create( array $params ) {
1888                 $params['op'] = 'create';
1889                 return $this->backend->doQuickOperations( array( $params ) );
1890         }
1891
1892         function tearDownFiles() {
1893                 foreach ( $this->filesToPrune as $file ) {
1894                         @unlink( $file );
1895                 }
1896                 $containers = array( 'unittest-cont1', 'unittest-cont2' );
1897                 foreach ( $containers as $container ) {
1898                         $this->deleteFiles( $container );
1899                 }
1900                 $this->filesToPrune = array();
1901         }
1902
1903         private function deleteFiles( $container ) {
1904                 $base = $this->baseStorePath();
1905                 $iter = $this->backend->getFileList( array( 'dir' => "$base/$container" ) );
1906                 if ( $iter ) {
1907                         foreach ( $iter as $file ) {
1908                                 $this->backend->quickDelete( array( 'src' => "$base/$container/$file" ) );
1909                         }
1910                 }
1911                 $this->backend->clean( array( 'dir' => "$base/$container", 'recursive' => 1 ) );
1912         }
1913
1914         function assertBackendPathsConsistent( array $paths ) {
1915                 if ( $this->backend instanceof FileBackendMultiWrite ) {
1916                         $status = $this->backend->consistencyCheck( $paths );
1917                         $this->assertGoodStatus( $status, "Files synced: " . implode( ',', $paths ) );
1918                 }
1919         }
1920
1921         function assertGoodStatus( $status, $msg ) {
1922                 $this->assertEquals( print_r( array(), 1 ), print_r( $status->errors, 1 ), $msg );
1923         }
1924
1925         function tearDown() {
1926                 parent::tearDown();
1927         }
1928 }