django-migration-linter/django_migration_linter/management/commands/lintmigrations.py

from __future__ import annotations

import configparser
import itertools
import os
import sys
from importlib import import_module
from typing import Any, Callable

import toml
from django.conf import settings
from django.core.management.base import BaseCommand, CommandParser

from ...constants import __version__
from ...migration_linter import MessageType, MigrationLinter
from ..utils import (
    configure_logging,
    extract_warnings_as_errors_option,
    register_linting_configuration_options,
)

CONFIG_NAME = "django_migration_linter"
PYPROJECT_TOML = "pyproject.toml"
DEFAULT_CONFIG_FILES = (
    f".{CONFIG_NAME}.cfg",
    "setup.cfg",
    "tox.ini",
)


class Command(BaseCommand):
    help = "Lint your migrations"

    def add_arguments(self, parser: CommandParser) -> None:
        parser.add_argument(
            "app_label",
            nargs="?",
            type=str,
            help="App label of an application to lint migrations.",
        )
        parser.add_argument(
            "migration_name",
            nargs="?",
            type=str,
            help="Linting will only be done on that migration only.",
        )
        parser.add_argument(
            "--git-commit-id",
            type=str,
            nargs="?",
            help=(
                "if specified, only migrations since this commit "
                "will be taken into account"
            ),
        )
        parser.add_argument(
            "--ignore-name-contains",
            type=str,
            nargs="?",
            help="ignore migrations containing this name",
        )
        parser.add_argument(
            "--ignore-name",
            type=str,
            nargs="*",
            help="ignore migrations with exactly one of these names",
        )
        parser.add_argument(
            "--include-name-contains",
            type=str,
            nargs="?",
            help="only consider migrations containing this name",
        )
        parser.add_argument(
            "--include-name",
            type=str,
            nargs="*",
            help="only consider migrations with exactly one of these names",
        )
        parser.add_argument(
            "--project-root-path", type=str, nargs="?", help="django project root path"
        )
        parser.add_argument(
            "--include-migrations-from",
            metavar="FILE_PATH",
            type=str,
            nargs="?",
            help="if specified, only migrations listed in the file will be considered",
        )
        cache_group = parser.add_mutually_exclusive_group(required=False)
        cache_group.add_argument(
            "--cache-path",
            type=str,
            help="specify a directory that should be used to store cache-files in.",
        )
        cache_group.add_argument(
            "--no-cache", action="store_true", help="don't use a cache"
        )

        incl_excl_group = parser.add_mutually_exclusive_group(required=False)
        incl_excl_group.add_argument(
            "--include-apps",
            type=str,
            nargs="*",
            help="check only migrations that are in the specified django apps",
        )
        incl_excl_group.add_argument(
            "--exclude-apps",
            type=str,
            nargs="*",
            help="ignore migrations that are in the specified django apps",
        )

        applied_unapplied_migrations_group = parser.add_mutually_exclusive_group(
            required=False
        )
        applied_unapplied_migrations_group.add_argument(
            "--unapplied-migrations",
            action="store_true",
            help="check only migrations have not been applied to the database yet",
        )
        applied_unapplied_migrations_group.add_argument(
            "--applied-migrations",
            action="store_true",
            help="check only migrations that have already been applied to the database",
        )

        parser.add_argument(
            "-q",
            "--quiet",
            nargs="+",
            choices=MessageType.values(),
            help="don't print linting messages to stdout",
        )
        register_linting_configuration_options(parser)

    def handle(self, *args, **options):
        django_settings_options = self.read_django_settings(options)
        config_options = self.read_config_file(options)
        toml_options = self.read_toml_file(options)
        for k, v in itertools.chain(
            django_settings_options.items(),
            config_options.items(),
            toml_options.items(),
        ):
            if not options[k]:
                options[k] = v

        (
            warnings_as_errors_tests,
            all_warnings_as_errors,
        ) = extract_warnings_as_errors_option(options["warnings_as_errors"])

        configure_logging(options["verbosity"])

        root_path = options["project_root_path"] or os.path.dirname(
            import_module(os.getenv("DJANGO_SETTINGS_MODULE")).__file__
        )
        linter = MigrationLinter(
            root_path,
            ignore_name_contains=options["ignore_name_contains"],
            ignore_name=options["ignore_name"],
            include_name_contains=options["include_name_contains"],
            include_name=options["include_name"],
            include_apps=options["include_apps"],
            exclude_apps=options["exclude_apps"],
            database=options["database"],
            cache_path=options["cache_path"],
            no_cache=options["no_cache"],
            only_applied_migrations=options["applied_migrations"],
            only_unapplied_migrations=options["unapplied_migrations"],
            exclude_migration_tests=options["exclude_migration_tests"],
            quiet=options["quiet"],
            warnings_as_errors_tests=warnings_as_errors_tests,
            all_warnings_as_errors=all_warnings_as_errors,
            no_output=options["verbosity"] == 0,
            analyser_string=options["sql_analyser"],
        )
        linter.lint_all_migrations(
            app_label=options["app_label"],
            migration_name=options["migration_name"],
            git_commit_id=options["git_commit_id"],
            migrations_file_path=options["include_migrations_from"],
        )
        linter.print_summary()
        if linter.has_errors:
            sys.exit(1)

    @staticmethod
    def read_django_settings(options: dict[str, Any]) -> dict[str, Any]:
        django_settings_options = dict()

        django_migration_linter_settings = getattr(
            settings, "MIGRATION_LINTER_OPTIONS", dict()
        )
        for key in options:
            if key in django_migration_linter_settings:
                django_settings_options[key] = django_migration_linter_settings[key]

        return django_settings_options

    @staticmethod
    def read_config_file(options: dict[str, Any]) -> dict[str, Any]:
        config_options = dict()

        config_parser = configparser.ConfigParser()
        config_parser.read(DEFAULT_CONFIG_FILES, encoding="utf-8")
        for key, value in options.items():
            config_get_fn: Callable
            if isinstance(value, bool):
                config_get_fn = config_parser.getboolean
            else:
                config_get_fn = config_parser.get

            config_value = config_get_fn(CONFIG_NAME, key, fallback=None)
            if config_value is not None:
                config_options[key] = config_value
        return config_options

    @staticmethod
    def read_toml_file(options: dict[str, Any]) -> dict[str, Any]:
        toml_options = dict()

        if os.path.exists(PYPROJECT_TOML):
            pyproject_toml = toml.load(PYPROJECT_TOML)
            section = pyproject_toml.get("tool", {}).get(CONFIG_NAME, {})
            for key in options:
                if key in section:
                    toml_options[key] = section[key]

        return toml_options

    def get_version(self) -> str:
        return __version__