feat(MPM-703): add reserved keywords checkup for names (#48)

Author: ig0rN

src/Command/CheckAllSchemaTemplatesNamesCommand.php

@@ -19,6 +19,22 @@ class CheckAllSchemaTemplatesNamesCommand extends Command
         'fixed'
     ];
 
+    private const RESERVED_KEYWORDS = [
+        'null',
+        'boolean',
+        'int',
+        'long',
+        'float',
+        'double',
+        'bytes',
+        'string',
+        'record',
+        'enum',
+        'array',
+        'map',
+        'fixed',
+    ];
+
     private const REGEX_MATCH_NAME_NAMING_CONVENTION = '/^[A-Za-z_][A-Za-z0-9_]*$/';
 
     private const REGEX_MATCH_NAMESPACE_NAMING_CONVENTION =
@@ -113,7 +129,10 @@ private function validateNameField(string $name, string $schemaName): array
     {
         $failed = [];
 
-        if (!preg_match(self::REGEX_MATCH_NAME_NAMING_CONVENTION, $name)) {
+        if (
+            !preg_match(self::REGEX_MATCH_NAME_NAMING_CONVENTION, $name) ||
+            in_array($name, self::RESERVED_KEYWORDS)
+        ) {
             $failed[] = $schemaName;
         }
 

tests/Command/CheckAllSchemaTemplatesNamesCommandTest.php

@@ -176,6 +176,22 @@ class CheckAllSchemaTemplatesNamesCommandTest extends AbstractSchemaRegistryTest
         }
         EOF;
 
+    protected const BAD_SCHEMA4 = <<<EOF
+        {
+          "type": "record",
+          "name": "null",
+          "namespace": "ch.jobcloud",
+          "doc": "This is a sample Avro schema to get you started. Please edit",
+          "fields": [
+            {
+              "name": "name",
+              "type": "string",
+              "doc": "some desc"
+            }
+          ]
+        }
+        EOF;
+
     /**
      * This method is called before each test.
      */
@@ -354,4 +370,30 @@ public function testOutputWhenNamespaceStartsWithDot(): void
         self::assertStringContainsString('* test.schema.bad3', $commandOutput);
         self::assertEquals(1, $commandTester->getStatusCode());
     }
+
+    public function testOutputWhenNameIsReservedKeyword(): void
+    {
+        file_put_contents(
+            sprintf('%s/test.schema.bad4.avsc', self::SCHEMA_DIRECTORY),
+            self::BAD_SCHEMA4
+        );
+
+        $application = new Application();
+        $application->add(new CheckAllSchemaTemplatesNamesCommand());
+        $command = $application->find('kafka-schema-registry:check:template:names:all');
+        $commandTester = new CommandTester($command);
+
+        $commandTester->execute([
+            'schemaTemplateDirectory' => self::SCHEMA_DIRECTORY
+        ]);
+
+        $commandOutput = trim($commandTester->getDisplay());
+
+        self::assertStringContainsString(
+            'A template schema names must comply with the following AVRO naming',
+            $commandOutput
+        );
+        self::assertStringContainsString('* test.schema.bad4', $commandOutput);
+        self::assertEquals(1, $commandTester->getStatusCode());
+    }
 }