Merge pull request #38 from vierge-noire/next

* #7 Removes the CakePHP fixture init (#8)

* #7 Removes the loadConfig (#12)

* #14 Makes the dirty table collector permanent per default (#18)

* #24 Fix connection alias issue (#27)

* #30 Dropping managed by Migrator (#34)

* #31 Use native dialects (#36)

* #32 Cleanup

* #35 Require migrator 2.2

Co-authored-by: Juan Pablo Ramirez <>

.gitignore

@@ -5,4 +5,4 @@ dummy_database
 composer.lock
 /.phpunit.result.cache
 /tmp/
-.env
+tests/.env

composer.json

@@ -18,7 +18,8 @@
   "require": {
     "php": ">=7.2",
     "cakephp/cakephp": "^4.0",
-    "ext-pdo": "*"
+    "ext-pdo": "*",
+    "vierge-noire/cakephp-test-migrator": "^2.2"
   },
   "require-dev": {
     "cakephp/migrations": "^3.0",

run_tests.sh

@@ -12,9 +12,12 @@ export DB_DRIVER=$DRIVER
 
 #######################
 #### Tests with non temporary sniffers
+#### Skip MySQL
 #######################
-export SNIFFERS_IN_TEMP_MODE="true"
-./vendor/bin/phpunit
+if [ $DRIVER != 'Mysql' ]; then
+  export SNIFFERS_IN_TEMP_MODE="true"
+  ./vendor/bin/phpunit
+fi
 
 #### DEPRECATED #####
 # Run the tests using

src/FixtureManager.php

@@ -94,18 +94,6 @@ public function skipConnection(string $connectionName, array $ignoredConnections
         return true;
     }
 
-    /**
-     * Get the appropriate sniffer and drop all tables
-     * @param string $connectionName
-     * @return void
-     */
-    public function dropTables(string $connectionName): void
-    {
-        SnifferRegistry::get($connectionName)->dropTables(
-            SnifferRegistry::get($connectionName)->fetchAllTables()
-        );
-    }
-
     /**
      * Initialize all connections used by the manager
      * @return array
@@ -127,6 +115,7 @@ public function fetchActiveConnections(): array
      * Those are the connections that are neither ignored,
      * nor irrelevant (debug_kit, non-test DBs etc...)
      * @return array
+     * @throws \RuntimeException
      */
     public function getActiveConnections(): array
     {
@@ -148,7 +137,7 @@ public function getFixturesPerConnection(array $fixtures)
             // For Cake ^4.0
             return $this->_fixtureConnections($fixtures);
         } else {
-            throw new Exception(
+            throw new \RuntimeException(
                 'Neither groupFixturesByConnection nor _fixtureConnections defined in ' . self::class
             );
         }
@@ -189,7 +178,7 @@ public function load(TestCase $test): void
                                     get_class($test),
                                     $e->getMessage()
                                 );
-                                throw new Exception($msg, 0, $e);
+                                throw new \RuntimeException($msg, 0, $e);
                             }
                         }
                     });

src/Sniffer/BaseTableSniffer.php

@@ -41,14 +41,9 @@ abstract public function truncateDirtyTables(): void;
      */
     abstract public function getDirtyTables(): array;
 
-    /**
-     * List all tables
-     * @return array
-     */
-    abstract public function fetchAllTables(): array;
-
     /**
      * Drop tables passed as a parameter
+     * @deprecated table dropping is not handled by this package anymore.
      * @param array $tables
      * @return void
      */
@@ -61,7 +56,6 @@ abstract public function dropTables(array $tables): void;
     public function __construct(ConnectionInterface $connection)
     {
         $this->setConnection($connection);
-        $this->start();
     }
 
     /**
@@ -87,13 +81,14 @@ public function setConnection(ConnectionInterface $connection): void
      * Create the spying triggers
      * @return void
      */
-    public function start(): void
+    public function init(): void
     {
         $this->getAllTables(true);
     }
 
     /**
      * Stop spying
+     * @deprecated shutdowm will not be supported from 3.0 on.
      * @return void
      */
     public function shutdown(): void
@@ -103,12 +98,13 @@ public function shutdown(): void
      * Stop spying and restart
      * Useful if the schema or the
      * dirty table collector changed
+     * @deprecated the schema changes are not handled anymore by this package.
      * @return void
      */
     public function restart(): void
     {
         $this->shutdown();
-        $this->start();
+        $this->init();
     }
 
     /**
@@ -119,6 +115,7 @@ public function restart(): void
      * @param string $query
      *
      * @return array
+     * @deprecated queries should be fetched using the CakePHP native tools.
      */
     public function fetchQuery(string $query): array
     {
@@ -130,7 +127,6 @@ public function fetchQuery(string $query): array
         } catch (\Exception $e) {
             $name = $this->getConnection()->configName();
             $db = $this->getConnection()->config()['database'];
-            var_dump($e->getMessage());
             throw new Exception("Error in the connection '$name'. Is the database '$db' created and accessible?");
         }
 
@@ -181,6 +177,15 @@ public function getAllTables(bool $forceFetch = false): array
         return $this->allTables;
     }
 
+    /**
+     * List all tables
+     * @return string[]
+     */
+    public function fetchAllTables(): array
+    {
+        return $this->getConnection()->getSchemaCollection()->listTables();
+    }
+
     /**
      * Checks if the present class implements triggers
      * @return bool
@@ -189,4 +194,4 @@ public function implementsTriggers(): bool
     {
         return $this instanceof BaseTriggerBasedTableSniffer;
     }
-}
+}

src/Sniffer/BaseTriggerBasedTableSniffer.php

@@ -13,7 +13,6 @@
  */
 namespace CakephpTestSuiteLight\Sniffer;
 
-use Cake\Database\Exception;
 use Cake\Datasource\ConnectionInterface;
 
 abstract class BaseTriggerBasedTableSniffer extends BaseTableSniffer
@@ -44,12 +43,14 @@ abstract class BaseTriggerBasedTableSniffer extends BaseTableSniffer
 
     /**
      * Get triggers relative to the database dirty table collector
+     * @deprecated triggers are not dropped and do not need to be fetched.
      * @return array
      */
     abstract public function getTriggers(): array;
 
     /**
      * Drop triggers relative to the database dirty table collector
+     * @deprecated Triggers will not be dropped any more. The present package expects a clean schema.
      * @return void
      */
     abstract public function dropTriggers();
@@ -61,11 +62,17 @@ abstract public function dropTriggers();
     abstract public function createTriggers(): void;
 
     /**
-     * Mark all tables except phinxlogs as dirty
+     * Mark all tables except phinxlogs and dirty table collector as dirty.
      * @return void
      */
     abstract public function markAllTablesAsDirty(): void;
 
+    /**
+     * Create the procedure truncating the dirty tables.
+     * @return void
+     */
+    abstract public function createTruncateDirtyTablesProcedure(): void;
+
     /**
      * BaseTableTruncator constructor.
      * @param ConnectionInterface $connection
@@ -76,6 +83,45 @@ public function __construct(ConnectionInterface $connection)
         parent::__construct($connection);
     }
 
+    /**
+     * Check that the dirty table collector exists
+     *
+     * @return bool
+     */
+    public function dirtyTableCollectorExists(): bool
+    {
+        return in_array(self::DIRTY_TABLE_COLLECTOR, $this->getAllTables(true));
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function init(): void
+    {
+        if (!$this->dirtyTableCollectorExists()) {
+            $this->createDirtyTableCollector();
+            try {
+                $this->createTriggers();
+            } catch (\Throwable $e) {
+                $message = $e->getMessage();
+                $message .= ' ----- Please truncate your test schema manually and run the test suite again.';
+                throw new \RuntimeException($message);
+            }
+            $this->createTruncateDirtyTablesProcedure();
+            $this->markAllTablesAsDirty();
+        }
+    }
+
+    /**
+     * Get the name of the dirty table locator.
+     *
+     * @return string
+     */
+    public function collectorName(): string
+    {
+        return BaseTriggerBasedTableSniffer::DIRTY_TABLE_COLLECTOR;
+    }
+
     /**
      * Find all tables where an insert happened
      * This also includes empty tables, where a delete
@@ -85,13 +131,30 @@ public function __construct(ConnectionInterface $connection)
     public function getDirtyTables(): array
     {
         try {
-            return $this->fetchQuery("SELECT table_name FROM " . self::DIRTY_TABLE_COLLECTOR);
-        } catch (\Exception $e) {
-            $this->restart();
-            return $this->getAllTablesExceptPhinxlogs(true);
+            return $this->fetchQuery("SELECT table_name FROM " . $this->collectorName());
+        } catch (\Throwable $e) {
+            $this->init();
+            return $this->getDirtyTables();
         }
     }
 
+    /**
+     * Fetch all tables, excluded from Phinx related and the dirty table collector.
+     *
+     * @param bool $forceFetch
+     * @return array
+     */
+    public function getAllTablesExceptPhinxlogsAndCollector(bool $forceFetch = false): array
+    {
+        $allTables = $this->getAllTablesExceptPhinxlogs($forceFetch);
+
+        if (($key = array_search($this->collectorName(), $allTables)) !== false) {
+            unset($allTables[$key]);
+        }
+
+        return $allTables;
+    }
+
     /**
      * Create the table gathering the dirty tables
      * @return void
@@ -110,6 +173,7 @@ public function createDirtyTableCollector(): void
 
     /**
      * Drop the table gathering the dirty tables
+     * @deprecated The dropping is handled by the schema manager.
      * @return void
      */
     public function dropDirtyTableCollector()
@@ -118,18 +182,6 @@ public function dropDirtyTableCollector()
         $this->getConnection()->execute("DROP TABLE IF EXISTS {$dirtyTable}");
     }
 
-    /**
-     * The dirty table collector being temporary,
-     * ensure that all tables are clean when starting the suite
-     * @return void
-     */
-    public function cleanAllTables(): void
-    {
-        if ($this->isInTempMode()) {
-            $this->markAllTablesAsDirty();
-        }
-    }
-
     /**
      * The dirty table collector is not temporary
      * @return void

src/Sniffer/DriverTraits/MysqlSnifferTrait.php

@@ -17,6 +17,11 @@
 use Cake\Database\Connection;
 use CakephpTestSuiteLight\Sniffer\BaseTriggerBasedTableSniffer;
 
+/**
+ * Trait MysqlSnifferTrait
+ * @package CakephpTestSuiteLight\Sniffer\DriverTraits
+ * @deprecated Sniffers are not queried anymore.
+ */
 trait MysqlSnifferTrait
 {
     /**
@@ -49,18 +54,6 @@ public function dropTriggers(): void
         $this->getConnection()->execute($stmts);
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function fetchAllTables(): array
-    {
-        return $this->fetchQuery("
-            SELECT table_name
-            FROM INFORMATION_SCHEMA.TABLES
-            WHERE TABLE_SCHEMA = DATABASE();
-        ");
-    }
-
     /**
      * @inheritDoc
      */
@@ -79,4 +72,4 @@ public function dropTables(array $tables): void
             });
         });
     }
-}
+}

src/Sniffer/DriverTraits/PostgresSnifferTrait.php

@@ -16,6 +16,11 @@
 use Cake\Database\Connection;
 use CakephpTestSuiteLight\Sniffer\BaseTriggerBasedTableSniffer;
 
+/**
+ * Trait PostgresSnifferTrait
+ * @package CakephpTestSuiteLight\Sniffer\DriverTraits
+ * @deprecated Sniffers are not queried anymore.
+ */
 trait PostgresSnifferTrait
 {
     /**
@@ -55,18 +60,6 @@ public function dropTriggers(): void
         }
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function fetchAllTables(): array
-    {
-        return $this->fetchQuery("            
-            SELECT table_name
-            FROM information_schema.tables
-            WHERE table_schema = 'public'            
-        ");
-    }
-
     /**
      * @inheritDoc
      */
@@ -85,4 +78,4 @@ public function dropTables(array $tables): void
             }
         });
     }
-}
+}