django-migration-zero 2.1.0__tar.gz → 2.2.0__tar.gz

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/.ambient-package-update/metadata.py

@@ -8,10 +8,11 @@ from ambient_package_update.metadata.constants import (
 from ambient_package_update.metadata.maintainer import PackageMaintainer
 from ambient_package_update.metadata.package import PackageMetadata
 from ambient_package_update.metadata.readme import ReadmeContent
+from ambient_package_update.metadata.ruff_ignored_inspection import RuffIgnoredInspection
 
 METADATA = PackageMetadata(
     package_name="django_migration_zero",
-    module_name="django_migration_zero",
+    github_package_group="ambient-innovation",
     authors=[
         PackageAuthor(
             name="Ambient Digital",
@@ -26,12 +27,14 @@ METADATA = PackageMetadata(
     has_migrations=True,
     readme_content=ReadmeContent(uses_internationalisation=True),
     dependencies=[
-        "Django>=3.2",
+        f"Django>={SUPPORTED_DJANGO_VERSIONS[0]}",
     ],
     supported_django_versions=SUPPORTED_DJANGO_VERSIONS,
     supported_python_versions=SUPPORTED_PYTHON_VERSIONS,
     optional_dependencies={
         "dev": [*DEV_DEPENDENCIES, "unittest-parametrize~=1.3"],
     },
-    ruff_ignore_list=[],
+    ruff_ignore_list=[
+        RuffIgnoredInspection(key="TRY003", comment="Avoid specifying long messages outside the exception class"),
+    ],
 )

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/.github/workflows/ci.yml

@@ -42,12 +42,10 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', ]
+        python-version: ['3.9', '3.10', '3.11', '3.12', ]
         django-version: ['42', '50', ]
 
         exclude:
-          - python-version: '3.8'
-            django-version: 50
           - python-version: '3.9'
             django-version: 50
 
@@ -64,9 +62,9 @@ jobs:
           TOXENV: django${{ matrix.django-version }}
         run: tox
       - name: Upload coverage data
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: coverage-data
+          name: coverage-data-${{ matrix.python-version }}-${{ matrix.django-version }}
           path: '.coverage*'
 
   coverage:
@@ -84,11 +82,12 @@ jobs:
         run: python -m pip install --upgrade coverage[toml]
 
       - name: Download data
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
-          name: coverage-data
+          pattern: coverage-data*
+          merge-multiple: true
 
-      - name: Combine coverage and fail if it's <100%
+      - name: Combine coverage and fail if it's <100.0%
         run: |
           python -m coverage html --skip-covered --skip-empty
           python -m coverage report --fail-under=100.0

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.8
+    rev: v0.5.2
     hooks:
       # Run the Ruff linter.
       - id: ruff
@@ -12,7 +12,7 @@ repos:
       - id: ruff-format
 
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
+    rev: 1.18.0
     hooks:
       - id: blacken-docs
         additional_dependencies:
@@ -23,11 +23,11 @@ repos:
     rev: v3.16.0
     hooks:
       - id: pyupgrade
-        args: [ --py38-plus ]
+        args: [ --py39-plus ]
         stages: [ push ]
 
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.18.0
+    rev: 1.19.0
     hooks:
       - id: django-upgrade
         args: [--target-version, "4.2"]

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/CHANGES.md

@@ -1,5 +1,14 @@
 # Changelog
 
+* *2.2.0* (2024-07-18)
+  * Use ORM to reset `django_migrations` table
+  * Lock rows to enable parallel deployments
+  * Dropped Python 3.8 support
+  * Added multiple ruff linters and updated packages
+  * Updated GitHub actions
+  * Added SECURITY.md
+  * Internal updates via `ambient-package-update`
+
 * *2.1.0* (2024-07-09)
   * Discover apps in nested directories
   * Use `BASE_DIR` instead of `MIGRATION_ZERO_APPS_DIR`

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: django-migration-zero
-Version: 2.1.0
+Name: django_migration_zero
+Version: 2.2.0
 Summary: Holistic implementation of "migration zero" pattern for Django covering local changes and in-production database adjustments.
 Author-email: Ambient Digital <hello@ambient.digital>
 Description-Content-Type: text/markdown
@@ -15,26 +15,26 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
-Requires-Dist: Django>=3.2
+Requires-Dist: Django>=4.2
 Requires-Dist: typer~=0.9 ; extra == "dev"
 Requires-Dist: freezegun~=1.3 ; extra == "dev"
 Requires-Dist: pytest-django~=4.7 ; extra == "dev"
 Requires-Dist: pytest-mock~=3.12 ; extra == "dev"
 Requires-Dist: coverage~=7.3 ; extra == "dev"
-Requires-Dist: pre-commit~=3.5 ; extra == "dev"
-Requires-Dist: ruff~=0.1.7 ; extra == "dev"
+Requires-Dist: pre-commit~=3.7 ; extra == "dev"
+Requires-Dist: ruff~=0.4 ; extra == "dev"
 Requires-Dist: sphinx~=7.1 ; extra == "dev"
 Requires-Dist: sphinx-rtd-theme~=2.0 ; extra == "dev"
 Requires-Dist: m2r2==0.3.3.post2 ; extra == "dev"
 Requires-Dist: mistune<2.0.0 ; extra == "dev"
 Requires-Dist: flit~=3.9 ; extra == "dev"
-Requires-Dist: ambient-package-update~=24.6.4 ; extra == "dev"
+Requires-Dist: keyring~=25.2 ; extra == "dev"
+Requires-Dist: ambient-package-update ; extra == "dev"
 Requires-Dist: unittest-parametrize~=1.3 ; extra == "dev"
 Project-URL: Bugtracker, https://github.com/ambient-innovation/django-migration-zero/issues
 Project-URL: Changelog, https://django-migration-zero.readthedocs.io/en/latest/features/changelog.html

django_migration_zero-2.2.0/SECURITY.md

@@ -0,0 +1,18 @@
+# Reporting Security Issues
+
+The maintainers of this package take security bugs seriously. We appreciate your efforts to responsibly
+disclose your findings, and will make every effort to acknowledge your contributions.
+
+To report a security issue, please use the GitHub Security
+Advisory ["Report a Vulnerability"](https://github.com/ambient-innovation/django-migration-zero/security/advisories/new) 
+tab.
+
+The maintainers will send a response indicating the next steps in handling your report. After the initial reply to
+your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask
+for additional information or guidance.
+
+Report security bugs in third-party modules to the person or team maintaining the module.
+
+## Source
+
+This file was inspired by: https://github.com/electron/electron/blob/main/SECURITY.md

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/django_migration_zero/__init__.py

@@ -3,4 +3,4 @@
 Holistic implementation of "migration zero" pattern for Django covering local changes and in-production database adjustments.
 """
 
-__version__ = "2.1.0"
+__version__ = "2.2.0"

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/django_migration_zero/helpers/file_system.py

@@ -2,7 +2,6 @@ import os
 import re
 from os.path import isdir
 from pathlib import Path
-from typing import List
 
 from django.apps import apps
 from django.apps.config import AppConfig
@@ -20,7 +19,7 @@ def build_migration_directory_path(*, app_path: Path) -> Path:
     return app_path / "migrations"
 
 
-def get_local_django_apps() -> List[AppConfig]:
+def get_local_django_apps() -> list[AppConfig]:
     """
     Iterate all installed Django apps and detect local ones.
     """
@@ -46,7 +45,7 @@ def has_migration_directory(*, app_path: Path) -> bool:
     return True if isdir(possible_migration_dir) else False
 
 
-def get_migration_files(*, app_label: str, app_path: Path, exclude_initials: bool = False) -> List[str]:
+def get_migration_files(*, app_label: str, app_path: Path, exclude_initials: bool = False) -> list[str]:
     """
     Returns a list of all migration files detected in the given Django app.
     """

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/django_migration_zero/managers.py

@@ -1,35 +1,26 @@
+from django.core.exceptions import MultipleObjectsReturned, ObjectDoesNotExist
 from django.db import ProgrammingError, models
 
 from django_migration_zero.exceptions import MissingMigrationZeroConfigRecordError
 from django_migration_zero.helpers.logger import get_logger
 
 
-class MigrationZeroConfigurationQuerySet(models.QuerySet):
-    pass
-
-
 class MigrationZeroConfigurationManager(models.Manager):
     def fetch_singleton(self) -> None:
         logger = get_logger()
         try:
-            number_records = self.count()
+            config_singleton = self.select_for_update().get()
         except ProgrammingError:
             logger.warning(
                 "The migration zero table is missing. This might be ok for the first installation of "
                 '"django-migration-zero" but if you see this warning after that point, something went sideways.'
             )
-            return None
-
-        if number_records > 1:
+            config_singleton = None
+        except MultipleObjectsReturned as e:
             raise MissingMigrationZeroConfigRecordError(
                 "Too many configuration records detected. There can only be one."
-            )
-
-        config_singleton = self.all().first()
-        if not config_singleton:
-            raise MissingMigrationZeroConfigRecordError("No configuration record found in the database.")
+            ) from e
+        except ObjectDoesNotExist as e:
+            raise MissingMigrationZeroConfigRecordError("No configuration record found in the database.") from e
 
         return config_singleton
-
-
-MigrationZeroConfigurationManager = MigrationZeroConfigurationManager.from_queryset(MigrationZeroConfigurationQuerySet)

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/django_migration_zero/services/deployment.py

@@ -1,7 +1,8 @@
 from logging import Logger
 
 from django.core.management import call_command
-from django.db import connections
+from django.db import transaction
+from django.db.migrations.recorder import MigrationRecorder
 
 from django_migration_zero.exceptions import InvalidMigrationTreeError
 from django_migration_zero.helpers.logger import get_logger
@@ -20,6 +21,7 @@ class DatabasePreparationService:
 
         self.logger = get_logger()
 
+    @transaction.atomic
     def process(self):
         self.logger.info("Starting migration zero database adjustments...")
 
@@ -34,8 +36,7 @@ class DatabasePreparationService:
         # records of the other ones
         self.logger.info("Resetting migration history for all apps...")
 
-        with connections["default"].cursor() as cursor:
-            cursor.execute("DELETE FROM `django_migrations`")
+        MigrationRecorder.Migration.objects.all().delete()
 
         # Apply migrations via fake because the database is already up-to-date
         self.logger.info("Populating migration history.")

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/docs/conf.py

@@ -67,8 +67,6 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
-# html_theme = "alabaster"
 html_theme = "sphinx_rtd_theme"
 html_theme_options = {
     "display_version": False,

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["flit_core>=3.4"]
 build-backend = "flit_core.buildapi"
 
 [project]
-name = "django-migration-zero"
+name = "django_migration_zero"
 authors = [
     {'name' = 'Ambient Digital', 'email' = 'hello@ambient.digital'},
 ]
@@ -20,7 +20,6 @@ classifiers = [
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -30,7 +29,7 @@ classifiers = [
 dynamic = ["version", "description"]
 license = {"file" = "LICENSE.md"}
 dependencies = [
-    'Django>=3.2',
+    'Django>=4.2',
 ]
 
 
@@ -41,14 +40,15 @@ dev = [
    'pytest-django~=4.7',
    'pytest-mock~=3.12',
    'coverage~=7.3',
-   'pre-commit~=3.5',
-   'ruff~=0.1.7',
+   'pre-commit~=3.7',
+   'ruff~=0.4',
    'sphinx~=7.1',
    'sphinx-rtd-theme~=2.0',
    'm2r2==0.3.3.post2',
    'mistune<2.0.0',
    'flit~=3.9',
-   'ambient-package-update~=24.6.4',
+   'keyring~=25.2',
+   'ambient-package-update',
    'unittest-parametrize~=1.3',
 ]
 
@@ -74,18 +74,24 @@ lint.select = [
     "DTZ",     # flake8-datetimez
     "DJ",      # flake8-django
     "TD",      # flake8-to-do
-    "RUF100",  # Removes unnecessary "#noqa" comments
+    "RUF",     # Ruff-specific rules
     "YTT",     # Avoid non-future-prove usages of "sys"
-    # "FBT",     # Protects you from the "boolean trap bug"
     "C4",      # Checks for unnecessary conversions
     "PIE",     # Bunch of useful rules
-    # "SIM",     # Simplifies your code
     "INT",     # Validates your gettext translation strings
     "PERF",    # PerfLint
     "PGH",     # No all-purpose "# noqa" and eval validation
     "PL",      # PyLint
+    "LOG",     # flake8-logging
+    "TID",     # flake8-tidy-imports
+    "PLR2004", # Magic numbers
+    "BLE",     # Checks for except clauses that catch all exceptions
+    "ANN401",  # Checks that function arguments are annotated with a more specific type than Any
+    "TRY",     # Clean try/except
+    "ERA",     # Commented out code
 ]
 lint.ignore = [
+    'TRY003', # Avoid specifying long messages outside the exception class
 ]
 
 # Allow autofix for all enabled rules (when `--fix`) is provided.
@@ -100,16 +106,21 @@ lint.fixable = [
     "DTZ",     # flake8-datetimez
     "DJ",      # flake8-django
     "TD",      # flake8-to-do
-    "RUF100",  # Removes unnecessary "#noqa" comments
+    "RUF",     # Ruff-specific rules
     "YTT",     # Avoid non-future-prove usages of "sys"
-    # "FBT",     # Protects you from the "boolean trap bug"
     "C4",      # Checks for unnecessary conversions
     "PIE",     # Bunch of useful rules
-    # "SIM",     # Simplifies your code
     "INT",     # Validates your gettext translation strings
     "PERF",    # PerfLint
     "PGH",     # No all-purpose "# noqa" and eval validation
     "PL",      # PyLint
+    "LOG",     # flake8-logging
+    "TID",     # flake8-tidy-imports
+    "PLR2004", # Magic numbers
+    "BLE",     # Checks for except clauses that catch all exceptions
+    "ANN401",  # Checks that function arguments are annotated with a more specific type than Any
+    "TRY",     # Clean try/except
+    "ERA",     # Commented out code
 ]
 lint.unfixable = []
 
@@ -141,7 +152,7 @@ exclude = [
 line-length = 120
 
 # Allow unused variables when underscore-prefixed.
-dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
 # Assume Python 3.12
 target-version = "py312"
@@ -161,10 +172,6 @@ line-ending = "auto"
 
 [tool.tox]
 legacy_tox_ini = """
-[tox]
-envlist = py{38,39,310,311}-django{32,41,42}
-isolated_build = True
-
 [testenv]
 # Django deprecation overview: https://www.djangoproject.com/download/
 deps =
@@ -176,7 +183,6 @@ commands =
 
 [gh-actions]
 python =
-    3.8: py38
     3.9: py39
     3.10: py310
     3.11: py311

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/tests/services/test_deployment.py

@@ -1,7 +1,9 @@
 from logging import Logger
+from threading import Thread
 from unittest import mock
+from unittest.mock import Mock, call
 
-from django.test import TestCase
+from django.test import TestCase, TransactionTestCase
 from django.utils import timezone
 from freezegun import freeze_time
 
@@ -81,3 +83,56 @@ class DatabasePreparationServiceTest(TestCase):
 
         self.assertEqual(calls[1].args, ("migrate",))
         self.assertEqual(calls[1].kwargs, {"check": True})
+
+
+class DatabasePreparationServiceTestParallelDeployment(TransactionTestCase):
+    @mock.patch("django_migration_zero.services.deployment.get_logger")
+    def test_process_multiple_threads(self, mock_get_logger):
+        """Test parallel deployments to multiple pods."""
+        # Setup
+        mock_logger_info = Mock(return_value=None)
+        mock_get_logger.return_value = Mock(info=mock_logger_info)
+        config, _ = MigrationZeroConfiguration.objects.update_or_create(
+            defaults={
+                "migration_imminent": True,
+                "migration_date": timezone.now().date(),
+            }
+        )
+
+        # Testable
+        number_of_pods = 1
+        threads = [Thread(target=DatabasePreparationService().process) for _ in range(number_of_pods)]
+
+        for thread in threads:
+            thread.start()
+
+        for thread in threads:
+            thread.join()
+
+        # Assertions
+        self.assertEqual(mock_logger_info.call_count, 6 + number_of_pods, msg=mock_logger_info.call_args_list)
+        mock_logger_info.assert_has_calls(
+            [
+                call("Starting migration zero database adjustments..."),
+                call("Resetting migration history for all apps..."),
+                call("Populating migration history."),
+                call("Checking migration integrity."),
+                call("All good."),
+                call("Deactivating migration zero switch in database."),
+                call("Process successfully finished."),
+            ],
+            any_order=True,
+        )
+        self.assertEqual(
+            len(
+                [
+                    mock_call
+                    for mock_call in mock_logger_info.call_args_list
+                    if mock_call == call("Starting migration zero database adjustments...")
+                ]
+            ),
+            number_of_pods,
+        )
+
+        config.refresh_from_db()
+        self.assertFalse(config.migration_imminent)

{django_migration_zero-2.1.0 → django_migration_zero-2.2.0}/tests/test_managers.py

@@ -5,6 +5,7 @@ from django.db import ProgrammingError
 from django.test import TestCase
 
 from django_migration_zero.exceptions import MissingMigrationZeroConfigRecordError
+from django_migration_zero.managers import MigrationZeroConfigurationManager
 from django_migration_zero.models import MigrationZeroConfiguration
 
 
@@ -18,7 +19,7 @@ class MigrationZeroConfigurationManagerTest(TestCase):
     def test_fetch_singleton_singleton_exists_via_migration(self):
         self.assertEqual(MigrationZeroConfiguration.objects.all().count(), 1)
 
-    @mock.patch.object(MigrationZeroConfiguration.objects, "count", side_effect=ProgrammingError)
+    @mock.patch.object(MigrationZeroConfigurationManager, "select_for_update", side_effect=ProgrammingError)
     def test_fetch_singleton_database_error(self, *args):
         self.assertIsNone(MigrationZeroConfiguration.objects.fetch_singleton())