Clean git package repo in tmp

The presence of a git repo for a package in the tmp folder gives the
impression that is has been compiled. We clean it and then move on.

Author: lars-petter-hauge

src/deploy/build.py

@@ -84,11 +84,6 @@ def checkout(self) -> None:
         if not isinstance(gitconf := self.config.src, GitConfig) or self.src is None:
             return
 
-        try:
-            self.src.mkdir(parents=True)
-        except FileExistsError:
-            return
-
         env = os.environ.copy()
 
         if gitconf.ssh_key_path is not None:
@@ -99,6 +94,13 @@ def checkout(self) -> None:
         def git(*args: str | Path) -> None:
             subprocess.run(("git", *args), check=True, cwd=self.src, env=env)
 
+        try:
+            self.src.mkdir(parents=True)
+        except FileExistsError:
+            git("reset", "--hard")
+            git("clean", "-xdf")
+            return
+
         git("init", "-b", "main")
         git("remote", "add", "origin", gitconf.url)
         git("fetch", "origin", gitconf.ref)

tests/test_build.py

@@ -3,6 +3,7 @@
 from deploy.config import Config
 from pathlib import Path
 import pytest
+from unittest.mock import patch
 
 
 @pytest.fixture
@@ -174,3 +175,51 @@ def test_build_script_validity(
     # Check that the correct configuration is correct
     (tmp_path / "build_B.sh").chmod(0o755)
     Build(Path("/dummy"), config, extra_scripts=tmp_path, prefix=tmp_path)
+
+
+@pytest.mark.parametrize(
+    "script_content,config_update",
+    [
+        pytest.param(
+            "content",
+            {"src": {"type": "git", "url": "https://example.com", "ref": "abcdefg"}},
+            id="git source",
+        ),
+    ],
+)
+def test_clean_package_cache_on_rebuild(
+    tmp_path, base_config, monkeypatch, config_update, script_content
+):
+    with patch("deploy.build.subprocess") as mocked_subprocess:
+        monkeypatch.setenv("XDG_CACHE_HOME", tmp_path)
+        (tmp_path / "build_A.sh").write_text(script_content)
+        (tmp_path / "build_A.sh").chmod(0o755)
+        base_config["builds"].append(
+            {
+                "name": "A",
+                "version": "0.0",
+                "depends": [],
+                **config_update,
+            }
+        )
+
+        config = Config.model_validate(base_config)
+        build = Build(tmp_path, config, extra_scripts=tmp_path, prefix=tmp_path)
+        pck = list(build.packages.values())[0]
+
+        pck.checkout()
+
+        # Checkout will use subpross run on the git command
+        # We verify that it first is called with git init
+        git_commands = [
+            call_args[0][0][1] for call_args in mocked_subprocess.run.call_args_list
+        ]
+        assert "init" in git_commands
+
+        pck.checkout()
+
+        # And when we do it again, we want a git clean
+        git_commands = [
+            call_args[0][0][1] for call_args in mocked_subprocess.run.call_args_list
+        ]
+        assert "clean" in git_commands