CreateDefinitionTest.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\SqlParser\Tests\Components;

use PhpMyAdmin\SqlParser\Parser;
use PhpMyAdmin\SqlParser\Parsers\CreateDefinitions;
use PhpMyAdmin\SqlParser\Statements\CreateStatement;
use PhpMyAdmin\SqlParser\Tests\TestCase;

class CreateDefinitionTest extends TestCase
{
    public function testParse(): void
    {
        $component = CreateDefinitions::parse(
            new Parser(),
            $this->getTokensList('(str TEXT, FULLTEXT INDEX indx (str))'),
        );
        $this->assertEquals('str', $component[0]->name);
        $this->assertNotNull($component[1]->key);
        $this->assertEquals('FULLTEXT INDEX', $component[1]->key->type);
        $this->assertEquals('indx', $component[1]->key->name);
        $this->assertEquals('FULLTEXT INDEX `indx` (`str`)', (string) $component[1]);
    }

    public function testParse2(): void
    {
        $component = CreateDefinitions::parse(
            new Parser(),
            $this->getTokensList('(str TEXT NOT NULL INVISIBLE)'),
        );
        $this->assertEquals('str', $component[0]->name);
        $this->assertNotNull($component[0]->type);
        $this->assertEquals('TEXT', $component[0]->type->name);
        $this->assertNotNull($component[0]->options);
        $this->assertTrue($component[0]->options->has('INVISIBLE'));
        $this->assertTrue($component[0]->options->has('NOT NULL'));
    }

    public function testParseErr1(): void
    {
        $parser = new Parser();
        $component = CreateDefinitions::parse(
            $parser,
            $this->getTokensList('(str TEXT, FULLTEXT INDEX indx (str)'),
        );
        $this->assertCount(2, $component);

        $this->assertEquals(
            'A closing bracket was expected.',
            $parser->errors[0]->getMessage(),
        );
    }

    public function testParseErr2(): void
    {
        $parser = new Parser();
        CreateDefinitions::parse(
            $parser,
            $this->getTokensList(')'),
        );

        $this->assertEquals(
            'An opening bracket was expected.',
            $parser->errors[0]->getMessage(),
        );
    }

    public function testBuild(): void
    {
        $parser = new Parser(
            'CREATE TABLE `payment` (' .
            '-- snippet' . "\n" .
            '`customer_id` smallint(5) unsigned NOT NULL,' .
            'CONSTRAINT `fk_payment_customer` FOREIGN KEY (`customer_id`) ' .
            'REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE' .
            ') ENGINE=InnoDB"',
        );
        $this->assertInstanceOf(CreateStatement::class, $parser->statements[0]);
        $this->assertIsArray($parser->statements[0]->fields);
        $this->assertEquals(
            'CONSTRAINT `fk_payment_customer` FOREIGN KEY (`customer_id`) ' .
            'REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE',
            $parser->statements[0]->fields[1]->build(),
        );
    }

    public function testBuild2(): void
    {
        $parser = new Parser(
            'CREATE TABLE `payment` (' .
            '-- snippet' . "\n" .
            '`customer_id` smallint(5) unsigned NOT NULL,' .
            '`customer_data` longtext CHARACTER SET utf8mb4 CHARSET utf8mb4_bin NOT NULL ' .
            'CHECK (json_valid(customer_data)),CONSTRAINT `fk_payment_customer` FOREIGN KEY ' .
            '(`customer_id`) REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE' .
            ') ENGINE=InnoDB"',
        );
        $this->assertInstanceOf(CreateStatement::class, $parser->statements[0]);
        $this->assertIsArray($parser->statements[0]->fields);
        $this->assertEquals(
            'CONSTRAINT `fk_payment_customer` FOREIGN KEY (`customer_id`) ' .
            'REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE',
            $parser->statements[0]->fields[2]->build(),
        );
    }

    public function testBuild3(): void
    {
        $parser = new Parser(
            'DROP TABLE IF EXISTS `searches`;'
            . 'CREATE TABLE `searches` ('
            . '  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,'
            . '  `name` varchar(255) COLLATE utf8_unicode_ci NOT NULL,'
            . '  `public_name` varchar(120) COLLATE utf8_unicode_ci NOT NULL,'
            . '  `group_id` smallint(5) unsigned NOT NULL DEFAULT \'0\','
            . '  `shortdesc` tinytext COLLATE utf8_unicode_ci,'
            . '  `show_separators` tinyint(1) NOT NULL DEFAULT \'0\','
            . '  `show_separators_two` tinyint(1) NOT NULL DEFAULT FALSE,'
            . '  `deleted` tinyint(1) NOT NULL DEFAULT \'0\','
            . '  PRIMARY KEY (`id`)'
            . ') ENGINE=MyISAM  DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci ;'
            . ''
            . 'ALTER TABLE `searches` ADD `admins_only` BOOLEAN NOT NULL DEFAULT FALSE AFTER `show_separators`;',
        );
        $this->assertInstanceOf(CreateStatement::class, $parser->statements[1]);
        $this->assertIsArray($parser->statements[1]->fields);
        $this->assertEquals(
            '`public_name` varchar(120) COLLATE utf8_unicode_ci NOT NULL',
            $parser->statements[1]->fields[2]->build(),
        );
        $this->assertEquals(
            '`show_separators` tinyint(1) NOT NULL DEFAULT \'0\'',
            $parser->statements[1]->fields[5]->build(),
        );
        $this->assertEquals(
            '`show_separators_two` tinyint(1) NOT NULL DEFAULT FALSE',
            $parser->statements[1]->fields[6]->build(),
        );
    }

    public function testBuildWithInvisibleKeyword(): void
    {
        $parser = new Parser(
            'CREATE TABLE `payment` (' .
            '-- snippet' . "\n" .
            '`customer_id` smallint(5) unsigned NOT NULL INVISIBLE,' .
            '`customer_data` longtext CHARACTER SET utf8mb4 CHARSET utf8mb4_bin NOT NULL ' .
            'CHECK (json_valid(customer_data)),CONSTRAINT `fk_payment_customer` FOREIGN KEY ' .
            '(`customer_id`) REFERENCES `customer` (`customer_id`) ON UPDATE CASCADE' .
            ') ENGINE=InnoDB"',
        );
        $this->assertInstanceOf(CreateStatement::class, $parser->statements[0]);
        $this->assertIsArray($parser->statements[0]->fields);
        $this->assertEquals(
            '`customer_id` smallint(5) UNSIGNED NOT NULL INVISIBLE',
            $parser->statements[0]->fields[0]->build(),
        );
    }

    public function testBuildWithCompressed(): void
    {
        $query = 'CREATE TABLE `user` ( `message2` TEXT COMPRESSED )';
        $parser = new Parser($query);
        $stmt = $parser->statements[0];
        $this->assertEquals("CREATE TABLE `user` (\n  `message2` text COMPRESSED\n) ", $stmt->build());
    }
}