MPT-16844: add --new-data and --new-schema options to migrate command (#10)

Fist iteration adding --new-data and --new-schema options

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
Closes [MPT-16844](https://softwareone.atlassian.net/browse/MPT-16844)

- Add migrate CLI options --new-data and --new-schema (mutually
exclusive) to scaffold timestamped migration files
- When option provided: determine suffix, ensure migrations folder
exists, create timestamped Python file using
MIGRATION_SCAFFOLDING_TEMPLATE, abort on name collisions, and print
success
- When no option provided: print "Running migrations is not implemented
yet."
- Select scaffold base class by option: DataBaseCommand for data
migrations, SchemaBaseCommand for schema migrations
- Introduce BaseCommand ABC and specialized DataBaseCommand /
SchemaBaseCommand; add MigrationTypeEnum (DATA, SCHEMA); re-export
commands from mpt_tool.commands
- Add MIGRATION_FOLDER constant and MIGRATION_SCAFFOLDING_TEMPLATE (and
template text) in mpt_tool.templates.py
- Tests: add CWD fixture, CLI help, mutual-exclusion validation,
time-frozen parameterized tests for --new-data/--new-schema, scaffold
file creation and collision handling, and BaseCommand subclass checks
- Tooling/CI updates: add freezegun to dev deps; adjust coverage,
flake8, ruff, and pre-commit settings; small Dockerfile and sonar config
tweaks
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

[MPT-16844]:
https://softwareone.atlassian.net/browse/MPT-16844?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: d3rky

.gitignore

@@ -166,3 +166,8 @@ cython_debug/
 .DS_Store
 .ruff_cache
 .idea
+
+# Specific project gitignore
+migrations
+.migrations-state.json
+settings.py

.pre-commit-config.yaml

@@ -34,3 +34,5 @@ repos:
       - id: mypy
         args: ["--config-file=pyproject.toml", "."]
         pass_filenames: false
+        additional_dependencies:
+          - typer

Dockerfile

@@ -1,16 +1,17 @@
 FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS base
 
+COPY pyproject.toml uv.lock ./mpt_tool/
+
 WORKDIR /mpt_tool
 
-COPY pyproject.toml uv.lock ./
 RUN uv venv /opt/venv
 
 ENV VIRTUAL_ENV=/opt/venv
 ENV PATH=/opt/venv/bin:$PATH
 
 FROM base AS build
 
-COPY . /mpt_tool
+COPY . .
 
 RUN uv sync --frozen --no-cache --all-groups --active
 

compose.yaml

@@ -4,6 +4,5 @@ services:
     build:
       context: .
       target: dev
-    working_dir: /mpt_tool
     volumes:
       - .:/mpt_tool

mpt_tool/cli.py

@@ -1,5 +1,11 @@
+import datetime as dt
+from pathlib import Path
+
 import typer
 
+from mpt_tool.constants import MIGRATION_FOLDER
+from mpt_tool.templates import MIGRATION_SCAFFOLDING_TEMPLATE
+
 app = typer.Typer(help="MPT CLI - Migration tool for extensions.", no_args_is_help=True)
 
 
@@ -8,10 +14,53 @@ def callback() -> None:
     """MPT CLI - Migration tool for extensions."""
 
 
-@app.command()
-def migrate() -> None:
-    """Run the migration process."""
-    typer.echo("Hello World!")
+@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.",
+    ),
+) -> None:
+    """Migrate command."""
+    if new_data and new_schema:
+        raise typer.BadParameter(
+            "Options --new-data and --new-schema cannot be combined.",
+            param_hint="migrate",
+        )
+
+    if new_schema or new_data:
+        filename_suffix = new_data or new_schema
+        typer.echo(f"Scaffolding migration: {filename_suffix}.")
+        migration_folder = Path(MIGRATION_FOLDER)
+        migration_folder.mkdir(parents=True, exist_ok=True)
+        timestamp = dt.datetime.now(tz=dt.UTC).strftime("%Y%m%d%H%M%S")
+        # TODO: add filename validation
+        filename = f"{timestamp}_{filename_suffix}.py"
+        full_filename_path = migration_folder / filename
+        try:
+            full_filename_path.touch(exist_ok=False)
+        except FileExistsError:
+            typer.secho(f"File already exists: {filename}", fg=typer.colors.RED)
+            raise typer.Abort
+
+        full_filename_path.write_text(
+            encoding="utf-8",
+            data=MIGRATION_SCAFFOLDING_TEMPLATE.substitute(
+                command_name="DataBaseCommand" if new_data else "SchemaBaseCommand"
+            ),
+        )
+        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:

mpt_tool/commands/__init__.py

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

mpt_tool/commands/base.py

@@ -0,0 +1,24 @@
+from abc import ABC, abstractmethod
+
+from mpt_tool.commands.enums import MigrationTypeEnum
+
+
+class BaseCommand(ABC):
+    """Abstract base class for all migration commands."""
+
+    @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/enums.py

@@ -0,0 +1,13 @@
+from enum import StrEnum
+
+
+class MigrationTypeEnum(StrEnum):
+    """Enumeration of migration types.
+
+    Attributes:
+        DATA: Represents a data migration.
+        SCHEMA: Represents a schema migration.
+    """
+
+    DATA = "data"
+    SCHEMA = "schema"

mpt_tool/constants.py

@@ -0,0 +1 @@
+MIGRATION_FOLDER: str = "migrations"

mpt_tool/templates.py

@@ -0,0 +1,12 @@
+from string import Template
+
+MIGRATION_SCAFFOLDING_FILE_TEXT = """\
+from mpt_tool.commands import $command_name
+
+
+class Command($command_name):
+    def run(self):
+        # implement your logic here
+        pass
+"""
+MIGRATION_SCAFFOLDING_TEMPLATE: Template = Template(MIGRATION_SCAFFOLDING_FILE_TEXT)