tests/phpunit/includes/Storage/SqlBlobStoreTest.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Storage;
   4
   5 use Language;
   6 use MediaWiki\MediaWikiServices;
   7 use MediaWiki\Storage\SqlBlobStore;
   8 use MediaWikiTestCase;
   9 use stdClass;
  10 use TitleValue;
  11
  12 /**
  13  * @covers \MediaWiki\Storage\SqlBlobStore
  14  * @group Database
  15  */
  16 class SqlBlobStoreTest extends MediaWikiTestCase {
  17
  18         /**
  19          * @return SqlBlobStore
  20          */
  21         public function getBlobStore( $legacyEncoding = false, $compressRevisions = false ) {
  22                 $services = MediaWikiServices::getInstance();
  23
  24                 $store = new SqlBlobStore(
  25                         $services->getDBLoadBalancer(),
  26                         $services->getMainWANObjectCache()
  27                 );
  28
  29                 if ( $compressRevisions ) {
  30                         $store->setCompressBlobs( $compressRevisions );
  31                 }
  32                 if ( $legacyEncoding ) {
  33                         $store->setLegacyEncoding( $legacyEncoding, Language::factory( 'en' ) );
  34                 }
  35
  36                 return $store;
  37         }
  38
  39         /**
  40          * @covers \MediaWiki\Storage\SqlBlobStore::getCompressBlobs()
  41          * @covers \MediaWiki\Storage\SqlBlobStore::setCompressBlobs()
  42          */
  43         public function testGetSetCompressRevisions() {
  44                 $store = $this->getBlobStore();
  45                 $this->assertFalse( $store->getCompressBlobs() );
  46                 $store->setCompressBlobs( true );
  47                 $this->assertTrue( $store->getCompressBlobs() );
  48         }
  49
  50         /**
  51          * @covers \MediaWiki\Storage\SqlBlobStore::getLegacyEncoding()
  52          * @covers \MediaWiki\Storage\SqlBlobStore::getLegacyEncodingConversionLang()
  53          * @covers \MediaWiki\Storage\SqlBlobStore::setLegacyEncoding()
  54          */
  55         public function testGetSetLegacyEncoding() {
  56                 $store = $this->getBlobStore();
  57                 $this->assertFalse( $store->getLegacyEncoding() );
  58                 $this->assertNull( $store->getLegacyEncodingConversionLang() );
  59                 $en = Language::factory( 'en' );
  60                 $store->setLegacyEncoding( 'foo', $en );
  61                 $this->assertSame( 'foo', $store->getLegacyEncoding() );
  62                 $this->assertSame( $en, $store->getLegacyEncodingConversionLang() );
  63         }
  64
  65         /**
  66          * @covers \MediaWiki\Storage\SqlBlobStore::getCacheExpiry()
  67          * @covers \MediaWiki\Storage\SqlBlobStore::setCacheExpiry()
  68          */
  69         public function testGetSetCacheExpiry() {
  70                 $store = $this->getBlobStore();
  71                 $this->assertSame( 604800, $store->getCacheExpiry() );
  72                 $store->setCacheExpiry( 12 );
  73                 $this->assertSame( 12, $store->getCacheExpiry() );
  74         }
  75
  76         /**
  77          * @covers \MediaWiki\Storage\SqlBlobStore::getUseExternalStore()
  78          * @covers \MediaWiki\Storage\SqlBlobStore::setUseExternalStore()
  79          */
  80         public function testGetSetUseExternalStore() {
  81                 $store = $this->getBlobStore();
  82                 $this->assertFalse( $store->getUseExternalStore() );
  83                 $store->setUseExternalStore( true );
  84                 $this->assertTrue( $store->getUseExternalStore() );
  85         }
  86
  87         public function provideDecompress() {
  88                 yield '(no legacy encoding), false in false out' => [ false, false, [], false ];
  89                 yield '(no legacy encoding), empty in empty out' => [ false, '', [], '' ];
  90                 yield '(no legacy encoding), empty in empty out' => [ false, 'A', [], 'A' ];
  91                 yield '(no legacy encoding), string in with gzip flag returns string' => [
  92                         // gzip string below generated with gzdeflate( 'AAAABBAAA' )
  93                         false, "sttttr\002\022\000", [ 'gzip' ], 'AAAABBAAA',
  94                 ];
  95                 yield '(no legacy encoding), string in with object flag returns false' => [
  96                         // gzip string below generated with serialize( 'JOJO' )
  97                         false, "s:4:\"JOJO\";", [ 'object' ], false,
  98                 ];
  99                 yield '(no legacy encoding), serialized object in with object flag returns string' => [
 100                         false,
 101                         // Using a TitleValue object as it has a getText method (which is needed)
 102                         serialize( new TitleValue( 0, 'HHJJDDFF' ) ),
 103                         [ 'object' ],
 104                         'HHJJDDFF',
 105                 ];
 106                 yield '(no legacy encoding), serialized object in with object & gzip flag returns string' => [
 107                         false,
 108                         // Using a TitleValue object as it has a getText method (which is needed)
 109                         gzdeflate( serialize( new TitleValue( 0, '8219JJJ840' ) ) ),
 110                         [ 'object', 'gzip' ],
 111                         '8219JJJ840',
 112                 ];
 113                 yield '(ISO-8859-1 encoding), string in string out' => [
 114                         'ISO-8859-1',
 115                         iconv( 'utf-8', 'ISO-8859-1', "1®Àþ1" ),
 116                         [],
 117                         '1®Àþ1',
 118                 ];
 119                 yield '(ISO-8859-1 encoding), serialized object in with gzip flags returns string' => [
 120                         'ISO-8859-1',
 121                         gzdeflate( iconv( 'utf-8', 'ISO-8859-1', "4®Àþ4" ) ),
 122                         [ 'gzip' ],
 123                         '4®Àþ4',
 124                 ];
 125                 yield '(ISO-8859-1 encoding), serialized object in with object flags returns string' => [
 126                         'ISO-8859-1',
 127                         serialize( new TitleValue( 0, iconv( 'utf-8', 'ISO-8859-1', "3®Àþ3" ) ) ),
 128                         [ 'object' ],
 129                         '3®Àþ3',
 130                 ];
 131                 yield '(ISO-8859-1 encoding), serialized object in with object & gzip flags returns string' => [
 132                         'ISO-8859-1',
 133                         gzdeflate( serialize( new TitleValue( 0, iconv( 'utf-8', 'ISO-8859-1', "2®Àþ2" ) ) ) ),
 134                         [ 'gzip', 'object' ],
 135                         '2®Àþ2',
 136                 ];
 137         }
 138
 139         /**
 140          * @dataProvider provideDecompress
 141          * @covers \MediaWiki\Storage\SqlBlobStore::decompressData
 142          *
 143          * @param string|bool $legacyEncoding
 144          * @param mixed $data
 145          * @param array $flags
 146          * @param mixed $expected
 147          */
 148         public function testDecompressData( $legacyEncoding, $data, $flags, $expected ) {
 149                 $store = $this->getBlobStore( $legacyEncoding );
 150                 $this->assertSame(
 151                         $expected,
 152                         $store->decompressData( $data, $flags )
 153                 );
 154         }
 155
 156         /**
 157          * @covers \MediaWiki\Storage\SqlBlobStore::compressData
 158          */
 159         public function testCompressRevisionTextUtf8() {
 160                 $store = $this->getBlobStore();
 161                 $row = new stdClass;
 162                 $row->old_text = "Wiki est l'\xc3\xa9cole superieur !";
 163                 $row->old_flags = $store->compressData( $row->old_text );
 164                 $this->assertTrue( false !== strpos( $row->old_flags, 'utf-8' ),
 165                         "Flags should contain 'utf-8'" );
 166                 $this->assertFalse( false !== strpos( $row->old_flags, 'gzip' ),
 167                         "Flags should not contain 'gzip'" );
 168                 $this->assertEquals( "Wiki est l'\xc3\xa9cole superieur !",
 169                         $row->old_text, "Direct check" );
 170         }
 171
 172         /**
 173          * @covers \MediaWiki\Storage\SqlBlobStore::compressData
 174          */
 175         public function testCompressRevisionTextUtf8Gzip() {
 176                 $store = $this->getBlobStore( false, true );
 177                 $this->checkPHPExtension( 'zlib' );
 178
 179                 $row = new stdClass;
 180                 $row->old_text = "Wiki est l'\xc3\xa9cole superieur !";
 181                 $row->old_flags = $store->compressData( $row->old_text );
 182                 $this->assertTrue( false !== strpos( $row->old_flags, 'utf-8' ),
 183                         "Flags should contain 'utf-8'" );
 184                 $this->assertTrue( false !== strpos( $row->old_flags, 'gzip' ),
 185                         "Flags should contain 'gzip'" );
 186                 $this->assertEquals( "Wiki est l'\xc3\xa9cole superieur !",
 187                         gzinflate( $row->old_text ), "Direct check" );
 188         }
 189
 190         public function provideBlobs() {
 191                 yield [ '' ];
 192                 yield [ 'someText' ];
 193         }
 194
 195         /**
 196          * @dataProvider provideBlobs
 197          * @covers \MediaWiki\Storage\SqlBlobStore::storeBlob
 198          * @covers \MediaWiki\Storage\SqlBlobStore::getBlob
 199          */
 200         public function testSimpleStoreGetBlobSimpleRoundtrip( $blob ) {
 201                 $store = $this->getBlobStore();
 202                 $address = $store->storeBlob( $blob );
 203                 $this->assertSame( $blob, $store->getBlob( $address ) );
 204         }
 205
 206 }