feat: add migrate data and schema options

Author: svazquezco

.gitignore

@@ -168,6 +168,6 @@ cython_debug/
 .idea
 
 # Specific project gitignore
-migrations
+migrations/
 .migrations-state.json
 settings.py

Dockerfile

@@ -1,9 +1,9 @@
 FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS base
 
-COPY pyproject.toml uv.lock README.md ./mpt_tool/
-
 WORKDIR /mpt_tool
 
+COPY . ./
+
 RUN uv venv /opt/venv
 
 ENV VIRTUAL_ENV=/opt/venv
@@ -13,8 +13,6 @@ FROM base AS build
 
 RUN uv sync --frozen --no-cache --all-groups --active
 
-COPY . .
-
 FROM build AS dev
 
 CMD ["bash"]

makefile

@@ -22,7 +22,7 @@ build:
 	  $(DC) build
 
 check:
-	  $(DC) run --rm app bash -c "ruff format --check . && ruff check . && flake8 . && uv lock --check"
+	  $(DC) run --rm app bash -c "ruff format --check . && ruff check . && flake8 . && mypy . && uv lock --check"
 
 check-all:
 	  $(MAKE) check
@@ -38,7 +38,7 @@ review:
 	  coderabbit review --prompt-only
 
 run:
-	  $(DC) run --rm -it app bash -c "mpt-tool --help && exec bash"
+	  $(DC) run --rm -it app bash -c "mpt-tool migrate --help && exec bash"
 
 test:
 	  $(DC) run --rm app pytest $(if $(args),$(args),.)

mpt_tool/cli.py

@@ -1,10 +1,15 @@
 import datetime as dt
+import logging
 from pathlib import Path
+from typing import Annotated
 
 import typer
 
 from mpt_tool.constants import MIGRATION_FOLDER
+from mpt_tool.enums import MigrationTypeEnum
+from mpt_tool.errors import RunMigrationError
 from mpt_tool.templates import MIGRATION_SCAFFOLDING_TEMPLATE
+from mpt_tool.use_cases import RunMigrationsUseCase
 
 app = typer.Typer(help="MPT CLI - Migration tool for extensions.", no_args_is_help=True)
 
@@ -15,26 +20,46 @@ def callback() -> None:
 
 
 @app.command("migrate")
-def migrate(
-    new_data: str | None = typer.Option(  # noqa: WPS404
-        None,
-        "--new-data",
-        metavar="FILENAME",
-        help="Scaffold a new data migration script with the provided filename.",
-    ),
-    new_schema: str | None = typer.Option(  # noqa: WPS404
-        None,
-        "--new-schema",
-        metavar="FILENAME",
-        help="Scaffold a new schema migration script with the provided filename.",
-    ),
+def migrate(  # noqa: C901, WPS238, WPS210, WPS213, WPS231
+    data: Annotated[bool, typer.Option("--data", help="Run data migrations.")] = False,  # noqa: FBT002
+    schema: Annotated[bool, typer.Option("--schema", help="Run schema migrations.")] = False,  # noqa: FBT002
+    new_data: Annotated[
+        str | None,
+        typer.Option(
+            "--new-data",
+            metavar="FILENAME",
+            help="Scaffold a new data migration script with the provided filename.",
+        ),
+    ] = None,
+    new_schema: Annotated[
+        str | None,
+        typer.Option(
+            "--new-schema",
+            metavar="FILENAME",
+            help="Scaffold a new schema migration script with the provided filename.",
+        ),
+    ] = None,
 ) -> None:
     """Migrate command."""
-    if new_data and new_schema:
-        raise typer.BadParameter(
-            "Options --new-data and --new-schema cannot be combined.",
-            param_hint="migrate",
-        )
+    options = sum([bool(data), bool(schema), bool(new_data), bool(new_schema)])  # noqa: WPS221
+    if options > 1:
+        raise typer.BadParameter("Only one option can be used.", param_hint="migrate")
+    if not options:
+        raise typer.BadParameter("At least one option must be used.", param_hint="migrate")
+
+    if data or schema:
+        migration_type = MigrationTypeEnum.DATA if data else MigrationTypeEnum.SCHEMA
+        typer.echo(f"Running {migration_type} migrations...")
+
+        run_migration = RunMigrationsUseCase()
+        try:
+            run_migration.execute(migration_type)
+        except RunMigrationError as error:
+            typer.secho(f"Error running migrations: {error!s}", fg=typer.colors.RED)
+            raise typer.Abort
+
+        typer.secho("Migrations completed successfully.", fg=typer.colors.GREEN)
+        return
 
     if new_schema or new_data:
         filename_suffix = new_data or new_schema
@@ -58,11 +83,9 @@ def migrate(
             ),
         )
         typer.secho(f"Migration file: {filename} has been created.", fg=typer.colors.GREEN)
-        return
-
-    typer.secho("Running migrations is not implemented yet.", fg=typer.colors.YELLOW)
 
 
 def main() -> None:
     """Entry point for the CLI."""
+    logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
     app()

mpt_tool/commands/__init__.py

@@ -1,3 +1,4 @@
-from mpt_tool.commands.base import DataBaseCommand, SchemaBaseCommand
+from mpt_tool.commands.data_base import DataBaseCommand
+from mpt_tool.commands.schema_base import SchemaBaseCommand
 
 __all__ = ["DataBaseCommand", "SchemaBaseCommand"]

mpt_tool/commands/base.py

@@ -1,24 +1,25 @@
+import logging
 from abc import ABC, abstractmethod
 
-from mpt_tool.commands.enums import MigrationTypeEnum
+from mpt_tool.enums import MigrationTypeEnum
+
+logger = logging.getLogger(__name__)
 
 
 class BaseCommand(ABC):
     """Abstract base class for all migration commands."""
 
+    _type: MigrationTypeEnum
+
+    def __init__(self):
+        self.log = logger
+
+    @property
+    def type(self) -> MigrationTypeEnum:
+        """The type of migration this command represents."""
+        return self._type
+
     @abstractmethod
     def run(self) -> None:
         """Executes the command."""
         raise NotImplementedError
-
-
-class DataBaseCommand(BaseCommand, ABC):
-    """Base command for data migrations."""
-
-    _type = MigrationTypeEnum.DATA
-
-
-class SchemaBaseCommand(BaseCommand, ABC):
-    """Base command for schema migrations."""
-
-    _type = MigrationTypeEnum.SCHEMA

mpt_tool/commands/data_base.py

@@ -0,0 +1,10 @@
+from abc import ABC
+
+from mpt_tool.commands.base import BaseCommand
+from mpt_tool.enums import MigrationTypeEnum
+
+
+class DataBaseCommand(BaseCommand, ABC):
+    """Base command for data migrations."""
+
+    _type = MigrationTypeEnum.DATA

mpt_tool/commands/schema_base.py

@@ -0,0 +1,10 @@
+from abc import ABC
+
+from mpt_tool.commands.base import BaseCommand
+from mpt_tool.enums import MigrationTypeEnum
+
+
+class SchemaBaseCommand(BaseCommand, ABC):
+    """Base command for schema migrations."""
+
+    _type = MigrationTypeEnum.SCHEMA

mpt_tool/constants.py

@@ -1 +1,2 @@
 MIGRATION_FOLDER: str = "migrations"
+MIGRATION_STATE_FILE: str = ".migrations-state.json"