phpmyadmin/tests/unit/LinterTest.php

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Tests;

use PhpMyAdmin\Linter;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;

use function str_repeat;

#[CoversClass(Linter::class)]
class LinterTest extends AbstractTestCase
{
    /**
     * Sets up the fixture, for example, opens a network connection.
     * This method is called before a test is executed.
     */
    protected function setUp(): void
    {
        parent::setUp();

        $this->setLanguage();
    }

    /**
     * Test for Linter::getLines
     */
    public function testGetLines(): void
    {
        self::assertSame([0], Linter::getLines(''));
        self::assertSame([0, 2], Linter::getLines("a\nb"));
        self::assertSame([0, 4, 7], Linter::getLines("abc\nde\n"));
    }

    /**
     * Test for Linter::findLineNumberAndColumn
     */
    public function testFindLineNumberAndColumn(): void
    {
        // Let the analyzed string be:
        //      ^abc$
        //      ^de$
        //      ^$
        //
        // Where `^` is the beginning of the line and `$` the end of the line.
        //
        // Positions of each character (by line):
        //      ( a, 0), ( b, 1), ( c, 2), (\n, 3),
        //      ( d, 4), ( e, 5), (\n, 6),
        //      (\n, 7).
        self::assertSame(
            [1, 0],
            Linter::findLineNumberAndColumn([0, 4, 7], 4),
        );
        self::assertSame(
            [1, 1],
            Linter::findLineNumberAndColumn([0, 4, 7], 5),
        );
        self::assertSame(
            [1, 2],
            Linter::findLineNumberAndColumn([0, 4, 7], 6),
        );
        self::assertSame(
            [2, 0],
            Linter::findLineNumberAndColumn([0, 4, 7], 7),
        );
    }

    /**
     * Test for Linter::lint
     *
     * @param mixed[] $expected The expected result.
     * @param string  $query    The query to be analyzed.
     */
    #[DataProvider('lintProvider')]
    public function testLint(array $expected, string $query): void
    {
        self::assertSame($expected, Linter::lint($query));
    }

    /**
     * Provides data for `testLint`.
     *
     * @return array<array{mixed[], string}>
     */
    public static function lintProvider(): array
    {
        return [
            [[], ''],
            [[], 'SELECT * FROM tbl'],
            [
                [
                    [
                        'message' => 'Unrecognized data type. (near <code>IN</code>)',
                        'fromLine' => 0,
                        'fromColumn' => 22,
                        'toLine' => 0,
                        'toColumn' => 24,
                        'severity' => 'error',
                    ],
                    [
                        'message' => 'A closing bracket was expected. (near <code>IN</code>)',
                        'fromLine' => 0,
                        'fromColumn' => 22,
                        'toLine' => 0,
                        'toColumn' => 24,
                        'severity' => 'error',
                    ],
                ],
                'CREATE TABLE tbl ( id IN',
            ],
            [
                [
                    [
                        'message' => 'Linting is disabled for this query because it exceeds the maximum length.',
                        'fromLine' => 0,
                        'fromColumn' => 0,
                        'toLine' => 0,
                        'toColumn' => 0,
                        'severity' => 'warning',
                    ],
                ],
                str_repeat(';', 10001),
            ],
        ];
    }
}