Increased test coverage (#85)

jackton1 · pre-commit-ci[bot] · web-flow · commit 07eba4440965 · 2021-07-09T16:24:43.000-04:00
Co-authored-by: pre-commit-ci[bot] &lt;66853113+pre-commit-ci[bot]@users.noreply.github.com&gt;
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -49,6 +49,8 @@ jobs:
         run: |
           git fetch origin feature/migration-test-01:feature/migration-test-01
           git fetch origin feature/migration-test-02:feature/migration-test-02
+          git fetch origin feature/migration-test-03:feature/migration-test-03
+          git fetch origin feature/migration-test-04:feature/migration-test-04
         working-directory: migration_fixer/tests/demo
 
       - name: Install dependencies
@@ -60,24 +62,11 @@ jobs:
           git checkout feature/migration-test-01
         working-directory: migration_fixer/tests/demo
 
-      - name: Run test_01
+      - name: Run test
         run: make tox
         env:
           CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
           PLATFORM: ${{ matrix.platform }}
-          ENV: test_01
-
-      - name: Checkout feature/migration-test-01
-        run: |
-          git checkout feature/migration-test-01
-        working-directory: migration_fixer/tests/demo
-
-      - name: Run test_02
-        run: make tox
-        env:
-          CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
-          PLATFORM: ${{ matrix.platform }}
-          ENV: test_02
 
       - name: Run codacy-coverage-reporter
         uses: codacy/codacy-coverage-reporter-action@v1
diff --git a/Makefile b/Makefile
@@ -45,6 +45,7 @@ clean-test:  ## remove test and coverage artifacts
 	@rm -f .coverage
 	@rm -fr htmlcov/
 	@rm -fr .pytest_cache
+	@rm -fr .mypy_cache/
 
 clean-docs:  ## remove all doc artifacts
 	@rm -fr site
diff --git a/README.md b/README.md
@@ -115,8 +115,7 @@ jobs:
 *   Resolve migration conflicts on PR branches
 *   Resolve migration conflicts on the default branch **(NOT RECOMMENDED)**
 *   Supports default migration modules i.e (`0001_....py`)
-*   Supports named migration modules i.e (`custom_migration.py`)
-*   Re-nummber all migrations using the last migration on the default branch i.e `main` or `develop`
+*   Re-number all migrations using the last migration on the default branch i.e `main` or `develop`
 
 ## Test Platforms
 
diff --git a/docs/README.md b/docs/README.md
@@ -51,8 +51,7 @@ $ python manage.py makemigrations -b master --fix
 *   Resolve migration conflicts on PR branches
 *   Resolve migration conflicts on the default branch **(NOT RECOMMENDED)**
 *   Supports default migration modules i.e (`0001_....py`)
-*   Supports named migration modules i.e (`custom_migration.py`)
-*   Re-nummber all migrations using the last migration on the default branch i.e `main` or `develop`
+*   Re-number all migrations using the last migration on the default branch i.e `main` or `develop`
 
 ## Example
 
diff --git a/migration_fixer/management/commands/makemigrations.py b/migration_fixer/management/commands/makemigrations.py
@@ -13,11 +13,7 @@
 from django.db.migrations.loader import MigrationLoader
 from git import InvalidGitRepositoryError, Repo
 
-from migration_fixer.utils import (
-    fix_named_migration,
-    fix_numbered_migration,
-    no_translations,
-)
+from migration_fixer.utils import fix_numbered_migration, no_translations
 
 
 class Command(BaseCommand):
@@ -69,8 +65,8 @@ def handle(self, *app_labels, **options):
                         self.stdout.write("Verifying git repository...")
 
                     try:
-                        self.repo.git_dir
-                    except InvalidGitRepositoryError:
+                        self.repo.git_dir and self.repo.head.commit
+                    except (ValueError, InvalidGitRepositoryError):
                         is_git_repo = False
                     else:
                         is_git_repo = True
@@ -87,15 +83,27 @@ def handle(self, *app_labels, **options):
                     if self.verbosity >= 2:
                         self.stdout.write("Retrieving the current branch...")
 
-                    current_branch = self.repo.head.name
+                    current_branch = self.repo.head.ref.name
+
+                    if self.repo.is_dirty():  # pragma: no cover
+                        raise CommandError(
+                            self.style.ERROR(
+                                "Git repository has uncommitted changes. "
+                                "Please commit any outstanding changes."
+                            )
+                        )
 
                     if self.verbosity >= 2:
                         self.stdout.write(
                             f"Fetching git remote origin changes on: {self.default_branch}"
                         )
 
-                    if current_branch == self.default_branch:
-                        self.repo.remotes[self.default_branch].origin.pull()
+                    if current_branch == self.default_branch:  # pragma: no cover
+                        for remote in self.repo.remotes:
+                            remote.pull(
+                                self.default_branch,
+                                force=self.force_update,
+                            )
                     else:
                         for remote in self.repo.remotes:
                             remote.fetch(
@@ -184,16 +192,16 @@ def handle(self, *app_labels, **options):
                                 )
 
                             last_remote = [
-                                fname
-                                for fname in conflict
-                                if fname not in local_filenames
+                                name for name in conflict if name not in local_filenames
                             ]
 
-                            if not last_remote:
+                            if not last_remote:  # pragma: no cover
                                 raise CommandError(
                                     self.style.ERROR(
                                         f"Unable to determine the last migration on: "
-                                        f"{self.default_branch}",
+                                        f"{self.default_branch}. "
+                                        "Please verify the target branch using"
+                                        '"-b [target branch]".',
                                     )
                                 )
 
@@ -221,16 +229,16 @@ def handle(self, *app_labels, **options):
                                         seed=int(seed_split[0]),
                                         start_name=last_remote_filename,
                                         changed_files=changed_files,
+                                        writer=(
+                                            lambda message: self.stdout.write(message)
+                                            if self.verbosity >= 2
+                                            else lambda x: x
+                                        ),
                                     )
-                                else:
-                                    if self.verbosity >= 2:
-                                        self.stdout.write("Fixing named migration...")
-
-                                    fix_named_migration(
-                                        app_label=app_label,
-                                        migration_path=migration_path,
-                                        start_name=last_remote_filename,
-                                        changed_files=changed_files,
+                                else:  # pragma: no cover
+                                    raise ValueError(
+                                        f"Unable to fix migration: {last_remote_filename}. \n"
+                                        f"NOTE: It needs to begin with a number. eg. 0001_*",
                                     )
                             except (ValueError, IndexError, TypeError) as e:
                                 self.stderr.write(f"Error: {e}")
diff --git a/migration_fixer/tests/demo b/migration_fixer/tests/demo
@@ -1 +1 @@
-Subproject commit 09ad91e13e754d0ce7f65141bf4a6b21bd7b0123
+Subproject commit 7c99f0c5f4097b40fc03b632d0aacbf4924e804b
diff --git a/migration_fixer/tests/management/commands/_constants.py b/migration_fixer/tests/management/commands/_constants.py
@@ -0,0 +1,9 @@
+DEFAULT_BRANCH = "main"
+# Single merge to main
+TEST_01_MIGRATION_BRANCH = "feature/migration-test-01"
+# Single merge to main after 01 is merged (single conflict)
+TEST_02_MIGRATION_BRANCH = "feature/migration-test-02"
+# Single merge to main after 01 is merged (multiple conflicts)
+TEST_03_MIGRATION_BRANCH = "feature/migration-test-03"
+# Single merge to main after 01 is merged (named module)
+TEST_04_MIGRATION_BRANCH = "feature/migration-test-04"
diff --git a/migration_fixer/tests/management/commands/_utils.py b/migration_fixer/tests/management/commands/_utils.py
@@ -10,6 +10,7 @@
 def execute_command(cmd, *args, **kwargs):
     out = StringIO()
     kwargs["stdout"] = out
+    kwargs["stderr"] = out
     call_command(cmd, *args, **kwargs)
     output = out.getvalue()
 
diff --git a/migration_fixer/tests/management/commands/conftest.py b/migration_fixer/tests/management/commands/conftest.py
@@ -31,3 +31,11 @@ def git_repo(settings):
 
     with GitRepo(workspace=workspace) as repo:
         yield repo
+
+
+@pytest.fixture
+def invalid_git_repo(settings):
+    workspace = os.path.join(settings.BASE_DIR, "non_existing")
+
+    with GitRepo(workspace=workspace, delete=True) as repo:
+        yield repo
diff --git a/migration_fixer/tests/management/commands/constants.py b/migration_fixer/tests/management/commands/constants.py
diff --git a/migration_fixer/tests/management/commands/test_makemigrations.py b/migration_fixer/tests/management/commands/test_makemigrations.py
@@ -1,18 +1,37 @@
 """Tests for `migration_fixer` package."""
 
 import pytest
+from django.core.management.base import CommandError
 
 from migration_fixer.management.commands.makemigrations import Command
-from migration_fixer.tests.management.commands.constants import (
+from migration_fixer.tests.management.commands._constants import (
     TEST_01_MIGRATION_BRANCH,
     TEST_02_MIGRATION_BRANCH,
+    TEST_03_MIGRATION_BRANCH,
+    TEST_04_MIGRATION_BRANCH,
 )
-from migration_fixer.tests.management.commands.utils import (
+from migration_fixer.tests.management.commands._utils import (
     execute_command,
     temporary_checkout,
 )
 
 
+@pytest.mark.env("invalid_repo")
+@pytest.mark.django_db
+def test_invalid_repo(invalid_git_repo, mocker):
+    mocker.patch(
+        "django.core.management.commands.makemigrations.Command.handle",
+        side_effect=CommandError("Conflicting migrations detected"),
+    )
+    cmd = Command(repo=invalid_git_repo.api)
+    cmd.verbosity = 1
+
+    with pytest.raises(CommandError) as exc_info:
+        execute_command(cmd, fix=True)
+
+    assert "Git repository is not yet setup." in str(exc_info.value)
+
+
 @pytest.mark.env("test_01")
 @pytest.mark.django_db
 def test_run_makemigrations_is_valid_without_any_conflicts(git_repo):
@@ -76,6 +95,8 @@ def test_run_makemigrations_with_fix_is_valid_for_conflicts_verbose(git_repo):
 Retrieving changed files between the current branch and {TEST_01_MIGRATION_BRANCH}
 Retrieving the last migration on: {TEST_01_MIGRATION_BRANCH}
 Fixing numbered migration...
+Updating migration "0002_alter_testmodel_active.py" dependency to 0002_alter_testmodel_age
+Renaming migration "0002_alter_testmodel_active.py" to "0003_alter_testmodel_active.py"
 Successfully fixed migrations.
 """
 
@@ -90,3 +111,71 @@ def test_run_makemigrations_with_fix_is_valid_for_conflicts_verbose(git_repo):
 
     assert target_branch.name == TEST_02_MIGRATION_BRANCH
     assert output == expected_output
+
+
+@pytest.mark.env("test_03")
+@pytest.mark.django_db
+def test_run_makemigrations_with_fix_is_valid_for_multiple_file_conflicts(git_repo):
+    cmd = Command(repo=git_repo.api)
+
+    with temporary_checkout(
+        git_repo,
+        default_branch_name=TEST_01_MIGRATION_BRANCH,
+        target_branch_name=TEST_03_MIGRATION_BRANCH,
+    ) as target_branch:
+        output = execute_command(cmd, default_branch=TEST_01_MIGRATION_BRANCH, fix=True)
+
+    assert target_branch.name == TEST_03_MIGRATION_BRANCH
+    assert output == f"{cmd.success_msg}\n"
+
+
+@pytest.mark.env("test_03")
+@pytest.mark.django_db
+def test_run_makemigrations_with_fix_is_valid_for_multiple_file_conflicts_verbose(
+    git_repo,
+):
+    cmd = Command(repo=git_repo.api)
+    expected_output = f"""Verifying git repository...
+Retrieving the current branch...
+Fetching git remote origin changes on: {TEST_01_MIGRATION_BRANCH}
+Retrieving the last commit sha on: {TEST_01_MIGRATION_BRANCH}
+Retrieving changed files between the current branch and {TEST_01_MIGRATION_BRANCH}
+Retrieving the last migration on: {TEST_01_MIGRATION_BRANCH}
+Fixing numbered migration...
+Updating migration "0002_testmodel_created_by.py" dependency to 0002_alter_testmodel_age
+Renaming migration "0002_testmodel_created_by.py" to "0003_testmodel_created_by.py"
+Updating migration "0003_auto_20210708_1317.py" dependency to 0003_testmodel_created_by
+Renaming migration "0003_auto_20210708_1317.py" to "0004_auto_20210708_1317.py"
+Successfully fixed migrations.
+"""
+
+    with temporary_checkout(
+        git_repo,
+        default_branch_name=TEST_01_MIGRATION_BRANCH,
+        target_branch_name=TEST_03_MIGRATION_BRANCH,
+    ) as target_branch:
+        output = execute_command(
+            cmd, default_branch=TEST_01_MIGRATION_BRANCH, verbosity=2, fix=True
+        )
+
+    assert target_branch.name == TEST_03_MIGRATION_BRANCH
+    assert output == expected_output
+
+
+@pytest.mark.env("test_04")
+@pytest.mark.django_db
+def test_run_makemigrations_fix_with_invlaid_module(git_repo):
+    expected_output = """Error: Unable to fix migration for "demo" app: testmodel_dob.py
+NOTE: It needs to begin with a number. eg. 0001_*
+"""
+    cmd = Command(repo=git_repo.api)
+
+    with temporary_checkout(
+        git_repo,
+        default_branch_name=TEST_01_MIGRATION_BRANCH,
+        target_branch_name=TEST_04_MIGRATION_BRANCH,
+    ) as target_branch:
+        output = execute_command(cmd, default_branch=TEST_01_MIGRATION_BRANCH, fix=True)
+
+    assert target_branch.name == TEST_04_MIGRATION_BRANCH
+    assert expected_output == output
diff --git a/migration_fixer/tests/test_utils.py b/migration_fixer/tests/test_utils.py
@@ -1,8 +1,10 @@
+import pytest
 from django.utils import translation
 
 from migration_fixer.utils import _clean_message, _decode_message, no_translations
 
 
+@pytest.mark.env("utils")
 def test__clean_message():
     message = "New\n\rTest\n\r"
     expected_output = "New\n\rTest"
@@ -12,6 +14,7 @@ def test__clean_message():
     assert expected_output == current_output
 
 
+@pytest.mark.env("utils")
 def test__decode_message():
     encoding = "utf-8"
     message = b"\xe2\x86\x92"
@@ -22,6 +25,7 @@ def test__decode_message():
     assert expected_output == current_output
 
 
+@pytest.mark.env("utils")
 def test_no_translations():
     @no_translations
     def do_not_translate():
diff --git a/migration_fixer/utils.py b/migration_fixer/utils.py
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/tox.ini b/tox.ini
