tests/classes/TypesTest.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Tests;
   6
   7 use PhpMyAdmin\DatabaseInterface;
   8 use PhpMyAdmin\Types;
   9 use PHPUnit\Framework\Attributes\CoversClass;
  10 use PHPUnit\Framework\Attributes\DataProvider;
  11
  12 #[CoversClass(Types::class)]
  13 class TypesTest extends AbstractTestCase
  14 {
  15     protected Types $object;
  16
  17     /**
  18      * Sets up the fixture, for example, opens a network connection.
  19      * This method is called before a test is executed.
  20      */
  21     protected function setUp(): void
  22     {
  23         parent::setUp();
  24
  25         DatabaseInterface::$instance = $this->createDatabaseInterface();
  26         $this->object = new Types(DatabaseInterface::getInstance());
  27     }
  28
  29     /**
  30      * Test for isUnaryOperator
  31      */
  32     public function testUnary(): void
  33     {
  34         $this->assertTrue($this->object->isUnaryOperator('IS NULL'));
  35         $this->assertFalse($this->object->isUnaryOperator('='));
  36     }
  37
  38     /**
  39      * Test for getUnaryOperators
  40      */
  41     public function testGetUnaryOperators(): void
  42     {
  43         $this->assertEquals(
  44             ['IS NULL', 'IS NOT NULL', "= ''", "!= ''"],
  45             $this->object->getUnaryOperators(),
  46         );
  47     }
  48
  49     /**
  50      * Test for getNullOperators
  51      */
  52     public function testGetNullOperators(): void
  53     {
  54         $this->assertEquals(
  55             ['IS NULL', 'IS NOT NULL'],
  56             $this->object->getNullOperators(),
  57         );
  58     }
  59
  60     /**
  61      * Test for getEnumOperators
  62      */
  63     public function testGetEnumOperators(): void
  64     {
  65         $this->assertEquals(
  66             ['=', '!='],
  67             $this->object->getEnumOperators(),
  68         );
  69     }
  70
  71     /**
  72      * Test for getTextOperators
  73      */
  74     public function testgetTextOperators(): void
  75     {
  76         $this->assertEquals(
  77             [
  78                 'LIKE',
  79                 'LIKE %...%',
  80                 'NOT LIKE',
  81                 'NOT LIKE %...%',
  82                 '=',
  83                 '!=',
  84                 'REGEXP',
  85                 'REGEXP ^...$',
  86                 'NOT REGEXP',
  87                 "= ''",
  88                 "!= ''",
  89                 'IN (...)',
  90                 'NOT IN (...)',
  91                 'BETWEEN',
  92                 'NOT BETWEEN',
  93             ],
  94             $this->object->getTextOperators(),
  95         );
  96     }
  97
  98     /**
  99      * Test for getNumberOperators
 100      */
 101     public function testGetNumberOperators(): void
 102     {
 103         $this->assertEquals(
 104             [
 105                 '=',
 106                 '>',
 107                 '>=',
 108                 '<',
 109                 '<=',
 110                 '!=',
 111                 'LIKE',
 112                 'LIKE %...%',
 113                 'NOT LIKE',
 114                 'NOT LIKE %...%',
 115                 'IN (...)',
 116                 'NOT IN (...)',
 117                 'BETWEEN',
 118                 'NOT BETWEEN',
 119             ],
 120             $this->object->getNumberOperators(),
 121         );
 122     }
 123
 124     /**
 125      * Test for getUUIDOperators
 126      */
 127     public function testGetUUIDOperators(): void
 128     {
 129         $this->assertEquals(
 130             ['=', '!=', 'LIKE', 'LIKE %...%', 'NOT LIKE', 'NOT LIKE %...%', 'IN (...)', 'NOT IN (...)'],
 131             $this->object->getUUIDOperators(),
 132         );
 133     }
 134
 135     /**
 136      * Test for getting type operators
 137      *
 138      * @param string          $type   Type of field
 139      * @param bool            $null   Whether field can be NULL
 140      * @param string|string[] $output Expected output
 141      */
 142     #[DataProvider('providerForGetTypeOperators')]
 143     public function testGetTypeOperators(string $type, bool $null, string|array $output): void
 144     {
 145         $this->assertEquals(
 146             $output,
 147             $this->object->getTypeOperators($type, $null),
 148         );
 149     }
 150
 151     /**
 152      * data provider for testGetTypeOperators
 153      *
 154      * @return array<array{string, bool, string|string[]}>
 155      */
 156     public static function providerForGetTypeOperators(): array
 157     {
 158         return [
 159             ['enum', false, ['=', '!=']],
 160             [
 161                 'CHAR',
 162                 true,
 163                 [
 164                     'LIKE',
 165                     'LIKE %...%',
 166                     'NOT LIKE',
 167                     'NOT LIKE %...%',
 168                     '=',
 169                     '!=',
 170                     'REGEXP',
 171                     'REGEXP ^...$',
 172                     'NOT REGEXP',
 173                     '= \'\'',
 174                     '!= \'\'',
 175                     'IN (...)',
 176                     'NOT IN (...)',
 177                     'BETWEEN',
 178                     'NOT BETWEEN',
 179                     'IS NULL',
 180                     'IS NOT NULL',
 181                 ],
 182             ],
 183             [
 184                 'int',
 185                 false,
 186                 [
 187                     '=',
 188                     '>',
 189                     '>=',
 190                     '<',
 191                     '<=',
 192                     '!=',
 193                     'LIKE',
 194                     'LIKE %...%',
 195                     'NOT LIKE',
 196                     'NOT LIKE %...%',
 197                     'IN (...)',
 198                     'NOT IN (...)',
 199                     'BETWEEN',
 200                     'NOT BETWEEN',
 201                 ],
 202             ],
 203             [
 204                 'UUID',
 205                 false,
 206                 ['=', '!=', 'LIKE', 'LIKE %...%', 'NOT LIKE', 'NOT LIKE %...%', 'IN (...)', 'NOT IN (...)'],
 207             ],
 208             [
 209                 'UUID',
 210                 true,
 211                 [
 212                     '=',
 213                     '!=',
 214                     'LIKE',
 215                     'LIKE %...%',
 216                     'NOT LIKE',
 217                     'NOT LIKE %...%',
 218                     'IN (...)',
 219                     'NOT IN (...)',
 220                     'IS NULL',
 221                     'IS NOT NULL',
 222                 ],
 223             ],
 224         ];
 225     }
 226
 227     /**
 228      * Test for getTypeOperatorsHtml
 229      *
 230      * @param string $type             Type of field
 231      * @param bool   $null             Whether field can be NULL
 232      * @param string $selectedOperator Option to be selected
 233      * @param string $output           Expected output
 234      */
 235     #[DataProvider('providerForTestGetTypeOperatorsHtml')]
 236     public function testGetTypeOperatorsHtml(
 237         string $type,
 238         bool $null,
 239         string $selectedOperator,
 240         string $output,
 241     ): void {
 242         $this->assertEquals(
 243             $output,
 244             $this->object->getTypeOperatorsHtml($type, $null, $selectedOperator),
 245         );
 246     }
 247
 248     /**
 249      * Provider for testGetTypeOperatorsHtml
 250      *
 251      * @return array<array{string, bool, string, string}>
 252      */
 253     public static function providerForTestGetTypeOperatorsHtml(): array
 254     {
 255         return [
 256             ['enum', false, '=', '<option value="=" selected="selected">=</option><option value="!=">!=</option>'],
 257         ];
 258     }
 259
 260     /**
 261      * Test for getTypeDescription
 262      *
 263      * @param string $type The data type to get a description.
 264      */
 265     #[DataProvider('providerForTestGetTypeDescription')]
 266     public function testGetTypeDescription(string $type): void
 267     {
 268         $this->assertNotEquals(
 269             '',
 270             $this->object->getTypeDescription($type),
 271         );
 272     }
 273
 274     /**
 275      * Test for getTypeDescription with unknown value
 276      */
 277     public function testGetUnknownTypeDescription(): void
 278     {
 279         $this->assertEquals(
 280             '',
 281             $this->object->getTypeDescription('UNKNOWN'),
 282         );
 283     }
 284
 285     /**
 286      * Provider for testGetTypeDescription
 287      *
 288      * @return array<array{string}>
 289      */
 290     public static function providerForTestGetTypeDescription(): array
 291     {
 292         return [
 293             ['TINYINT'],
 294             ['SMALLINT'],
 295             ['MEDIUMINT'],
 296             ['INT'],
 297             ['BIGINT'],
 298             ['DECIMAL'],
 299             ['FLOAT'],
 300             ['DOUBLE'],
 301             ['REAL'],
 302             ['BIT'],
 303             ['BOOLEAN'],
 304             ['SERIAL'],
 305             ['DATE'],
 306             ['DATETIME'],
 307             ['TIMESTAMP'],
 308             ['TIME'],
 309             ['YEAR'],
 310             ['CHAR'],
 311             ['VARCHAR'],
 312             ['TINYTEXT'],
 313             ['TEXT'],
 314             ['MEDIUMTEXT'],
 315             ['LONGTEXT'],
 316             ['BINARY'],
 317             ['VARBINARY'],
 318             ['TINYBLOB'],
 319             ['MEDIUMBLOB'],
 320             ['BLOB'],
 321             ['LONGBLOB'],
 322             ['ENUM'],
 323             ['SET'],
 324             ['GEOMETRY'],
 325             ['POINT'],
 326             ['LINESTRING'],
 327             ['POLYGON'],
 328             ['MULTIPOINT'],
 329             ['MULTILINESTRING'],
 330             ['MULTIPOLYGON'],
 331             ['GEOMETRYCOLLECTION'],
 332             ['JSON'],
 333             ['INET6'],
 334             ['UUID'],
 335         ];
 336     }
 337
 338     /**
 339      * @param string   $class  The class to get function list.
 340      * @param string[] $output Expected function list
 341      */
 342     #[DataProvider('providerFortTestGetFunctionsClass')]
 343     public function testGetFunctionsClass(string $class, array $output): void
 344     {
 345         $this->assertEquals(
 346             $output,
 347             $this->object->getFunctionsClass($class),
 348         );
 349     }
 350
 351     /** @return array<array{string, string[]}> */
 352     public static function providerFortTestGetFunctionsClass(): array
 353     {
 354         return [
 355             [
 356                 'CHAR',
 357                 [
 358                     'AES_DECRYPT',
 359                     'AES_ENCRYPT',
 360                     'BIN',
 361                     'CHAR',
 362                     'COMPRESS',
 363                     'CURRENT_USER',
 364                     'DATABASE',
 365                     'DAYNAME',
 366                     'DES_DECRYPT',
 367                     'DES_ENCRYPT',
 368                     'ENCRYPT',
 369                     'HEX',
 370                     'INET6_NTOA',
 371                     'INET_NTOA',
 372                     'LOAD_FILE',
 373                     'LOWER',
 374                     'LTRIM',
 375                     'MD5',
 376                     'MONTHNAME',
 377                     'OLD_PASSWORD',
 378                     'PASSWORD',
 379                     'QUOTE',
 380                     'REVERSE',
 381                     'RTRIM',
 382                     'SHA1',
 383                     'SHA2',
 384                     'SOUNDEX',
 385                     'SPACE',
 386                     'TRIM',
 387                     'UNCOMPRESS',
 388                     'UNHEX',
 389                     'UPPER',
 390                     'USER',
 391                     'UUID',
 392                     'VERSION',
 393                 ],
 394             ],
 395             [
 396                 'DATE',
 397                 [
 398                     'CURRENT_DATE',
 399                     'CURRENT_TIME',
 400                     'DATE',
 401                     'FROM_DAYS',
 402                     'FROM_UNIXTIME',
 403                     'LAST_DAY',
 404                     'NOW',
 405                     'SEC_TO_TIME',
 406                     'SYSDATE',
 407                     'TIME',
 408                     'TIMESTAMP',
 409                     'UTC_DATE',
 410                     'UTC_TIME',
 411                     'UTC_TIMESTAMP',
 412                     'YEAR',
 413                 ],
 414             ],
 415             [
 416                 'SPATIAL',
 417                 [
 418                     'ST_GeomFromText',
 419                     'ST_GeomFromWKB',
 420
 421                     'ST_GeomCollFromText',
 422                     'ST_LineFromText',
 423                     'ST_MLineFromText',
 424                     'ST_PointFromText',
 425                     'ST_MPointFromText',
 426                     'ST_PolyFromText',
 427                     'ST_MPolyFromText',
 428
 429                     'ST_GeomCollFromWKB',
 430                     'ST_LineFromWKB',
 431                     'ST_MLineFromWKB',
 432                     'ST_PointFromWKB',
 433                     'ST_MPointFromWKB',
 434                     'ST_PolyFromWKB',
 435                     'ST_MPolyFromWKB',
 436                 ],
 437             ],
 438             [
 439                 'NUMBER',
 440                 [
 441                     'ABS',
 442                     'ACOS',
 443                     'ASCII',
 444                     'ASIN',
 445                     'ATAN',
 446                     'BIT_LENGTH',
 447                     'BIT_COUNT',
 448                     'CEILING',
 449                     'CHAR_LENGTH',
 450                     'CONNECTION_ID',
 451                     'COS',
 452                     'COT',
 453                     'CRC32',
 454                     'DAYOFMONTH',
 455                     'DAYOFWEEK',
 456                     'DAYOFYEAR',
 457                     'DEGREES',
 458                     'EXP',
 459                     'FLOOR',
 460                     'HOUR',
 461                     'INET6_ATON',
 462                     'INET_ATON',
 463                     'LENGTH',
 464                     'LN',
 465                     'LOG',
 466                     'LOG2',
 467                     'LOG10',
 468                     'MICROSECOND',
 469                     'MINUTE',
 470                     'MONTH',
 471                     'OCT',
 472                     'ORD',
 473                     'PI',
 474                     'QUARTER',
 475                     'RADIANS',
 476                     'RAND',
 477                     'ROUND',
 478                     'SECOND',
 479                     'SIGN',
 480                     'SIN',
 481                     'SQRT',
 482                     'TAN',
 483                     'TO_DAYS',
 484                     'TO_SECONDS',
 485                     'TIME_TO_SEC',
 486                     'UNCOMPRESSED_LENGTH',
 487                     'UNIX_TIMESTAMP',
 488                     'UUID_SHORT',
 489                     'WEEK',
 490                     'WEEKDAY',
 491                     'WEEKOFYEAR',
 492                     'YEARWEEK',
 493                 ],
 494             ],
 495             ['UNKNOWN', []],
 496         ];
 497     }
 498
 499     /**
 500      * Test for getFunctions
 501      */
 502     public function testGetFunctions(): void
 503     {
 504         $this->assertEquals(
 505             [
 506                 'AES_DECRYPT',
 507                 'AES_ENCRYPT',
 508                 'BIN',
 509                 'CHAR',
 510                 'COMPRESS',
 511                 'CURRENT_USER',
 512                 'DATABASE',
 513                 'DAYNAME',
 514                 'DES_DECRYPT',
 515                 'DES_ENCRYPT',
 516                 'ENCRYPT',
 517                 'HEX',
 518                 'INET6_NTOA',
 519                 'INET_NTOA',
 520                 'LOAD_FILE',
 521                 'LOWER',
 522                 'LTRIM',
 523                 'MD5',
 524                 'MONTHNAME',
 525                 'OLD_PASSWORD',
 526                 'PASSWORD',
 527                 'QUOTE',
 528                 'REVERSE',
 529                 'RTRIM',
 530                 'SHA1',
 531                 'SHA2',
 532                 'SOUNDEX',
 533                 'SPACE',
 534                 'TRIM',
 535                 'UNCOMPRESS',
 536                 'UNHEX',
 537                 'UPPER',
 538                 'USER',
 539                 'UUID',
 540                 'VERSION',
 541             ],
 542             $this->object->getFunctions('enum'),
 543         );
 544     }
 545
 546     /**
 547      * Test for getAllFunctions
 548      */
 549     public function testGetAllFunctions(): void
 550     {
 551         $this->assertEquals(
 552             [
 553                 'ABS',
 554                 'ACOS',
 555                 'AES_DECRYPT',
 556                 'AES_ENCRYPT',
 557                 'ASCII',
 558                 'ASIN',
 559                 'ATAN',
 560                 'BIN',
 561                 'BIT_COUNT',
 562                 'BIT_LENGTH',
 563                 'CEILING',
 564                 'CHAR',
 565                 'CHAR_LENGTH',
 566                 'COMPRESS',
 567                 'CONNECTION_ID',
 568                 'COS',
 569                 'COT',
 570                 'CRC32',
 571                 'CURRENT_DATE',
 572                 'CURRENT_TIME',
 573                 'CURRENT_USER',
 574                 'DATABASE',
 575                 'DATE',
 576                 'DAYNAME',
 577                 'DAYOFMONTH',
 578                 'DAYOFWEEK',
 579                 'DAYOFYEAR',
 580                 'DEGREES',
 581                 'DES_DECRYPT',
 582                 'DES_ENCRYPT',
 583                 'ENCRYPT',
 584                 'EXP',
 585                 'FLOOR',
 586                 'FROM_DAYS',
 587                 'FROM_UNIXTIME',
 588                 'HEX',
 589                 'HOUR',
 590                 'INET6_ATON',
 591                 'INET6_NTOA',
 592                 'INET_ATON',
 593                 'INET_NTOA',
 594                 'LAST_DAY',
 595                 'LENGTH',
 596                 'LN',
 597                 'LOAD_FILE',
 598                 'LOG',
 599                 'LOG10',
 600                 'LOG2',
 601                 'LOWER',
 602                 'LTRIM',
 603                 'MD5',
 604                 'MICROSECOND',
 605                 'MINUTE',
 606                 'MONTH',
 607                 'MONTHNAME',
 608                 'NOW',
 609                 'OCT',
 610                 'OLD_PASSWORD',
 611                 'ORD',
 612                 'PASSWORD',
 613                 'PI',
 614                 'QUARTER',
 615                 'QUOTE',
 616                 'RADIANS',
 617                 'RAND',
 618                 'REVERSE',
 619                 'ROUND',
 620                 'RTRIM',
 621                 'SECOND',
 622                 'SEC_TO_TIME',
 623                 'SHA1',
 624                 'SHA2',
 625                 'SIGN',
 626                 'SIN',
 627                 'SOUNDEX',
 628                 'SPACE',
 629                 'SQRT',
 630                 'ST_GeomCollFromText',
 631                 'ST_GeomCollFromWKB',
 632                 'ST_GeomFromText',
 633                 'ST_GeomFromWKB',
 634                 'ST_LineFromText',
 635                 'ST_LineFromWKB',
 636                 'ST_MLineFromText',
 637                 'ST_MLineFromWKB',
 638                 'ST_MPointFromText',
 639                 'ST_MPointFromWKB',
 640                 'ST_MPolyFromText',
 641                 'ST_MPolyFromWKB',
 642                 'ST_PointFromText',
 643                 'ST_PointFromWKB',
 644                 'ST_PolyFromText',
 645                 'ST_PolyFromWKB',
 646                 'SYSDATE',
 647                 'TAN',
 648                 'TIME',
 649                 'TIMESTAMP',
 650                 'TIME_TO_SEC',
 651                 'TO_DAYS',
 652                 'TO_SECONDS',
 653                 'TRIM',
 654                 'UNCOMPRESS',
 655                 'UNCOMPRESSED_LENGTH',
 656                 'UNHEX',
 657                 'UNIX_TIMESTAMP',
 658                 'UPPER',
 659                 'USER',
 660                 'UTC_DATE',
 661                 'UTC_TIME',
 662                 'UTC_TIMESTAMP',
 663                 'UUID',
 664                 'UUID_SHORT',
 665                 'VERSION',
 666                 'WEEK',
 667                 'WEEKDAY',
 668                 'WEEKOFYEAR',
 669                 'YEAR',
 670                 'YEARWEEK',
 671             ],
 672             $this->object->getAllFunctions(),
 673         );
 674     }
 675
 676     /**
 677      * Test for getAttributes
 678      */
 679     public function testGetAttributes(): void
 680     {
 681         $this->assertEquals(
 682             ['', 'BINARY', 'UNSIGNED', 'UNSIGNED ZEROFILL', 'on update CURRENT_TIMESTAMP'],
 683             $this->object->getAttributes(),
 684         );
 685     }
 686
 687     /**
 688      * Test for getColumns
 689      */
 690     public function testGetColumns(): void
 691     {
 692         $this->assertEquals(
 693             [
 694                 0 => 'INT',
 695                 1 => 'VARCHAR',
 696                 2 => 'TEXT',
 697                 3 => 'DATE',
 698                 'Numeric' => [
 699                     'TINYINT',
 700                     'SMALLINT',
 701                     'MEDIUMINT',
 702                     'INT',
 703                     'BIGINT',
 704                     '-',
 705                     'DECIMAL',
 706                     'FLOAT',
 707                     'DOUBLE',
 708                     'REAL',
 709                     '-',
 710                     'BIT',
 711                     'BOOLEAN',
 712                     'SERIAL',
 713                 ],
 714                 'Date and time' => ['DATE', 'DATETIME', 'TIMESTAMP', 'TIME', 'YEAR'],
 715                 'String' => [
 716                     'CHAR',
 717                     'VARCHAR',
 718                     '-',
 719                     'TINYTEXT',
 720                     'TEXT',
 721                     'MEDIUMTEXT',
 722                     'LONGTEXT',
 723                     '-',
 724                     'BINARY',
 725                     'VARBINARY',
 726                     '-',
 727                     'TINYBLOB',
 728                     'BLOB',
 729                     'MEDIUMBLOB',
 730                     'LONGBLOB',
 731                     '-',
 732                     'ENUM',
 733                     'SET',
 734                 ],
 735                 'Spatial' => [
 736                     'GEOMETRY',
 737                     'POINT',
 738                     'LINESTRING',
 739                     'POLYGON',
 740                     'MULTIPOINT',
 741                     'MULTILINESTRING',
 742                     'MULTIPOLYGON',
 743                     'GEOMETRYCOLLECTION',
 744                 ],
 745                 'JSON' => ['JSON'],
 746             ],
 747             $this->object->getColumns(),
 748         );
 749     }
 750
 751     /**
 752      * @param string $type   Type to check
 753      * @param string $output Expected result
 754      */
 755     #[DataProvider('providerFortTestGetTypeClass')]
 756     public function testGetTypeClass(string $type, string $output): void
 757     {
 758         $this->assertEquals(
 759             $output,
 760             $this->object->getTypeClass($type),
 761         );
 762     }
 763
 764     /**
 765      * Data provider for type testing
 766      *
 767      * @return array<array{string, string}>
 768      */
 769     public static function providerFortTestGetTypeClass(): array
 770     {
 771         return [
 772             ['SERIAL', 'NUMBER'],
 773             ['YEAR', 'DATE'],
 774             ['GEOMETRYCOLLECTION', 'SPATIAL'],
 775             ['SET', 'CHAR'],
 776             ['JSON', 'JSON'],
 777             ['UUID', 'UUID'],
 778             ['UNKNOWN', ''],
 779         ];
 780     }
 781 }