feat(database): add ShouldMigrate interface (#1273)

Author: brendt

packages/database/src/Database.php

@@ -6,13 +6,18 @@
 
 use Tempest\Database\Builder\QueryBuilders\BuildsQuery;
 use Tempest\Database\Config\DatabaseDialect;
+use UnitEnum;
 
 interface Database
 {
     public DatabaseDialect $dialect {
         get;
     }
 
+    public null|string|UnitEnum $tag {
+        get;
+    }
+
     public function execute(BuildsQuery|Query $query): void;
 
     public function getLastInsertId(): ?Id;

packages/database/src/GenericDatabase.php

@@ -15,6 +15,7 @@
 use Tempest\Database\Exceptions\QueryException;
 use Tempest\Database\Transactions\TransactionManager;
 use Throwable;
+use UnitEnum;
 
 final class GenericDatabase implements Database
 {
@@ -25,6 +26,10 @@ final class GenericDatabase implements Database
         get => $this->connection->config->dialect;
     }
 
+    public null|string|UnitEnum $tag {
+        get => $this->connection->config->tag;
+    }
+
     public function __construct(
         private(set) readonly Connection $connection,
         private(set) readonly TransactionManager $transactionManager,

packages/database/src/Migrations/MigrationManager.php

@@ -21,6 +21,7 @@
 use Tempest\Database\QueryStatements\DropTableStatement;
 use Tempest\Database\QueryStatements\SetForeignKeyChecksStatement;
 use Tempest\Database\QueryStatements\ShowTablesStatement;
+use Tempest\Database\ShouldMigrate;
 use Throwable;
 
 use function Tempest\Database\query;
@@ -188,6 +189,10 @@ public function validate(): void
 
     public function executeUp(MigrationInterface $migration): void
     {
+        if ($migration instanceof ShouldMigrate && $migration->shouldMigrate($this->database) === false) {
+            return;
+        }
+
         $statement = $migration->up();
 
         if ($statement === null) {
@@ -237,6 +242,10 @@ public function executeUp(MigrationInterface $migration): void
 
     public function executeDown(MigrationInterface $migration): void
     {
+        if ($migration instanceof ShouldMigrate && $migration->shouldMigrate($this->database) === false) {
+            return;
+        }
+
         $statement = $migration->down();
 
         if ($statement === null) {

packages/database/src/ShouldMigrate.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Tempest\Database;
+
+interface ShouldMigrate
+{
+    public function shouldMigrate(Database $database): bool;
+}

src/Tempest/Framework/Commands/MigrateUpCommand.php

@@ -16,8 +16,6 @@
 use Tempest\Database\Migrations\MigrationMigrated;
 use Tempest\EventBus\EventHandler;
 
-use function Tempest\get;
-
 #[Singleton]
 final class MigrateUpCommand
 {

tests/Integration/Database/Fixtures/MigrationForBackup.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Tests\Tempest\Integration\Database\Fixtures;
+
+use Tempest\Database\Database;
+use Tempest\Database\DatabaseMigration;
+use Tempest\Database\QueryStatement;
+use Tempest\Database\QueryStatements\CreateTableStatement;
+use Tempest\Database\QueryStatements\DropTableStatement;
+use Tempest\Database\ShouldMigrate;
+
+final class MigrationForBackup implements DatabaseMigration, ShouldMigrate
+{
+    public string $name = '000_backup';
+
+    public function shouldMigrate(Database $database): bool
+    {
+        return $database->tag === 'backup';
+    }
+
+    public function up(): QueryStatement
+    {
+        return new CreateTableStatement('backup_table')->primary();
+    }
+
+    public function down(): QueryStatement
+    {
+        return new DropTableStatement('backup_table');
+    }
+}

tests/Integration/Database/Fixtures/MigrationForMain.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Tests\Tempest\Integration\Database\Fixtures;
+
+use Tempest\Database\Database;
+use Tempest\Database\DatabaseMigration;
+use Tempest\Database\QueryStatement;
+use Tempest\Database\QueryStatements\CreateTableStatement;
+use Tempest\Database\QueryStatements\DropTableStatement;
+use Tempest\Database\ShouldMigrate;
+
+final class MigrationForMain implements DatabaseMigration, ShouldMigrate
+{
+    public string $name = '000_main';
+
+    public function shouldMigrate(Database $database): bool
+    {
+        return $database->tag === 'main';
+    }
+
+    public function up(): QueryStatement
+    {
+        return new CreateTableStatement('main_table')->primary();
+    }
+
+    public function down(): QueryStatement
+    {
+        return new DropTableStatement('main_table');
+    }
+}

tests/Integration/Database/MultiDatabaseTest.php

@@ -15,6 +15,8 @@
 use Tempest\Database\Migrations\MigrationManager;
 use Tests\Tempest\Fixtures\Migrations\CreatePublishersTable;
 use Tests\Tempest\Fixtures\Modules\Books\Models\Publisher;
+use Tests\Tempest\Integration\Database\Fixtures\MigrationForBackup;
+use Tests\Tempest\Integration\Database\Fixtures\MigrationForMain;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 use Tests\Tempest\Integration\TestingDatabaseInitializer;
 
@@ -168,18 +170,14 @@ public function test_migrate_up_command(): void
             ->call('migrate:up --database=main')
             ->assertSuccess();
 
-        $this->assertTrue(query(Migration::class)->count()->onDatabase('main')->execute() > 0);
-
-        $this->assertException(
-            PDOException::class,
-            fn () => $this->assertTrue(query(Migration::class)->count()->onDatabase('backup')->execute() > 0),
-        );
+        $this->assertTableExists(Migration::class, 'main');
+        $this->assertTableDoesNotExist(Migration::class, 'backup');
 
         $this->console
             ->call('migrate:up --database=backup')
             ->assertSuccess();
 
-        $this->assertTrue(query(Migration::class)->count()->onDatabase('backup')->execute() > 0);
+        $this->assertTableExists(Migration::class, 'backup');
     }
 
     public function test_migrate_fresh_command(): void
@@ -188,18 +186,14 @@ public function test_migrate_fresh_command(): void
             ->call('migrate:fresh --database=main')
             ->assertSuccess();
 
-        $this->assertTrue(query(Migration::class)->count()->onDatabase('main')->execute() > 0);
-
-        $this->assertException(
-            PDOException::class,
-            fn () => $this->assertTrue(query(Migration::class)->count()->onDatabase('backup')->execute() > 0),
-        );
+        $this->assertTableExists(Migration::class, 'main');
+        $this->assertTableDoesNotExist(Migration::class, 'backup');
 
         $this->console
             ->call('migrate:fresh --database=backup')
             ->assertSuccess();
 
-        $this->assertTrue(query(Migration::class)->count()->onDatabase('backup')->execute() > 0);
+        $this->assertTableExists(Migration::class, 'backup');
     }
 
     public function test_migrate_up_fresh_command(): void
@@ -208,18 +202,14 @@ public function test_migrate_up_fresh_command(): void
             ->call('migrate:up --fresh --database=main')
             ->assertSuccess();
 
-        $this->assertTrue(query(Migration::class)->count()->onDatabase('main')->execute() > 0);
-
-        $this->assertException(
-            PDOException::class,
-            fn () => $this->assertTrue(query(Migration::class)->count()->onDatabase('backup')->execute() > 0),
-        );
+        $this->assertTableExists(Migration::class, 'main');
+        $this->assertTableDoesNotExist(Migration::class, 'backup');
 
         $this->console
             ->call('migrate:up --fresh --database=backup')
             ->assertSuccess();
 
-        $this->assertTrue(query(Migration::class)->count()->onDatabase('backup')->execute() > 0);
+        $this->assertTableExists(Migration::class, 'backup');
     }
 
     public function test_migrate_down_command(): void
@@ -236,12 +226,8 @@ public function test_migrate_down_command(): void
             ->call('migrate:down --database=backup')
             ->assertSuccess();
 
-        $this->assertTrue(query(Migration::class)->count()->onDatabase('main')->execute() > 0);
-
-        $this->assertException(
-            PDOException::class,
-            fn () => $this->assertTrue(query(Migration::class)->count()->onDatabase('backup')->execute() > 0),
-        );
+        $this->assertTableExists(Migration::class, 'main');
+        $this->assertTableDoesNotExist(Migration::class, 'backup');
     }
 
     public function test_migrate_validate_command(): void
@@ -250,4 +236,48 @@ public function test_migrate_validate_command(): void
             ->call('migrate:validate --database=main')
             ->assertSuccess();
     }
+
+    public function test_should_migrate(): void
+    {
+        /** @var MigrationManager $migrationManager */
+        $migrationManager = $this->container->get(MigrationManager::class);
+
+        $migrationManager->onDatabase('main')->executeUp(new CreateMigrationsTable());
+        $migrationManager->onDatabase('backup')->executeUp(new CreateMigrationsTable());
+
+        $migrationManager->onDatabase('main')->executeUp(new MigrationForMain());
+        $migrationManager->onDatabase('main')->executeUp(new MigrationForBackup());
+
+        $this->assertTableExists('main_table', 'main');
+        $this->assertTableDoesNotExist('backup_table', 'main');
+
+        $migrationManager->onDatabase('backup')->executeUp(new MigrationForMain());
+        $migrationManager->onDatabase('backup')->executeUp(new MigrationForBackup());
+
+        $this->assertTableExists('backup_table', 'backup');
+        $this->assertTableDoesNotExist('main_table', 'backup');
+
+        $migrationManager->onDatabase('main')->executeDown(new MigrationForMain());
+        $migrationManager->onDatabase('main')->executeDown(new MigrationForBackup());
+        $this->assertTableDoesNotExist('main_table', 'main');
+        $this->assertTableDoesNotExist('backup_table', 'main');
+
+        $migrationManager->onDatabase('backup')->executeDown(new MigrationForBackup());
+        $migrationManager->onDatabase('backup')->executeDown(new MigrationForMain());
+        $this->assertTableDoesNotExist('backup_table', 'backup');
+        $this->assertTableDoesNotExist('main_table', 'backup');
+    }
+
+    private function assertTableExists(string $tableName, string $onDatabase): void
+    {
+        $this->assertTrue(query($tableName)->count()->onDatabase($onDatabase)->execute() >= 0);
+    }
+
+    private function assertTableDoesNotExist(string $tableName, string $onDatabase): void
+    {
+        $this->assertException(
+            PDOException::class,
+            fn () => query($tableName)->count()->onDatabase($onDatabase)->execute(),
+        );
+    }
 }