An util function which returns if the current git repo has been modif…

…ied (#12)

arca/_arca.py

@@ -7,7 +7,7 @@
 
 import re
 from dogpile.cache import make_region, CacheRegion
-from git import Repo
+from git import Repo, InvalidGitRepositoryError
 
 from .exceptions import ArcaMisconfigured, FileOutOfRangeError
 from .backend import BaseBackend
@@ -230,6 +230,15 @@ def cache_key(self, repo: str, branch: str, task: Task, git_repo: Repo) -> str:
                                                       hash=self.current_git_hash(repo, branch, git_repo),
                                                       task=task.serialize())
 
+    def is_dirty(self) -> bool:
+        """ Returns if the repository the code is launched from was modified in any way.
+            Returns False if not in a repository.
+        """
+        try:
+            return Repo(".", search_parent_directories=True).is_dirty(untracked_files=True)
+        except InvalidGitRepositoryError:
+            return False
+
     def run(self, repo: str, branch: str, task: Task, *,
             depth: DepthDefinitionType=None,
             shallow_since: ShallowSinceDefinitionType=None,

tests/test_arca_class.py

@@ -8,7 +8,7 @@
 from datetime import datetime, timedelta, date
 from git import Repo
 
-from arca import Arca, VenvBackend
+from arca import Arca, VenvBackend, CurrentEnvironmentBackend
 from arca.exceptions import ArcaMisconfigured, FileOutOfRangeError
 from common import BASE_DIR
 
@@ -343,3 +343,25 @@ def test_shallow_since_validate(shallow_since, valid):
     else:
         with pytest.raises(ValueError):
             arca.static_filename(git_url, branch, relative_path, shallow_since=shallow_since)
+
+
+def test_is_dirty():
+    arca = Arca(backend=CurrentEnvironmentBackend(
+        verbosity=2,
+        current_environment_requirements=None,
+        requirements_strategy="ignore"
+    ), base_dir=BASE_DIR)
+
+    if arca.is_dirty():
+        pytest.skip("Can't test is_dirty method when the current repo is dirty.")
+
+    assert not arca.is_dirty()
+
+    fl = Path(str(uuid4()))
+    fl.touch()
+
+    assert arca.is_dirty()
+
+    fl.unlink()
+
+    assert not arca.is_dirty()