test/classes/LinterTest.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Tests for Linter.php.
   5  *
   6  * @package PhpMyAdmin-test
   7  */
   8 declare(strict_types=1);
   9
  10 namespace PhpMyAdmin\Tests;
  11
  12 use PhpMyAdmin\Linter;
  13 use PhpMyAdmin\Tests\PmaTestCase;
  14
  15 /**
  16  * Tests for PhpMyAdmin\Linter
  17  *
  18  * @package PhpMyAdmin-test
  19  */
  20 class LinterTest extends PmaTestCase
  21 {
  22     /**
  23      * Test for Linter::getLines
  24      *
  25      * @return void
  26      */
  27     public function testGetLines()
  28     {
  29         $this->assertEquals([0], Linter::getLines(''));
  30         $this->assertEquals([0, 2], Linter::getLines("a\nb"));
  31         $this->assertEquals([0, 4, 7], Linter::getLines("abc\nde\n"));
  32     }
  33
  34     /**
  35      * Test for Linter::findLineNumberAndColumn
  36      *
  37      * @return void
  38      */
  39     public function testFindLineNumberAndColumn()
  40     {
  41         // Let the analyzed string be:
  42         //      ^abc$
  43         //      ^de$
  44         //      ^$
  45         //
  46         // Where `^` is the beginning of the line and `$` the end of the line.
  47         //
  48         // Positions of each character (by line):
  49         //      ( a, 0), ( b, 1), ( c, 2), (\n, 3),
  50         //      ( d, 4), ( e, 5), (\n, 6),
  51         //      (\n, 7).
  52         $this->assertEquals(
  53             [
  54                 1,
  55                 0,
  56             ],
  57             Linter::findLineNumberAndColumn([0, 4, 7], 4)
  58         );
  59         $this->assertEquals(
  60             [
  61                 1,
  62                 1,
  63             ],
  64             Linter::findLineNumberAndColumn([0, 4, 7], 5)
  65         );
  66         $this->assertEquals(
  67             [
  68                 1,
  69                 2,
  70             ],
  71             Linter::findLineNumberAndColumn([0, 4, 7], 6)
  72         );
  73         $this->assertEquals(
  74             [
  75                 2,
  76                 0,
  77             ],
  78             Linter::findLineNumberAndColumn([0, 4, 7], 7)
  79         );
  80     }
  81
  82     /**
  83      * Test for Linter::lint
  84      *
  85      * @dataProvider lintProvider
  86      *
  87      * @param array  $expected The expected result.
  88      * @param string $query    The query to be analyzed.
  89      *
  90      * @return void
  91      */
  92     public function testLint($expected, $query): void
  93     {
  94         $this->assertEquals($expected, Linter::lint($query));
  95     }
  96
  97     /**
  98      * Provides data for `testLint`.
  99      *
 100      * @return array
 101      */
 102     public static function lintProvider()
 103     {
 104         return [
 105             [
 106                 [],
 107                 '',
 108             ],
 109             [
 110                 [],
 111                 'SELECT * FROM tbl',
 112             ],
 113             [
 114                 [
 115                     [
 116                         'message' => 'Unrecognized data type. (near ' .
 117                             '<code>IN</code>)',
 118                         'fromLine' => 0,
 119                         'fromColumn' => 22,
 120                         'toLine' => 0,
 121                         'toColumn' => 24,
 122                         'severity' => 'error',
 123                     ],
 124                     [
 125                         'message' => 'A closing bracket was expected. (near ' .
 126                             '<code>IN</code>)',
 127                         'fromLine' => 0,
 128                         'fromColumn' => 22,
 129                         'toLine' => 0,
 130                         'toColumn' => 24,
 131                         'severity' => 'error',
 132                     ],
 133                 ],
 134                 'CREATE TABLE tbl ( id IN',
 135             ],
 136             [
 137                 [
 138                     [
 139                         'message' => 'Linting is disabled for this query because ' .
 140                             'it exceeds the maximum length.',
 141                         'fromLine' => 0,
 142                         'fromColumn' => 0,
 143                         'toLine' => 0,
 144                         'toColumn' => 0,
 145                         'severity' => 'warning',
 146                     ],
 147                 ],
 148                 str_repeat(";", 10001),
 149             ],
 150         ];
 151     }
 152 }