phpmyadmin/tests/unit/Controllers/Table/Structure/MoveColumnsControllerTest.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Tests\Controllers\Table\Structure;

use PhpMyAdmin\Controllers\Table\Structure\MoveColumnsController;
use PhpMyAdmin\Current;
use PhpMyAdmin\Message;
use PhpMyAdmin\Template;
use PhpMyAdmin\Tests\AbstractTestCase;
use PhpMyAdmin\Tests\Stubs\ResponseRenderer as ResponseStub;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use ReflectionClass;

use function preg_replace;

#[CoversClass(MoveColumnsController::class)]
class MoveColumnsControllerTest extends AbstractTestCase
{
    /**
     * @param array<int,string> $columnNames
     * @psalm-param list<string> $columnNames
     */
    #[DataProvider('providerForTestGenerateAlterTableSql')]
    public function testGenerateAlterTableSql(
        string $createStatement,
        array $columnNames,
        string|Message $expected,
    ): void {
        $class = new ReflectionClass(MoveColumnsController::class);
        $method = $class->getMethod('generateAlterTableSql');

        Current::$database = 'test-db';
        Current::$table = 'test';
        $dummyDbi = $this->createDbiDummy();
        $dbi = $this->createDatabaseInterface($dummyDbi);

        $controller = new MoveColumnsController(
            new ResponseStub(),
            new Template(),
            $dbi,
        );
        /** @var string|Message $alterStatement */
        $alterStatement = $method->invoke($controller, $createStatement, $columnNames);

        if ($expected instanceof Message) {
            self::assertInstanceOf(Message::class, $alterStatement);
            self::assertSame($expected->getMessage(), $alterStatement->getMessage());

            return;
        }

        self::assertIsString($alterStatement);
        $expected = preg_replace('/\r?\n/', "\n", $expected);
        $alterStatement = preg_replace('/\r?\n/', "\n", $alterStatement);
        self::assertSame($expected, $alterStatement);
    }

    /**
     * Data provider for testGenerateAlterTableSql
     *
     * @return list<array{string,list<string>,string|Message}>
     */
    public static function providerForTestGenerateAlterTableSql(): array
    {
        // phpcs:disable Generic.Files.LineLength.TooLong
        return [
            // MariaDB / column CHECK constraint
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `id` int(11) NOT NULL AUTO_INCREMENT,
                      `name` varchar(45) DEFAULT NULL,
                      `data` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL CHECK (json_valid(`json`)),
                      PRIMARY KEY (`id`)
                    )
                    SQL,
                ['id', 'data', 'name'],
                <<<'SQL'
                    ALTER TABLE `test`
                      CHANGE `data` `data` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL CHECK (json_valid(`json`)) AFTER `id`
                    SQL,
            ],
            // MariaDB / text column with uuid() default
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `Id` int(11) NOT NULL,
                      `First` text NOT NULL DEFAULT uuid(),
                      `Second` text NOT NULL DEFAULT uuid()
                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci
                    SQL,
                ['Id', 'Second', 'First'],
                <<<'SQL'
                    ALTER TABLE `test`
                      CHANGE `Second` `Second` text NOT NULL DEFAULT uuid() AFTER `Id`
                    SQL,
            ],
            // MySQL 8.0.13 text column with uuid() default
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `Id` int(11) NOT NULL,
                      `First` text COLLATE utf8mb4_general_ci NOT NULL DEFAULT (uuid()),
                      `Second` text COLLATE utf8mb4_general_ci NOT NULL DEFAULT (uuid())
                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci
                    SQL,
                ['Id', 'Second', 'First'],
                <<<'SQL'
                    ALTER TABLE `test`
                      CHANGE `Second` `Second` text COLLATE utf8mb4_general_ci NOT NULL DEFAULT (uuid()) AFTER `Id`
                    SQL,
            ],
            // enum with default
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `id` int(11) NOT NULL,
                      `enum` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no',
                      PRIMARY KEY (`id`)
                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci
                    SQL,
                ['enum', 'id'],
                <<<'SQL'
                    ALTER TABLE `test`
                      CHANGE `enum` `enum` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no' FIRST
                    SQL,
            ],
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `id` int(11) NOT NULL,
                      `enum` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no',
                      PRIMARY KEY (`id`)
                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci
                    SQL,
                ['foo', 'id'],
                Message::error('The selected columns do not match the columns in the table.'),
            ],
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `id` int(11) NOT NULL,
                      `enum` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no',
                      PRIMARY KEY (`id`)
                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci
                    SQL,
                ['id', 'enum'],
                Message::error('The selected columns are already in the correct order.'),
            ],
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `"` int(11) NOT NULL,
                      `'` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no',
                      PRIMARY KEY (`id`)
                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci
                    SQL,
                ['\'', '"'],
                <<<'SQL'
                    ALTER TABLE `test`
                      CHANGE `'` `'` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no' FIRST
                    SQL,
            ],
            [
                <<<'SQL'
                    CREATE TABLE `test` (
                      `1` int(11) NOT NULL,
                      `0` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no',
                      PRIMARY KEY (`id`)
                    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_unicode_ci
                    SQL,
                ['0', '1'],
                <<<'SQL'
                    ALTER TABLE `test`
                      CHANGE `0` `0` enum('yes','no') CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT 'no' FIRST
                    SQL,
            ],
            // with foreign key
            [
                <<<'SQL'
                    CREATE TABLE orders (
                      order_id INT AUTO_INCREMENT PRIMARY KEY,
                      user_id INT NOT NULL,
                      order_date DATE NOT NULL,
                      amount DECIMAL(10, 2) NOT NULL,
                      status VARCHAR(50) DEFAULT 'pending',
                      CONSTRAINT fk_user
                        FOREIGN KEY (user_id)
                        REFERENCES users(user_id)
                        ON DELETE CASCADE
                        ON UPDATE CASCADE
                    )
                    SQL,
                ['order_id','user_id','order_date','status','amount'],
                <<<'SQL'
                    ALTER TABLE `orders`
                      CHANGE `status` `status` varchar(50) DEFAULT 'pending' AFTER `order_date`
                    SQL,
            ],
            // With non-primary index
            [
                <<<'SQL'
                    CREATE TABLE `test_table` (
                      `id` int(11) NOT NULL AUTO_INCREMENT,
                      `val` int(11) DEFAULT NULL,
                      `note` varchar(100) DEFAULT NULL,
                      PRIMARY KEY (`id`),
                      KEY `val_index` (`val`)
                    ) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci
                    SQL,
                ['id', 'note', 'val'],
                <<<'SQL'
                    ALTER TABLE `test_table`
                      CHANGE `note` `note` varchar(100) DEFAULT NULL AFTER `id`
                    SQL,
            ],
        ];
        // phpcs:enable
    }
}