Adding a meaningful error message if a table has no primary key

thecodingmachine · Dec 6, 2017 · f464f6a · f464f6a
1 parent 4f6e3ec
commit f464f6a
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/Utils/BeanDescriptor.php b/src/Utils/BeanDescriptor.php
@@ -162,6 +162,11 @@ public function getExposedProperties(): array
      */
     private function getProperties(Table $table)
     {
+        if ($table->getPrimaryKey() === null) {
+            // Security check: a table MUST have a primary key
+            throw new TDBMException(sprintf('Table "%s" does not have any primary key', $table->getName()));
+        }
+
         $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
         if ($parentRelationship) {
             $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());

diff --git a/tests/Utils/BeanDescriptorTest.php b/tests/Utils/BeanDescriptorTest.php
@@ -22,8 +22,10 @@
 
 use Doctrine\Common\Cache\VoidCache;
 use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\Table;
 use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
 use TheCodingMachine\TDBM\TDBMAbstractServiceTest;
+use TheCodingMachine\TDBM\TDBMException;
 use TheCodingMachine\TDBM\TDBMSchemaAnalyzer;
 
 class BeanDescriptorTest extends TDBMAbstractServiceTest
@@ -86,6 +88,14 @@ public function testGetTable()
         $this->assertSame($usersTable, $beanDescriptor->getTable());
     }
 
+    public function testTableWithNoPrimaryKey()
+    {
+        $table = new Table('no_primary_key');
+        $this->expectException(TDBMException::class);
+        $this->expectExceptionMessage('Table "no_primary_key" does not have any primary key');
+        new BeanDescriptor($table, 'Foo\\Bar', 'Foo\\Generated\\Bar', $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer, new DefaultNamingStrategy());
+    }
+
     /*public function testGeneratePhpCode() {
         $usersTable = $this->schema->getTable("users");
         $beanDescriptor = new BeanDescriptor($usersTable, $this->schemaAnalyzer, $this->schema);