Expand use of config

Author: k2bd

README.md

@@ -1,7 +1,7 @@
 # Flux Migrations
 
 [![codecov](https://codecov.io/gh/k2bd/flux-migrations/graph/badge.svg?token=PJF3cYLtZh)](https://codecov.io/gh/k2bd/flux-migrations)
-![Discord](https://img.shields.io/discord/1238849973123154001)
+![Discord](https://img.shields.io/discord/1238849973123154001?logo=discord&label=discord)
 
 A modern database migration tool written in Python.
 

src/flux/backend/base.py

@@ -2,12 +2,14 @@
 from contextlib import asynccontextmanager
 
 from flux.backend.applied_migration import AppliedMigration
+from flux.config import FluxConfig
+from flux.migration.migration import Migration
 
 
 class MigrationBackend(ABC):
 
     @classmethod
-    def from_config(cls, config: dict) -> "MigrationBackend":
+    def from_config(cls, config: FluxConfig) -> "MigrationBackend":
         """
         Create a MigrationBackend from a configuration
 
@@ -52,21 +54,23 @@ async def migration_lock(self):
         yield
 
     @abstractmethod
-    async def register_migration(self, migration: str):
+    async def register_migration(self, migration: Migration) -> AppliedMigration:
         """
         Register a migration as applied (when up-migrated)
         """
 
     @abstractmethod
-    async def unregister_migration(self, migration: str):
+    async def unregister_migration(self, migration: Migration):
         """
         Unregister a migration (when down-migrated)
         """
 
     @abstractmethod
-    async def apply_migration(self, migration: str):
+    async def apply_migration(self, content: str):
         """
-        Apply a migration to the database.
+        Apply the content of a migration to the database. This is used for both
+        up and down migrations so should not register or unregister the
+        migration hash.
         """
 
     @abstractmethod

src/flux/backend/builtin/sqlite.py

@@ -4,6 +4,7 @@
 
 @dataclass
 class Migration:
+    id: str
     up: str
     down: str | None
 

src/flux/migration/migration.py

@@ -1,19 +1,25 @@
+import os
+
+from flux.config import FluxConfig
 from flux.exceptions import InvalidMigrationModuleError
 from flux.migration.migration import Migration
 from flux.migration.temporary_module import temporary_module
 
 
-def read_sql_migration(up_file: str, down_file: str | None) -> Migration:
+def read_sql_migration(*, config: FluxConfig, migration_id: str) -> Migration:
     """
     Read a pair of SQL migration files and return a Migration object
     """
+    up_file = os.path.join(config.migration_directory, f"{migration_id}_up.sql")
+    down_file = os.path.join(config.migration_directory, f"{migration_id}_down.sql")
+
     try:
         with open(up_file) as f:
             up = f.read()
     except Exception as e:
         raise InvalidMigrationModuleError("Error reading up migration") from e
 
-    if down_file is None:
+    if not os.path.exists(down_file):
         down = None
     else:
         try:
@@ -22,13 +28,15 @@ def read_sql_migration(up_file: str, down_file: str | None) -> Migration:
         except Exception as e:
             raise InvalidMigrationModuleError("Error reading down migration") from e
 
-    return Migration(up=up, down=down)
+    return Migration(id=migration_id, up=up, down=down)
 
 
-def read_python_migration(migration_file: str) -> Migration:
+def read_python_migration(*, config: FluxConfig, migration_id: str) -> Migration:
     """
     Read a Python migration file and return a Migration object
     """
+    migration_file = os.path.join(config.migration_directory, f"{migration_id}.py")
+
     with temporary_module(migration_file) as module:
         try:
             up_migration = module.up()
@@ -48,4 +56,4 @@ def read_python_migration(migration_file: str) -> Migration:
         else:
             down_migration = None
 
-    return Migration(up=up_migration, down=down_migration)
+    return Migration(id=migration_id, up=up_migration, down=down_migration)

src/flux/migration/read_migration.py

@@ -1,9 +1,11 @@
 import asyncio
+import datetime as dt
 from contextlib import asynccontextmanager
 from dataclasses import dataclass, field
 
 from flux.backend.applied_migration import AppliedMigration
 from flux.backend.base import MigrationBackend
+from flux.migration.migration import Migration
 
 
 @dataclass
@@ -72,19 +74,27 @@ async def migration_lock(self):
         finally:
             self.migration_lock_active = False
 
-    async def register_migration(self, migration: str):
+    async def register_migration(self, migration: Migration) -> AppliedMigration:
         """
         Register a migration as applied (when up-migrated)
         """
-
-    async def unregister_migration(self, migration: str):
+        applied_migration = AppliedMigration(
+            id=migration.id,
+            hash=migration.up_hash,
+            applied_at=dt.datetime.now(),
+        )
+        self.staged_migrations.add(applied_migration)
+        return applied_migration
+
+    async def unregister_migration(self, migration: Migration):
         """
         Unregister a migration (when down-migrated)
         """
 
-    async def apply_migration(self, migration: str):
+    async def apply_migration(self, content: str):
         """
-        Apply a migration to the database.
+        Apply a migration to the database. This is used for both up and down
+        migrations so should not register or unregister the migration hash.
         """
 
     async def get_applied_migrations(self) -> set[AppliedMigration]:

tests/helpers.py

@@ -0,0 +1,14 @@
+import pytest
+
+from flux.config import FluxConfig
+from tests.unit.constants import MIGRATIONS_DIR
+
+
+@pytest.fixture
+def in_memory_config():
+    return FluxConfig(
+        backend="in_memory",
+        migration_directory=MIGRATIONS_DIR,
+        log_level="DEBUG",
+        backend_config={},
+    )

tests/unit/conftest.py

@@ -0,0 +1 @@
+create table example_table ( id serial primary key, name text );

tests/unit/data/migrations/example_up.sql tests/unit/data/migrations/sql_example_2_up.sql

@@ -1,91 +1,83 @@
-import os
-
 import pytest
 
+from flux.config import FluxConfig
 from flux.exceptions import InvalidMigrationModuleError
 from flux.migration.read_migration import read_python_migration, read_sql_migration
-from tests.unit.constants import MIGRATIONS_DIR
 
-EXAMPLE_SQL_UP = os.path.join(MIGRATIONS_DIR, "example_up.sql")
-EXAMPLE_SQL_DOWN = os.path.join(MIGRATIONS_DIR, "example_down.sql")
-EXAMPLE_PYTHON_DOWN_STR = os.path.join(
-    MIGRATIONS_DIR, "example_python_migration_down_str.py"
-)
-EXAMPLE_PYTHON_DOWN_NONE = os.path.join(
-    MIGRATIONS_DIR, "example_python_migration_down_none.py"
-)
-EXAMPLE_PYTHON_DOWN_MISSING = os.path.join(
-    MIGRATIONS_DIR, "example_python_migration_down_missing.py"
-)
+EXAMPLE_SQL_WITH_DOWN = "sql_example"
+EXAMPLE_SQL_WITHOUT_DOWN = "sql_example_2"
+EXAMPLE_PYTHON_DOWN_STR = "example_python_migration_down_str"
+EXAMPLE_PYTHON_DOWN_NONE = "example_python_migration_down_none"
+EXAMPLE_PYTHON_DOWN_MISSING = "example_python_migration_down_missing"
 
 
-INVALID_PYTHON_DOWN_INT = os.path.join(
-    MIGRATIONS_DIR, "invalid_python_migration_down_int.py"
-)
-INVALID_PYTHON_DOWN_RAISES = os.path.join(
-    MIGRATIONS_DIR, "invalid_python_migration_down_raises.py"
-)
-INVALID_PYTHON_UP_INT = os.path.join(
-    MIGRATIONS_DIR, "invalid_python_migration_up_int.py"
-)
-INVALID_PYTHON_UP_MISSING = os.path.join(
-    MIGRATIONS_DIR, "invalid_python_migration_up_missing.py"
-)
-INVALID_PYTHON_UP_RAISES = os.path.join(
-    MIGRATIONS_DIR, "invalid_python_migration_up_raises.py"
-)
+INVALID_PYTHON_DOWN_INT = "invalid_python_migration_down_int"
+INVALID_PYTHON_DOWN_RAISES = "invalid_python_migration_down_raises"
+INVALID_PYTHON_UP_INT = "invalid_python_migration_up_int"
+INVALID_PYTHON_UP_MISSING = "invalid_python_migration_up_missing"
+INVALID_PYTHON_UP_RAISES = "invalid_python_migration_up_raises"
 
 EXAMPLE_UP_TEXT = "create table example_table ( id serial primary key, name text );"
 EXAMPLE_DOWN_TEXT = "drop table example_table;"
 
 
-def test_read_sql_migration_with_down():
-    migration = read_sql_migration(EXAMPLE_SQL_UP, EXAMPLE_SQL_DOWN)
+def test_read_sql_migration_with_down(in_memory_config: FluxConfig):
+    migration = read_sql_migration(
+        config=in_memory_config,
+        migration_id=EXAMPLE_SQL_WITH_DOWN,
+    )
     assert migration.up == f"{EXAMPLE_UP_TEXT}\n"
     assert migration.down == f"{EXAMPLE_DOWN_TEXT}\n"
     assert migration.up_hash == "a53b94e10e61374e5a20f9e361d638e2"
 
 
-def test_read_sql_migration_without_down():
-    migration = read_sql_migration(EXAMPLE_SQL_UP, None)
+def test_read_sql_migration_without_down(in_memory_config: FluxConfig):
+    migration = read_sql_migration(
+        config=in_memory_config,
+        migration_id=EXAMPLE_SQL_WITHOUT_DOWN,
+    )
     assert migration.up == f"{EXAMPLE_UP_TEXT}\n"
     assert migration.down is None
     assert migration.up_hash == "a53b94e10e61374e5a20f9e361d638e2"
 
 
-def test_read_sql_migration_with_up_not_exist():
-    with pytest.raises(InvalidMigrationModuleError):
-        read_sql_migration("fake.sql", EXAMPLE_SQL_DOWN)
-
-
-def test_read_sql_migration_with_down_not_exist():
+def test_read_sql_migration_not_exist(in_memory_config: FluxConfig):
     with pytest.raises(InvalidMigrationModuleError):
-        read_sql_migration(EXAMPLE_SQL_UP, "fake.sql")
+        read_sql_migration(config=in_memory_config, migration_id="fake")
 
 
-def test_read_python_migration_down_str():
-    migration = read_python_migration(EXAMPLE_PYTHON_DOWN_STR)
+def test_read_python_migration_down_str(in_memory_config: FluxConfig):
+    migration = read_python_migration(
+        config=in_memory_config,
+        migration_id=EXAMPLE_PYTHON_DOWN_STR,
+    )
     assert migration.up == f"{EXAMPLE_UP_TEXT}"
     assert migration.down == f"{EXAMPLE_DOWN_TEXT}"
     assert migration.up_hash == "2ea715441b43f1bdc8428238385bb592"
 
 
-def test_read_python_migration_down_none():
-    migration = read_python_migration(EXAMPLE_PYTHON_DOWN_NONE)
+def test_read_python_migration_down_none(in_memory_config: FluxConfig):
+    migration = read_python_migration(
+        config=in_memory_config,
+        migration_id=EXAMPLE_PYTHON_DOWN_NONE,
+    )
     assert migration.up == f"{EXAMPLE_UP_TEXT}"
     assert migration.down is None
     assert migration.up_hash == "2ea715441b43f1bdc8428238385bb592"
 
 
-def test_read_python_migration_down_missing():
-    migration = read_python_migration(EXAMPLE_PYTHON_DOWN_MISSING)
+def test_read_python_migration_down_missing(in_memory_config: FluxConfig):
+    migration = read_python_migration(
+        config=in_memory_config,
+        migration_id=EXAMPLE_PYTHON_DOWN_MISSING,
+    )
     assert migration.up == f"{EXAMPLE_UP_TEXT}"
     assert migration.down is None
     assert migration.up_hash == "2ea715441b43f1bdc8428238385bb592"
 
 
 @pytest.mark.parametrize(
-    "migration_file",
+    "migration_id",
     [
         INVALID_PYTHON_DOWN_INT,
         INVALID_PYTHON_DOWN_RAISES,
@@ -94,6 +86,6 @@ def test_read_python_migration_down_missing():
         INVALID_PYTHON_UP_RAISES,
     ],
 )
-def test_read_python_migration_invalid(migration_file):
+def test_read_python_migration_invalid(in_memory_config: FluxConfig, migration_id: str):
     with pytest.raises(InvalidMigrationModuleError):
-        read_python_migration(migration_file)
+        read_python_migration(config=in_memory_config, migration_id=migration_id)