Merge #394 - Testing the contextGenerator class

Pull-request: #394

Signed-off-by: William Desportes <[email protected]>

Author: williamdes

phpcs.xml.dist

@@ -29,6 +29,7 @@
 
     <rule ref="Squiz.Arrays.ArrayDeclaration.IndexNoNewline">
         <exclude-pattern>src/Contexts/*</exclude-pattern>
+        <exclude-pattern>tests/Tools/templates/*</exclude-pattern>
     </rule>
 
     <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">

phpunit.xml.dist

@@ -34,6 +34,9 @@
         <testsuite name="Utils">
             <directory suffix=".php">./tests/Utils</directory>
         </testsuite>
+        <testsuite name="Tools">
+            <directory suffix=".php">./tests/Tools</directory>
+        </testsuite>
     </testsuites>
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">

tests/Tools/ContextGeneratorTest.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\SqlParser\Tests\Tools;
+
+use PhpMyAdmin\SqlParser\Tests\TestCase;
+use PhpMyAdmin\SqlParser\Token;
+use PhpMyAdmin\SqlParser\Tools\ContextGenerator;
+
+use function file_get_contents;
+use function getcwd;
+
+class ContextGeneratorTest extends TestCase
+{
+    public function testFormatName(): void
+    {
+        $name = ContextGenerator::formatName('MySql80000');
+        $this->assertEquals('MySQL 8.0', $name);
+
+        $name = ContextGenerator::formatName('MariaDb100200');
+        $this->assertEquals('MariaDB 10.2', $name);
+
+        $name = ContextGenerator::formatName('MariaDb100000');
+        $this->assertEquals('MariaDB 10.0', $name);
+    }
+
+    public function testSortWords(): void
+    {
+        $wordsArray = ['41' => [['GEOMETRYCOLLECTION', 'DATE']], '35' => [['SCHEMA', 'REPEAT', 'VALUES']]];
+        ContextGenerator::sortWords($wordsArray);
+        $this->assertEquals([
+            '41' => ['0' => ['DATE', 'GEOMETRYCOLLECTION']],
+            '35' => ['0' => ['REPEAT', 'SCHEMA', 'VALUES']],
+        ], $wordsArray);
+    }
+
+    public function testReadWords(): void
+    {
+        $testFiles = [getcwd() . '/tests/Tools/contexts/testContext.txt'];
+        $readWords = ContextGenerator::readWords($testFiles);
+        $this->assertEquals([
+            Token::TYPE_KEYWORD | Token::FLAG_KEYWORD_RESERVED => [
+                8 => ['RESERVED'],
+                9 => ['RESERVED2','RESERVED3','RESERVED4','RESERVED5'],
+            ],
+            Token::TYPE_KEYWORD | Token::FLAG_KEYWORD_FUNCTION => [8 => ['FUNCTION']],
+            Token::TYPE_KEYWORD | Token::FLAG_KEYWORD_DATA_TYPE => [8 => ['DATATYPE']],
+            Token::TYPE_KEYWORD | Token::FLAG_KEYWORD_KEY => [7 => ['KEYWORD']],
+            Token::TYPE_KEYWORD => [7 => ['NO_FLAG']],
+            Token::TYPE_KEYWORD | Token::FLAG_KEYWORD_RESERVED | 4 => [16 => ['COMPOSED KEYWORD']],
+        ], $readWords);
+    }
+
+    public function testGenerate(): void
+    {
+        $testFiles = [getcwd() . '/tests/Tools/contexts/testContext.txt'];
+        $readWords = ContextGenerator::readWords($testFiles);
+        ContextGenerator::printWords($readWords);
+        $options = [
+            'keywords' => $readWords,
+            'name' => 'MYSQL TEST',
+            'class' => 'ContextTest',
+            'link' => 'https://www.phpmyadmin.net/contribute',
+        ];
+        $generatedTemplate = ContextGenerator::generate($options);
+        $expectedTemplate = file_get_contents(getcwd() . '/tests/Tools/templates/ContextTest.php');
+        $this->assertEquals($expectedTemplate, $generatedTemplate);
+    }
+}

tests/Tools/contexts/testContext.txt

@@ -0,0 +1,14 @@
+RESERVED (R)
+RESERVED2 (R)
+RESERVED3 (R)
+RESERVED4 (R)
+RESERVED5 (R)
+
+FUNCTION (F)
+DATATYPE (D)
+KEYWORD (K)
+
+NO_FLAG
+COMPOSED KEYWORD
+
+FUNCTION

tests/Tools/templates/ContextTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\SqlParser\Contexts;
+
+use PhpMyAdmin\SqlParser\Context;
+use PhpMyAdmin\SqlParser\Token;
+
+/**
+ * Context for MYSQL TEST.
+ *
+ * This class was auto-generated from tools/contexts/*.txt.
+ * Use tools/run_generators.sh for update.
+ *
+ * @see https://www.phpmyadmin.net/contribute
+ */
+class ContextTest extends Context
+{
+    /**
+     * List of keywords.
+     *
+     * The value associated to each keyword represents its flags.
+     *
+     * @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
+     *      Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
+     *      Token::FLAG_KEYWORD_FUNCTION
+     *
+     * @var array<string,int>
+     * @phpstan-var non-empty-array<non-empty-string,Token::FLAG_KEYWORD_*|int>
+     */
+    public static $KEYWORDS = [
+        'NO_FLAG' => 1,
+
+        'RESERVED' => 3,
+        'RESERVED2' => 3, 'RESERVED3' => 3, 'RESERVED4' => 3, 'RESERVED5' => 3,
+
+        'COMPOSED KEYWORD' => 7,
+
+        'DATATYPE' => 9,
+
+        'KEYWORD' => 17,
+
+        'FUNCTION' => 33,
+    ];
+}