mpt-tool 5.0.0__py3-none-any.whl → 5.1.0__py3-none-any.whl

mpt_tool/cli.py

@@ -18,6 +18,9 @@ def callback() -> None:
 @app.command("migrate")
 def migrate(  # noqa: WPS211
     ctx: typer.Context,
+    check: Annotated[  # noqa: FBT002
+        bool, typer.Option("--check", help="Check for duplicate migration_id in migrations.")
+    ] = False,
     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
     fake: Annotated[

mpt_tool/commands/check.py

@@ -0,0 +1,22 @@
+from typing import override
+
+from mpt_tool.commands.base import BaseCommand
+from mpt_tool.use_cases import CheckMigrationsUseCase
+
+
+class CheckCommand(BaseCommand):
+    """Checks migrations for duplicate migration_id."""
+
+    @override
+    @property
+    def start_message(self) -> str:
+        return "Checking migrations..."
+
+    @override
+    @property
+    def success_message(self) -> str:
+        return "Migrations check passed successfully."
+
+    @override
+    def run(self) -> None:
+        CheckMigrationsUseCase().execute()

mpt_tool/commands/factory.py

@@ -3,6 +3,7 @@ from typing import cast
 from mpt_tool.commands.base import (
     BaseCommand,
 )
+from mpt_tool.commands.check import CheckCommand
 from mpt_tool.commands.data import DataCommand
 from mpt_tool.commands.errors import CommandNotFoundError
 from mpt_tool.commands.fake import FakeCommand
@@ -28,7 +29,9 @@ class CommandFactory:
         Raises:
             CommandNotFoundError: If no command is found.
         """
-        match param_data:
+        match param_data:  # noqa: WPS242
+            case {"check": True}:
+                return CheckCommand()
             case {"data": True}:
                 return DataCommand()
             case {"schema": True}:

mpt_tool/config.py

@@ -4,9 +4,9 @@ import os
 def get_airtable_config(config_key: str) -> str | None:
     """Get Airtable configuration."""
     config = {
-        "api_key": os.getenv("AIRTABLE_API_KEY"),
-        "base_id": os.getenv("STORAGE_AIRTABLE_BASE_ID"),
-        "table_name": os.getenv("STORAGE_AIRTABLE_TABLE_NAME", "Migrations"),
+        "api_key": os.getenv("MPT_TOOL_STORAGE_AIRTABLE_API_KEY"),
+        "base_id": os.getenv("MPT_TOOL_STORAGE_AIRTABLE_BASE_ID"),
+        "table_name": os.getenv("MPT_TOOL_STORAGE_AIRTABLE_TABLE_NAME", "Migrations"),
     }
     return config.get(config_key)
 
@@ -19,4 +19,4 @@ def get_mpt_config(config_key: str) -> str | None:
 
 def get_storage_type() -> str:
     """Get storage type."""
-    return os.getenv("STORAGE_TYPE", "local")
+    return os.getenv("MPT_TOOL_STORAGE_TYPE", "local")

mpt_tool/migration/mixins/airtable_client.py

@@ -8,7 +8,7 @@ from mpt_tool.config import get_airtable_config
 class AirtableAPIClientMixin:
     """Mixin to add Airtable API client to commands.
 
-    The API key is read from the environment variable AIRTABLE_API_KEY.
+    The API key is read from the environment variable MPT_TOOL_STORAGE_AIRTABLE_API_KEY.
     """
 
     @cached_property
@@ -24,6 +24,8 @@ class AirtableAPIClientMixin:
         """
         airtable_api_key = get_airtable_config("api_key")
         if not airtable_api_key:
-            raise ValueError("Airtable API key must be set in env variable AIRTABLE_API_KEY")
+            raise ValueError(
+                "Airtable API key must be set in env variable MPT_TOOL_STORAGE_AIRTABLE_API_KEY"
+            )
 
         return AirtableClient(airtable_api_key)

mpt_tool/use_cases/__init__.py

@@ -1,10 +1,12 @@
 from mpt_tool.use_cases.apply_migration import ApplyMigrationUseCase
+from mpt_tool.use_cases.check_migrations import CheckMigrationsUseCase
 from mpt_tool.use_cases.list_migrations import ListMigrationsUseCase
 from mpt_tool.use_cases.new_migration import NewMigrationUseCase
 from mpt_tool.use_cases.run_migrations import RunMigrationsUseCase
 
 __all__ = [
     "ApplyMigrationUseCase",
+    "CheckMigrationsUseCase",
     "ListMigrationsUseCase",
     "NewMigrationUseCase",
     "RunMigrationsUseCase",

mpt_tool/use_cases/check_migrations.py

@@ -0,0 +1,42 @@
+from collections import Counter
+
+from mpt_tool.managers import FileMigrationManager
+from mpt_tool.managers.errors import MigrationFolderError
+from mpt_tool.use_cases.errors import CheckMigrationError
+
+
+class CheckMigrationsUseCase:
+    """Use case for checking migrations for duplicate migration_id."""
+
+    def __init__(self, file_migration_manager: FileMigrationManager | None = None):
+        self.file_migration_manager = file_migration_manager or FileMigrationManager()
+
+    def execute(self) -> None:  # noqa: WPS210
+        """Check for duplicate migration_id in migration files.
+
+        Raises:
+            CheckMigrationError: If duplicate migration_id is found or a migration folder
+                error occurs.
+        """
+        try:
+            migration_files = self.file_migration_manager.retrieve_migration_files()
+        except MigrationFolderError as error:
+            raise CheckMigrationError(str(error)) from error
+
+        if not migration_files:
+            return
+
+        migration_id_counter = Counter(migration.migration_id for migration in migration_files)
+        duplicated_migration_ids = [
+            migration_id for migration_id, count in migration_id_counter.items() if count > 1
+        ]
+
+        if duplicated_migration_ids:
+            duplicate_migrations = [
+                migration.file_name
+                for migration in migration_files
+                if migration.migration_id in duplicated_migration_ids
+            ]
+            migrations_list = ", ".join(duplicate_migrations)
+            error_message = f"Duplicate migration_id found in migrations: {migrations_list}"
+            raise CheckMigrationError(error_message)

mpt_tool/use_cases/errors.py

@@ -5,13 +5,17 @@ class UseCaseError(BaseError):
     """Base error for use cases."""
 
 
+class ApplyMigrationError(UseCaseError):
+    """Error applying migration."""
+
+
+class CheckMigrationError(UseCaseError):
+    """Error checking migrations."""
+
+
 class NewMigrationError(UseCaseError):
     """Error creating new migration."""
 
 
 class RunMigrationError(UseCaseError):
     """Error running migration."""
-
-
-class ApplyMigrationError(UseCaseError):
-    """Error applying migration."""

{mpt_tool-5.0.0.dist-info → mpt_tool-5.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mpt-tool
-Version: 5.0.0
+Version: 5.1.0
 Summary: Migration tool for extensions
 Author: SoftwareOne AG
 License: Apache-2.0 license
@@ -51,10 +51,10 @@ Install with pip or your favorite PyPI package manager:
 ## Environment Variables
 
 The tool uses the following environment variables:
-- `STORAGE_TYPE`: Storage backend for migration state (`local` or `airtable`, default: `local`). See [Storage Configuration](#storage)
-- `MPT_API_TOKEN`: Your MPT API key (required when using `MPTAPIClientMixin`)
 - `MPT_API_BASE_URL`: The MPT API base url (required when using `MPTAPIClientMixin`)
-- `AIRTABLE_API_KEY`: Your Airtable API key (required when using `AirtableAPIClientMixin` or when `STORAGE_TYPE=airtable`)
+- `MPT_API_TOKEN`: Your MPT API key (required when using `MPTAPIClientMixin`)
+- `MPT_TOOL_STORAGE_TYPE`: Storage backend for migration state (`local` or `airtable`, default: `local`). See [Storage Configuration](#storage)
+- `MPT_TOOL_STORAGE_AIRTABLE_API_KEY`: Your Airtable API key (required when using `AirtableAPIClientMixin` or when `MPT_TOOL_STORAGE_TYPE=airtable`)
 
 ## Configuration
 
@@ -73,9 +73,9 @@ No additional configuration is required.
 #### Airtable Storage
 
 Airtable configuration is done via environment variables:
-- `AIRTABLE_API_KEY`: Your Airtable API key
-- `STORAGE_AIRTABLE_BASE_ID`: Your Airtable base ID
-- `STORAGE_AIRTABLE_TABLE_NAME`: The name of the table to store migration state
+- `MPT_TOOL_STORAGE_AIRTABLE_API_KEY`: Your Airtable API key
+- `MPT_TOOL_STORAGE_AIRTABLE_BASE_ID`: Your Airtable base ID
+- `MPT_TOOL_STORAGE_AIRTABLE_TABLE_NAME`: The name of the table to store migration state
 
 Your Airtable table must have the following columns:
 
@@ -148,6 +148,28 @@ class Migration(DataBaseMigration, MPTAPIClientMixin, AirtableAPIClientMixin):
         self.log.info(f"Processed {len(records)} records")
 ```
 
+### Checking Migrations
+Before running migrations, you can validate your migration folder for issues:
+
+```bash
+  mpt-tool migrate --check
+```
+
+This command:
+- Verifies the migration folder structure
+- Detects duplicate migration_id values (which could happen if migrations were created with the same name)
+- Exits with code 0 if all checks pass
+- Exits with code 1 and shows a detailed error message if duplicates are found
+
+**Example output when duplicates are found:**
+
+```bash
+Checking migrations...
+Error running check command: Duplicate migration_id found in migrations: 20260113180013_duplicate_name.py, 20260114190014_duplicate_name.py
+```
+
+**Best Practice:** Run `--check` as part of your CI/CD pipeline to catch migration issues before deployment.
+
 ### Running Migrations
 - **Run all pending data migrations:**
   ```bash
@@ -253,6 +275,11 @@ Run `mpt-tool --help` to see all available commands and params:
 
 ## Best Practices
 
+### Migration Validation
+- Run `mpt-tool migrate --check` before committing migration files
+- Include `--check` in your CI/CD pipeline to catch issues early
+- Verify there are no duplicate migration_id values before deployment
+
 ### Migration Naming
 - Use descriptive, snake_case names (e.g., `add_user_table`, `fix_null_emails`, `sync_agreements_from_api`)
 - Keep names concise but meaningful

{mpt_tool-5.0.0.dist-info → mpt_tool-5.1.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 mpt_tool/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpt_tool/cli.py,sha256=RQx1OUoYVSbAYTBYlgFOBGejWutKmSTY8NHzezgwjRI,2464
-mpt_tool/config.py,sha256=X2t2Hh0OHB_4HPwaQXAwatQqgWlhjl7Rm4678Si_YaY,672
+mpt_tool/cli.py,sha256=zJMFNsRWaaJDav2-sQbbA6Ydf0nvMLpMKyKVh_8I-dE,2611
+mpt_tool/config.py,sha256=U9YWajFcG36EGvFpYiOecmVqMGUYZb246NgHT_xQGEw,716
 mpt_tool/constants.py,sha256=i3jnIAFT8XXS2Z7iw8VbyWxrmnRq3nMklMfwDgmOkxI,147
 mpt_tool/enums.py,sha256=ElHflGP0c0Jq4PqxD3YISgdWa-hgkkd8aqD7cv5nUBc,1143
 mpt_tool/errors.py,sha256=_u1vgUwTNj-IF7b4VJiYOkv4vgD48jMHpMYpOgGkugQ,167
@@ -10,9 +10,10 @@ mpt_tool/renders.py,sha256=RLAQyxoLH7zCCJO62J90oAAurTMIVeyR_NNQLrb6sLk,1234
 mpt_tool/templates.py,sha256=9-_M7Diy50D5Io0sC1Ez9ez4fNxFRMXSkIQ_7XcK95Y,308
 mpt_tool/commands/__init__.py,sha256=UNBsxkGf4MC7tIsOHHP4leo1exBDv8MAJZY_VizZGAY,175
 mpt_tool/commands/base.py,sha256=EfhyJm-37NMN4yu9gXFAbWuU2_7gsEKEYpKewegT0o8,752
+mpt_tool/commands/check.py,sha256=jSQWkDoc7Z7Jg3zmRvJicUzuWL64zcWaY9xXMDMiwfU,533
 mpt_tool/commands/data.py,sha256=Q_1t0QqUNrBe9h13UXkvkh12ld2EYAXVf0E_oWC36Qk,597
 mpt_tool/commands/errors.py,sha256=yYsGZovbm-HN9dyuAcYXZhSPixwdiytUzqN18De-k3I,183
-mpt_tool/commands/factory.py,sha256=-99SI-s_gzkxlRwbGKJ-tT84Mih8caUpd9kC6rvlLNE,1699
+mpt_tool/commands/factory.py,sha256=rBvEY1vWG5LpEJXgtKy9W37rp5P3x1W-MJ7Pkbk9U1M,1836
 mpt_tool/commands/fake.py,sha256=O3ASK5b7Henwh9AcIujzDM84ZUzkOEuQ_HuACe_94CI,711
 mpt_tool/commands/list.py,sha256=V_rBSfpfcRNCDry-3xvj-joWu0S3VVsmm3n4nQwueDA,874
 mpt_tool/commands/new_data.py,sha256=Ls9S3s4eCNmkpieAlXSWNGDTlIuE3gZ-pynWGMN0sHM,820
@@ -33,16 +34,17 @@ mpt_tool/migration/base.py,sha256=gbvfJwLnvQsOG_gWXTMGIvkxwrEFTKFAPovZeAz89jA,57
 mpt_tool/migration/data_base.py,sha256=EZIAXhriXr61Gu-6ZbRbvhAnRv5zysQDX9Gco3BNP6E,243
 mpt_tool/migration/schema_base.py,sha256=u3XH-OKii1p4jwMjdI92w5Q71YZ07s2FI4bDDC_FtfQ,249
 mpt_tool/migration/mixins/__init__.py,sha256=qvWJfFqTzphAgR5vrTC1qzzWvrDTWKhtiWGpWS4kq1I,203
-mpt_tool/migration/mixins/airtable_client.py,sha256=1Al-JcUI1svZV8L9nuxzvP9tZGqvfOBVMwPZ904Hfp4,805
+mpt_tool/migration/mixins/airtable_client.py,sha256=EWsZi3SlUvHm3gUEeU-lZ6cIFa3nWAttN2JqMrCG1-Q,869
 mpt_tool/migration/mixins/mpt_client.py,sha256=oUQUi0usC85Z9aCzaFM8UzRrxnGGrcf3cj0DfYzm24E,909
-mpt_tool/use_cases/__init__.py,sha256=27zQVYF4GIVufBAwuQlf-ESSJAjPotGxr9kwho3vyzI,398
+mpt_tool/use_cases/__init__.py,sha256=vujepn0mgQj9nmNPI9o2yTC4Ok2xjXmDIqCiks14G-U,499
 mpt_tool/use_cases/apply_migration.py,sha256=nZXdESTQYKGbBbfA2CoKb_d_x8K8bMker7-DJ1rvklc,1745
-mpt_tool/use_cases/errors.py,sha256=Rn_5P9XF5sELX7IXlqdX7I47zsD1JbadzLMYMa_ruP4,343
+mpt_tool/use_cases/check_migrations.py,sha256=k3kbAp9ipiBNDcZ3J3poMSRGQlgsZv4SdX7sG3gg5tE,1683
+mpt_tool/use_cases/errors.py,sha256=qcuI2Waeqi0Pwn1CyVTO2gN6lWWLLNHMob5YQi-V5gY,423
 mpt_tool/use_cases/list_migrations.py,sha256=a4Otx6IL5EkqU-iwWjYEaFdD8eR4Zha7GDmQMRjVhuw,1427
 mpt_tool/use_cases/new_migration.py,sha256=pNHrOamGPupyGb7s9_P1B0-r_ooNDqcYpU0oiGNt2HU,860
 mpt_tool/use_cases/run_migrations.py,sha256=iHGnUEuUKRWo_ZgvUQFfsUIaAtCAZvWW0pbf60j8dzM,3798
-mpt_tool-5.0.0.dist-info/METADATA,sha256=4im9i9bXu5JWiUTAuO26r_wYap48UzqXjaBBLEjqMPQ,10111
-mpt_tool-5.0.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-mpt_tool-5.0.0.dist-info/entry_points.txt,sha256=ouNlQh2WYlerppVMgMkkTQKoEDlgAczOhCMhDQMhu-0,47
-mpt_tool-5.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-mpt_tool-5.0.0.dist-info/RECORD,,
+mpt_tool-5.1.0.dist-info/METADATA,sha256=MGjMyvJzgAKJiCONy5-HqlbZmXFXUDzAEBco42MBLGE,11167
+mpt_tool-5.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+mpt_tool-5.1.0.dist-info/entry_points.txt,sha256=ouNlQh2WYlerppVMgMkkTQKoEDlgAczOhCMhDQMhu-0,47
+mpt_tool-5.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+mpt_tool-5.1.0.dist-info/RECORD,,