tests/unit/StorageEngineTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Tests;
   6
   7 use PhpMyAdmin\Cache;
   8 use PhpMyAdmin\Dbal\DatabaseInterface;
   9 use PhpMyAdmin\Engines\Bdb;
  10 use PhpMyAdmin\Engines\Berkeleydb;
  11 use PhpMyAdmin\Engines\Binlog;
  12 use PhpMyAdmin\Engines\Innobase;
  13 use PhpMyAdmin\Engines\Innodb;
  14 use PhpMyAdmin\Engines\Memory;
  15 use PhpMyAdmin\Engines\Merge;
  16 use PhpMyAdmin\Engines\MrgMyisam;
  17 use PhpMyAdmin\Engines\Myisam;
  18 use PhpMyAdmin\Engines\Ndbcluster;
  19 use PhpMyAdmin\Engines\Pbxt;
  20 use PhpMyAdmin\Engines\PerformanceSchema;
  21 use PhpMyAdmin\StorageEngine;
  22 use PhpMyAdmin\Tests\Stubs\DbiDummy;
  23 use PHPUnit\Framework\Attributes\CoversClass;
  24 use PHPUnit\Framework\Attributes\DataProvider;
  25
  26 use function json_encode;
  27
  28 #[CoversClass(StorageEngine::class)]
  29 class StorageEngineTest extends AbstractTestCase
  30 {
  31     protected DatabaseInterface $dbi;
  32
  33     protected DbiDummy $dummyDbi;
  34
  35     protected StorageEngine $object;
  36
  37     /**
  38      * Sets up the fixture, for example, opens a network connection.
  39      * This method is called before a test is executed.
  40      */
  41     protected function setUp(): void
  42     {
  43         parent::setUp();
  44
  45         $this->dummyDbi = $this->createDbiDummy();
  46         $this->dbi = $this->createDatabaseInterface($this->dummyDbi);
  47         DatabaseInterface::$instance = $this->dbi;
  48         $this->object = new StorageEngine('dummy');
  49     }
  50
  51     /**
  52      * Tears down the fixture, for example, closes a network connection.
  53      * This method is called after a test is executed.
  54      */
  55     protected function tearDown(): void
  56     {
  57         parent::tearDown();
  58
  59         unset($this->object);
  60     }
  61
  62     public function testGetStorageEngines(): void
  63     {
  64         self::assertSame(
  65             [
  66                 'dummy' => ['Engine' => 'dummy', 'Support' => 'YES', 'Comment' => 'dummy comment'],
  67                 'dummy2' => ['Engine' => 'dummy2', 'Support' => 'NO', 'Comment' => 'dummy2 comment'],
  68                 'FEDERATED' => [
  69                     'Engine' => 'FEDERATED',
  70                     'Support' => 'NO',
  71                     'Comment' => 'Federated MySQL storage engine',
  72                 ],
  73                 'Pbxt' => ['Engine' => 'Pbxt', 'Support' => 'NO', 'Comment' => 'Pbxt storage engine'],
  74             ],
  75             StorageEngine::getStorageEngines(),
  76         );
  77     }
  78
  79     public function testGetArray(): void
  80     {
  81         $actual = StorageEngine::getArray();
  82
  83         self::assertSame(
  84             ['dummy' => ['name' => 'dummy', 'comment' => 'dummy comment', 'is_default' => false]],
  85             $actual,
  86         );
  87     }
  88
  89     /**
  90      * Test for StorageEngine::getEngine
  91      *
  92      * @param string $expectedClass Class that should be selected
  93      * @param string $engineName    Engine name
  94      * @psalm-param class-string $expectedClass
  95      */
  96     #[DataProvider('providerGetEngine')]
  97     public function testGetEngine(string $expectedClass, string $engineName): void
  98     {
  99         $actual = StorageEngine::getEngine($engineName);
 100         self::assertInstanceOf($expectedClass, $actual);
 101     }
 102
 103     /**
 104      * Provider for testGetEngine
 105      *
 106      * @return mixed[]
 107      */
 108     public static function providerGetEngine(): array
 109     {
 110         return [
 111             [StorageEngine::class, 'unknown engine'],
 112             [Bdb::class, 'Bdb'],
 113             [Berkeleydb::class, 'Berkeleydb'],
 114             [Binlog::class, 'Binlog'],
 115             [Innobase::class, 'Innobase'],
 116             [Innodb::class, 'Innodb'],
 117             [Memory::class, 'Memory'],
 118             [Merge::class, 'Merge'],
 119             [MrgMyisam::class, 'Mrg_Myisam'],
 120             [Myisam::class, 'Myisam'],
 121             [Ndbcluster::class, 'Ndbcluster'],
 122             [Pbxt::class, 'Pbxt'],
 123             [PerformanceSchema::class, 'Performance_Schema'],
 124         ];
 125     }
 126
 127     /**
 128      * Test for isValid
 129      */
 130     public function testIsValid(): void
 131     {
 132         self::assertTrue(
 133             StorageEngine::isValid('PBMS'),
 134         );
 135         self::assertTrue(
 136             StorageEngine::isValid('dummy'),
 137         );
 138         self::assertTrue(
 139             StorageEngine::isValid('dummy2'),
 140         );
 141         self::assertFalse(
 142             StorageEngine::isValid('invalid'),
 143         );
 144     }
 145
 146     /**
 147      * Test for getPage
 148      */
 149     public function testGetPage(): void
 150     {
 151         self::assertSame(
 152             '',
 153             $this->object->getPage('Foo'),
 154         );
 155     }
 156
 157     /**
 158      * Test for getInfoPages
 159      */
 160     public function testGetInfoPages(): void
 161     {
 162         self::assertSame(
 163             [],
 164             $this->object->getInfoPages(),
 165         );
 166     }
 167
 168     /**
 169      * Test for getVariablesLikePattern
 170      */
 171     public function testGetVariablesLikePattern(): void
 172     {
 173         self::assertSame(
 174             '',
 175             $this->object->getVariablesLikePattern(),
 176         );
 177     }
 178
 179     /**
 180      * Test for getMysqlHelpPage
 181      */
 182     public function testGetMysqlHelpPage(): void
 183     {
 184         self::assertSame(
 185             'dummy-storage-engine',
 186             $this->object->getMysqlHelpPage(),
 187         );
 188     }
 189
 190     /**
 191      * Test for getVariables
 192      */
 193     public function testGetVariables(): void
 194     {
 195         self::assertSame(
 196             [],
 197             $this->object->getVariables(),
 198         );
 199     }
 200
 201     /**
 202      * Test for getSupportInformationMessage
 203      */
 204     public function testGetSupportInformationMessage(): void
 205     {
 206         self::assertSame(
 207             'dummy is available on this MySQL server.',
 208             $this->object->getSupportInformationMessage(),
 209         );
 210
 211         $this->object->support = 1;
 212         self::assertSame(
 213             'dummy has been disabled for this MySQL server.',
 214             $this->object->getSupportInformationMessage(),
 215         );
 216
 217         $this->object->support = 2;
 218         self::assertSame(
 219             'dummy is available on this MySQL server.',
 220             $this->object->getSupportInformationMessage(),
 221         );
 222
 223         $this->object->support = 3;
 224         self::assertSame(
 225             'dummy is the default storage engine on this MySQL server.',
 226             $this->object->getSupportInformationMessage(),
 227         );
 228     }
 229
 230     /**
 231      * Test for getComment
 232      */
 233     public function testGetComment(): void
 234     {
 235         self::assertSame(
 236             'dummy comment',
 237             $this->object->getComment(),
 238         );
 239     }
 240
 241     /**
 242      * Test for getTitle
 243      */
 244     public function testGetTitle(): void
 245     {
 246         self::assertSame(
 247             'dummy',
 248             $this->object->getTitle(),
 249         );
 250     }
 251
 252     /**
 253      * Test for resolveTypeSize
 254      */
 255     public function testResolveTypeSize(): void
 256     {
 257         self::assertEquals(
 258             [12, 'B'],
 259             $this->object->resolveTypeSize(12),
 260         );
 261     }
 262
 263     public function testHasMroongaEngine(): void
 264     {
 265         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_list\');', [
 266             [
 267                 (string) json_encode([]), // Fake result
 268             ],
 269         ]);
 270         self::assertTrue(StorageEngine::hasMroongaEngine());
 271         self::assertTrue(StorageEngine::hasMroongaEngine()); // Does not call any query
 272
 273         Cache::remove('storage-engine.mroonga.has.mroonga_command'); // Cache clear
 274
 275         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_list\');', false);
 276         self::assertFalse(StorageEngine::hasMroongaEngine());
 277
 278         $this->dummyDbi->assertAllQueriesConsumed();
 279     }
 280
 281     public function testGetMroongaLengths(): void
 282     {
 283         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_list\');', [
 284             [
 285                 // Partial
 286                 (string) json_encode([
 287                     'WGS84GeoPoint' => [
 288                         'id' => 18,
 289                         'name' => 'WGS84GeoPoint',
 290                         'opened' => true,
 291                         'n_elements' => 4,
 292                         'type' => ['id' => 32, 'name' => 'type'],
 293                         'flags' => ['value' => 24, 'names' => 'KEY_GEO_POINT'],
 294                         'path' => null,
 295                         'size' => 8,
 296                     ],
 297                     'mroonga_operations' => ['type' => ['id' => 51, 'name' => 'table:no_key']],
 298                     'mroonga_operations.type' => ['type' => ['id' => 65, 'name' => 'column:var_size']],
 299                     'mroonga_operations.table' => ['type' => ['id' => 65, 'name' => 'column:var_size']],
 300                     'mroonga_operations.record' => ['type' => ['id' => 64, 'name' => 'column:fix_size']],
 301                     'idx_correo' => ['type' => ['id' => 49, 'name' => 'table:pat_key']],
 302                     'idx_correo.id' => ['type' => ['id' => 64, 'name' => 'column:fix_size']],
 303                     'idx_correo.search' => ['type' => ['id' => 65, 'name' => 'column:var_size']],
 304                     'idx_correo#idx_correo_search' => ['type' => ['id' => 49, 'name' => 'table:pat_key']],
 305                     'idx_correo#idx_correo_search.index' => ['type' => ['id' => 72, 'name' => 'column:index']],
 306                 ]),
 307             ],
 308         ]);
 309         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_inspect idx_correo\');', [
 310             [
 311                 // Partial
 312                 (string) json_encode([
 313                     'id' => 265,
 314                     'name' => 'idx_correo',
 315                     'type' => ['id' => 49, 'name' => 'table:pat_key'],
 316                     'key' => [
 317                         'type' => ['id' => 8, 'name' => 'Int32', 'type' => ['id' => 32,'name' => 'type'], 'size' => 4],
 318                         'total_size' => 0,
 319                         'max_total_size' => 4294967294,
 320                     ],
 321                     'value' => ['type' => null],
 322                     'n_records' => 0,
 323                     'disk_usage' => 4243456,
 324                 ]),
 325             ],
 326         ]);
 327         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_inspect idx_correo.id\');', [
 328             [
 329                 // Full object
 330                 (string) json_encode([
 331                     'id' => 266,
 332                     'name' => 'id',
 333                     'table' => [
 334                         'id' => 265,
 335                         'name' => 'idx_correo',
 336                         'type' => ['id' => 49, 'name' => 'table:pat_key'],
 337                         'key' => [
 338                             'type' => [
 339                                 'id' => 8,
 340                                 'name' => 'Int32',
 341                                 'type' => ['id' => 32, 'name' => 'type'],
 342                                 'size' => 4,
 343                             ],
 344                             'total_size' => 0,
 345                             'max_total_size' => 4294967294,
 346                         ],
 347                         'value' => ['type' => null],
 348                         'n_records' => 0,
 349                         'disk_usage' => 4243456,
 350                     ],
 351                     'full_name' => 'idx_correo.id',
 352                     'type' => ['name' => 'scalar', 'raw' => ['id' => 64, 'name' => 'column:fix_size']],
 353                     'value' => [
 354                         'type' => ['id' => 8, 'name' => 'Int32', 'type' => ['id' => 32,'name' => 'type'], 'size' => 4],
 355                         'compress' => null,
 356                     ],
 357                     'disk_usage' => 4096,
 358                 ]),
 359             ],
 360         ]);
 361         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_inspect idx_correo.search\');', [
 362             [
 363                 // Full object
 364                 (string) json_encode([
 365                     'id' => 267,
 366                     'name' => 'search',
 367                     'table' => [
 368                         'id' => 265,
 369                         'name' => 'idx_correo',
 370                         'type' => ['id' => 49, 'name' => 'table:pat_key'],
 371                         'key' => [
 372                             'type' => [
 373                                 'id' => 8,
 374                                 'name' => 'Int32',
 375                                 'type' => ['id' => 32, 'name' => 'type'],
 376                                 'size' => 4,
 377                             ],
 378                             'total_size' => 0,
 379                             'max_total_size' => 4294967294,
 380                         ],
 381                         'value' => ['type' => null],
 382                         'n_records' => 0,
 383                         'disk_usage' => 4243456,
 384                     ],
 385                     'full_name' => 'idx_correo.search',
 386                     'type' => ['name' => 'scalar', 'raw' => ['id' => 65, 'name' => 'column:var_size']],
 387                     'value' => [
 388                         'type' => [
 389                             'id' => 16,
 390                             'name' => 'LongText',
 391                             'type' => ['id' => 32, 'name' => 'type'],
 392                             'size' => 2147483648,
 393                         ],
 394                         'compress' => null,
 395                     ],
 396                     'disk_usage' => 274432,
 397                 ]),
 398             ],
 399         ]);
 400         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_inspect idx_correo#idx_correo_search\');', [
 401             [
 402                 // Partial
 403                 (string) json_encode([
 404                     'id' => 268,
 405                     'name' => 'idx_correo#idx_correo_search',
 406                     'type' => ['id' => 49, 'name' => 'table:pat_key'],
 407                     'key' => [
 408                         'type' => [
 409                             'id' => 14,
 410                             'name' => 'ShortText',
 411                             'type' => ['id' => 32, 'name' => 'type'],
 412                             'size' => 4096,
 413                         ],
 414                         'total_size' => 0,
 415                         'max_total_size' => 4294967294,
 416                     ],
 417                     'value' => ['type' => null],
 418                     'n_records' => 0,
 419                     'disk_usage' => 12878,
 420                 ]),
 421             ],
 422         ]);
 423         $this->dummyDbi->addResult('SELECT mroonga_command(\'object_inspect idx_correo#idx_correo_search.index\');', [
 424             [
 425                 // Full object
 426                 (string) json_encode([
 427                     'id' => 269,
 428                     'name' => 'index',
 429                     'table' => [
 430                         'id' => 268,
 431                         'name' => 'idx_correo#idx_correo_search',
 432                         'type' => ['id' => 49, 'name' => 'table:pat_key'],
 433                         'key' => [
 434                             'type' => [
 435                                 'id' => 14,
 436                                 'name' => 'ShortText',
 437                                 'type' => ['id' => 32, 'name' => 'type'],
 438                                 'size' => 4096,
 439                             ],
 440                             'total_size' => 0,
 441                             'max_total_size' => 4294967294,
 442                         ],
 443                         'value' => ['type' => null],
 444                         'n_records' => 0,
 445                         'disk_usage' => 4243456,
 446                     ],
 447                     'full_name' => 'idx_correo#idx_correo_search.index',
 448                     'type' => ['name' => 'index', 'raw' => ['id' => 72, 'name' => 'column:index']],
 449                     'value' => [
 450                         'type' => [
 451                             'id' => 265,
 452                             'name' => 'idx_correo',
 453                             'type' => ['id' => 49, 'name' => 'table:pat_key'],
 454                             'size' => 4,
 455                         ],
 456                         'section' => false,
 457                         'weight' => false,
 458                         'position' => true,
 459                         'size' => 'normal',
 460                         'statistics' => [
 461                             'max_section_id' => 0,
 462                             'n_garbage_segments' => 0,
 463                             'max_array_segment_id' => 0,
 464                             'n_array_segments' => 0,
 465                             'max_buffer_segment_id' => 0,
 466                             'n_buffer_segments' => 0,
 467                             'max_in_use_physical_segment_id' => 0,
 468                             'n_unmanaged_segments' => 0,
 469                             'total_chunk_size' => 0,
 470                             'max_in_use_chunk_id' => 0,
 471                             'n_garbage_chunks' => [
 472                                 0,
 473                                 0,
 474                                 0,
 475                                 0,
 476                                 0,
 477                                 0,
 478                                 0,
 479                                 0,
 480                                 0,
 481                                 0,
 482                                 0,
 483                                 0,
 484                                 0,
 485                                 0,
 486                                 0,
 487                             ],
 488                         ],
 489                     ],
 490                     'sources' => [
 491                         [
 492                             'id' => 267,
 493                             'name' => 'search',
 494                             'table' => [
 495                                 'id' => 265,
 496                                 'name' => 'idx_correo',
 497                                 'type' => ['id' => 49, 'name' => 'table:pat_key'],
 498                                 'key' => [
 499                                     'type' => [
 500                                         'id' => 8,
 501                                         'name' => 'Int32',
 502                                         'type' => ['id' => 32, 'name' => 'type'],
 503                                         'size' => 4,
 504                                     ],
 505                                     'total_size' => 0,
 506                                     'max_total_size' => 4294967294,
 507                                 ],
 508                                 'value' => ['type' => null],
 509                                 'n_records' => 0,
 510                                 'disk_usage' => 4243456,
 511                             ],
 512                             'full_name' => 'idx_correo.search',
 513                         ],
 514                     ],
 515                     'disk_usage' => 565248,
 516                 ]),
 517             ],
 518         ]);
 519
 520         $this->dummyDbi->addSelectDb('my_db');
 521         $lengths = StorageEngine::getMroongaLengths('my_db', 'idx_correo');
 522         $this->dummyDbi->assertAllSelectsConsumed();
 523         self::assertSame([4521984, 578126], $lengths);
 524
 525         $this->dummyDbi->assertAllQueriesConsumed();
 526     }
 527 }