IBX-1817: Ensured that extra schema keys throw exception

src/lib/Importer/SchemaImporter.php

@@ -10,6 +10,7 @@
 
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\Table;
+use Ibexa\Contracts\DoctrineSchema\Exception\InvalidConfigurationException;
 use Ibexa\Contracts\DoctrineSchema\SchemaImporterInterface as APISchemaImporter;
 use Symfony\Component\Yaml\Yaml;
 
@@ -70,6 +71,14 @@ private function importSchemaTable(
     ): void {
         $table = $schema->createTable($tableName);
 
+        $this->ensureNoExtraKeys($tableConfiguration, $tableName, [
+            'id',
+            'fields',
+            'foreignKeys',
+            'indexes',
+            'uniqueConstraints',
+        ]);
+
         if (isset($tableConfiguration['id'])) {
             $this->addSchemaTableColumns($table, $tableConfiguration['id']);
             $table->setPrimaryKey(array_keys($tableConfiguration['id']));
@@ -121,6 +130,16 @@ private function importSchemaTable(
     private function addSchemaTableColumns(Table $table, array $columnList): void
     {
         foreach ($columnList as $columnName => $columnConfiguration) {
+            $location = sprintf('%s.fields.%s', $table->getName(), $columnName);
+            $this->ensureNoExtraKeys($columnConfiguration, $location, [
+                'length',
+                'scale',
+                'precision',
+                'type',
+                'nullable',
+                'options',
+            ]);
+
             if (isset($columnConfiguration['length'])) {
                 $columnConfiguration['options']['length'] = $columnConfiguration['length'];
             }
@@ -144,6 +163,19 @@ private function addSchemaTableColumns(Table $table, array $columnList): void
             }
         }
     }
+
+    private function ensureNoExtraKeys(array $tableConfiguration, string $location, array $allowedKeys): void
+    {
+        $diff = array_diff(array_keys($tableConfiguration), $allowedKeys);
+        if (!empty($diff)) {
+            throw new InvalidConfigurationException(sprintf(
+                'Unhandled property in schema configuration for "%s". "%s" keys are not allowed. Allowed keys: "%s".',
+                $location,
+                implode('", "', $diff),
+                implode('", "', $allowedKeys),
+            ));
+        }
+    }
 }
 
 class_alias(SchemaImporter::class, 'EzSystems\DoctrineSchema\Importer\SchemaImporter');

tests/lib/Importer/SchemaImporterTest.php

@@ -14,6 +14,7 @@
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Types\Type;
+use Ibexa\Contracts\DoctrineSchema\Exception\InvalidConfigurationException;
 use Ibexa\DoctrineSchema\Importer\SchemaImporter;
 use PHPUnit\Framework\TestCase;
 
@@ -218,6 +219,30 @@ public function testImportFromFile(
             "Yaml schema definition {$yamlSchemaDefinitionFile} produced unexpected Schema object"
         );
     }
+
+    public function testTableImportFailsIfUnhandledKeys(): void
+    {
+        $importer = new SchemaImporter();
+
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage(
+            'Unhandled property in schema configuration for "my_table". "foo" keys are not allowed. Allowed keys:'
+            . ' "id", "fields", "foreignKeys", "indexes", "uniqueConstraints".'
+        );
+        $importer->importFromFile(__DIR__ . '/_fixtures/failing-import.yaml');
+    }
+
+    public function testColumnImportFailsIfUnhandledKeys(): void
+    {
+        $importer = new SchemaImporter();
+
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage(
+            'Unhandled property in schema configuration for "my_table.fields.foo". "bar" keys are not allowed. Allowed keys:'
+            . ' "length", "scale", "precision", "type", "nullable", "options".'
+        );
+        $importer->importFromFile(__DIR__ . '/_fixtures/failing-import-column.yaml');
+    }
 }
 
 class_alias(SchemaImporterTest::class, 'EzSystems\Tests\DoctrineSchema\Importer\SchemaImporterTest');

tests/lib/Importer/_fixtures/failing-import-column.yaml

@@ -0,0 +1,5 @@
+tables:
+    my_table:
+        fields:
+            foo:
+                bar: ~

tests/lib/Importer/_fixtures/failing-import.yaml

@@ -0,0 +1,3 @@
+tables:
+    my_table:
+        foo: bar