feat(tests/git): Add tests for FileChanges and ChangeSet classes and related functions

Author: Ishirui

tests/tools/test_git.py

@@ -3,21 +3,26 @@
 # SPDX-License-Identifier: MIT
 from __future__ import annotations
 
+import json
 import os
 import random
+import shutil
 from datetime import datetime
 from typing import TYPE_CHECKING
 
 import pytest
 
 from dda.tools.git import Git
 from dda.utils.fs import Path
+from dda.utils.git.changeset import ChangeSet
 from dda.utils.git.commit import Commit
 from dda.utils.git.sha1hash import SHA1Hash
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Generator
 
+    from _pytest.fixtures import SubRequest
+
     from dda.cli.application import Application
 
 
@@ -180,3 +185,99 @@ def test_get_commit_details(
         assert details.datetime == commit_time
         assert details.message == f"Brand-new commit: {random_key}"
         assert details.parent_shas == [SHA1Hash(parent_sha1)]
+
+
+def _make_repo_changes(
+    git: Git, temp_repo: Path, base_dir: Path, changed_dir: Path, *, commit_end: bool = True
+) -> None:
+    with temp_repo.as_cwd():
+        # Create base commit
+        # -- Copy files from base to temp_repo
+        for file in base_dir.iterdir():
+            shutil.copy(file, temp_repo / file.name)
+        # -- Create commit
+        git.run(["add", "."])
+        git.run(["commit", "-m", "Initial commit"])
+        # Create changed commit
+        # -- Remove all files from temp_repo
+        for file in temp_repo.iterdir():
+            if file.is_file():
+                file.unlink()
+        # -- Copy files from changed to temp_repo
+        for file in changed_dir.iterdir():
+            shutil.copy(file, temp_repo / file.name)
+        # -- Create commit if requested, otherwise leave working tree changes
+        if commit_end:
+            git.run(["add", "."])
+            git.run(["commit", "-m", "Changed commit"])
+
+
+def _load_changeset(filepath: Path) -> ChangeSet:
+    with open(filepath, encoding="utf-8") as f:
+        data = json.load(f)
+    return ChangeSet.from_list(data)
+
+
+REPO_TESTCASES = [path.name for path in (Path(__file__).parent / "testdata" / "repo_states").iterdir()]
+
+
+@pytest.fixture(params=REPO_TESTCASES)
+def repo_setup(app: Application, temp_repo: Path, request: SubRequest) -> tuple[Path, ChangeSet]:
+    git: Git = app.tools.git
+    testdata_dir = Path(__file__).parent / "testdata" / "repo_states"
+    base_dir: Path = testdata_dir / request.param / "base"
+    changed_dir: Path = testdata_dir / request.param / "changed"
+
+    # Make repo changes
+    _make_repo_changes(git, temp_repo, base_dir, changed_dir, commit_end=True)
+
+    # Load expected changeset
+    expected_changeset = _load_changeset(testdata_dir / request.param / "expected_changeset.json")
+
+    return temp_repo, expected_changeset
+
+
+@pytest.fixture(params=REPO_TESTCASES)
+def repo_setup_working_tree(app: Application, temp_repo: Path, request: SubRequest) -> tuple[Path, ChangeSet]:
+    git: Git = app.tools.git
+    testdata_dir = Path(__file__).parent / "testdata" / "repo_states"
+    base_dir: Path = testdata_dir / request.param / "base"
+    changed_dir: Path = testdata_dir / request.param / "changed"
+
+    # Make repo changes
+    _make_repo_changes(git, temp_repo, base_dir, changed_dir, commit_end=False)
+
+    # Load expected changeset
+    expected_changeset = _load_changeset(testdata_dir / request.param / "expected_changeset.json")
+
+    return temp_repo, expected_changeset
+
+
+# These tests are quite slow (the setup fixtures are quite heavy), and mostly replicated in the utils/git/test_changeset.py tests
+# Thus we only run them in CI
+@pytest.mark.requires_ci
+def test_get_commit_changes(app: Application, repo_setup: tuple[Path, ChangeSet]) -> None:
+    git: Git = app.tools.git
+    temp_repo, expected_changeset = repo_setup
+    with temp_repo.as_cwd():
+        changeset = git.get_commit_changes(SHA1Hash(git.capture(["rev-parse", "HEAD"]).strip()))
+        assert changeset.keys() == expected_changeset.keys()
+        for file in changeset:
+            seen, expected = changeset[file], expected_changeset[file]
+            assert seen.file == expected.file
+            assert seen.type == expected.type
+            assert seen.patch == expected.patch
+
+
+@pytest.mark.requires_ci
+def test_get_working_tree_changes(app: Application, repo_setup_working_tree: tuple[Path, ChangeSet]) -> None:
+    git: Git = app.tools.git
+    temp_repo, expected_changeset = repo_setup_working_tree
+    with temp_repo.as_cwd():
+        changeset = git.get_working_tree_changes()
+        assert changeset.keys() == expected_changeset.keys()
+        for file in changeset:
+            seen, expected = changeset[file], expected_changeset[file]
+            assert seen.file == expected.file
+            assert seen.type == expected.type
+            assert seen.patch == expected.patch

tests/tools/testdata/repo_states/complex_changes/base/file1.txt

@@ -0,0 +1,3 @@
+I am file1 !
+I won't change at all.
+I guess that means I'm perfect as it is :)

tests/tools/testdata/repo_states/complex_changes/base/file2.txt

@@ -0,0 +1,4 @@
+I am file2 !
+I feel like I take up space for nothing...
+I have a feeling like I won't exist pretty soon :/
+

tests/tools/testdata/repo_states/complex_changes/base/file4.txt

@@ -0,0 +1,8 @@
+I am file4.
+People often tell me I am unreliable.
+Things like:
+- You always change !
+- I can never count on you...
+- I didn't recognize you !
+Do you think they have a point ?
+I'd need to look at my own history to know...

tests/tools/testdata/repo_states/complex_changes/base/file5.txt

@@ -0,0 +1,5 @@
+I am a humble file.
+Soon I will change name.
+I think I'll also take this as an opportunity to change myself.
+New name, new me !
+Or is that not how the saying goes ?

tests/tools/testdata/repo_states/complex_changes/changed/file1.txt

@@ -0,0 +1,3 @@
+I am file1 !
+I won't change at all.
+I guess that means I'm perfect as it is :)

tests/tools/testdata/repo_states/complex_changes/changed/file3.txt

@@ -0,0 +1,2 @@
+I am file3 !
+I'm new around here, hopefully everyone treats me nice :)

tests/tools/testdata/repo_states/complex_changes/changed/file4.txt

@@ -0,0 +1,9 @@
+I am file4.
+People often tell me I am THE BEST.
+Things like:
+- You rock !
+- I wish I were you !
+Do you think they have a point ?
+Pah ! Who am I kidding, they're OBVIOUSLY RIGHT.
+Arrogance ? What is that, an italian ice cream flavor ?
+Get outta here !

tests/tools/testdata/repo_states/complex_changes/changed/file5_new.txt

@@ -0,0 +1,5 @@
+I am a humble file.
+Soon I will change name.
+I think I'll also take this as an opportunity to change myself.
+New name, new me !
+Or is that not how the saying goes ?

tests/tools/testdata/repo_states/complex_changes/diff_output.txt

@@ -0,0 +1,58 @@
+diff --git file2.txt file2.txt
+deleted file mode 100644
+index 70e6734..0000000
+--- file2.txt
++++ /dev/null
+@@ -1,4 +0,0 @@
+-I am file2 !
+-I feel like I take up space for nothing...
+-I have a feeling like I won't exist pretty soon :/
+-
+diff --git file3.txt file3.txt
+new file mode 100644
+index 0000000..1c54fdf
+--- /dev/null
++++ file3.txt
+@@ -0,0 +1,2 @@
++I am file3 !
++I'm new around here, hopefully everyone treats me nice :)
+diff --git file4.txt file4.txt
+index 73fa5d6..307c4c9 100644
+--- file4.txt
++++ file4.txt
+@@ -2 +2 @@ I am file4.
+-People often tell me I am unreliable.
++People often tell me I am THE BEST.
+@@ -4,3 +4,2 @@ Things like:
+-- You always change !
+-- I can never count on you...
+-- I didn't recognize you !
++- You rock !
++- I wish I were you !
+@@ -8 +7,3 @@ Do you think they have a point ?
+-I'd need to look at my own history to know...
++Pah ! Who am I kidding, they're OBVIOUSLY RIGHT.
++Arrogance ? What is that, an italian ice cream flavor ?
++Get outta here !
+diff --git file5.txt file5.txt
+deleted file mode 100644
+index bf6c86e..0000000
+--- file5.txt
++++ /dev/null
+@@ -1,5 +0,0 @@
+-I am a humble file.
+-Soon I will change name.
+-I think I'll also take this as an opportunity to change myself.
+-New name, new me !
+-Or is that not how the saying goes ?
+diff --git file5_new.txt file5_new.txt
+new file mode 100644
+index 0000000..bf6c86e
+--- /dev/null
++++ file5_new.txt
+@@ -0,0 +1,5 @@
++I am a humble file.
++Soon I will change name.
++I think I'll also take this as an opportunity to change myself.
++New name, new me !
++Or is that not how the saying goes ?