Hash directory also hashes untracked files

Fixes #350

Author: spoorcc

CHANGELOG.rst

@@ -19,6 +19,7 @@ Release 0.11.0 (unreleased)
 * Fix unneeded project prefix in SVN diffs (#888)
 * Add more tests and documentation for patching (#888)
 * Restrict ``src`` to string only in schema (#889)
+* Don't consider ignored files for determining local changes (#350)
 
 Release 0.10.0 (released 2025-03-12)
 ====================================

dfetch/commands/check.py

@@ -26,7 +26,7 @@
 import dfetch.manifest.manifest
 import dfetch.manifest.validate
 import dfetch.project
-from dfetch.commands.common import check_child_manifests
+from dfetch.commands.common import check_child_manifests, files_to_ignore
 from dfetch.log import get_logger
 from dfetch.manifest.manifest import Manifest
 from dfetch.reporting.check.code_climate_reporter import CodeClimateReporter
@@ -90,7 +90,9 @@ def __call__(self, args: argparse.Namespace) -> None:
             exceptions: list[str] = []
             for project in manifest.selected_projects(args.projects):
                 with catch_runtime_exceptions(exceptions) as exceptions:
-                    dfetch.project.make(project).check_for_update(reporters)
+                    dfetch.project.make(project).check_for_update(
+                        reporters, files_to_ignore=files_to_ignore(project.destination)
+                    )
 
                 if not args.no_recommendations and os.path.isdir(project.destination):
                     with in_directory(project.destination):

dfetch/commands/common.py

@@ -1,12 +1,15 @@
 """Module for common command operations."""
 
 import os
+from collections.abc import Sequence
 
 import yaml
 
 from dfetch.log import get_logger
 from dfetch.manifest.manifest import Manifest, get_childmanifests
 from dfetch.manifest.project import ProjectEntry
+from dfetch.project.svn import SvnRepo
+from dfetch.vcs.git import GitLocalRepo
 
 logger = get_logger(__name__)
 
@@ -63,3 +66,14 @@ def _make_recommendation(
     for line in recommendation_json.splitlines():
         logger.warning(line)
     logger.warning("")
+
+
+def files_to_ignore(path: str) -> Sequence[str]:
+    """Return a list of files that can be ignored in a given path."""
+    if GitLocalRepo().is_git():
+        ignore_list = GitLocalRepo.ignored_files(path)
+    elif SvnRepo.check_path():
+        ignore_list = SvnRepo.ignored_files(path)
+    else:
+        ignore_list = []
+    return ignore_list

dfetch/commands/update.py

@@ -29,7 +29,7 @@
 import dfetch.manifest.validate
 import dfetch.project.git
 import dfetch.project.svn
-from dfetch.commands.common import check_child_manifests
+from dfetch.commands.common import check_child_manifests, files_to_ignore
 from dfetch.log import get_logger
 from dfetch.util.util import catch_runtime_exceptions, in_directory
 
@@ -78,7 +78,10 @@ def __call__(self, args: argparse.Namespace) -> None:
             for project in manifest.selected_projects(args.projects):
                 with catch_runtime_exceptions(exceptions) as exceptions:
                     self._check_destination(project, destinations)
-                    dfetch.project.make(project).update(force=args.force)
+                    dfetch.project.make(project).update(
+                        force=args.force,
+                        files_to_ignore=files_to_ignore(project.destination),
+                    )
 
                     if not args.no_recommendations and os.path.isdir(
                         project.destination

dfetch/project/svn.py

@@ -430,3 +430,21 @@ def _untracked_files(path: str, ignore: Sequence[str]) -> list[str]:
                 ):
                     files.append(file_path)
         return files
+
+    @staticmethod
+    def ignored_files(path: str) -> Sequence[str]:
+        """Get list of ignored files in the working copy."""
+        if not pathlib.Path(path).exists():
+            return []
+
+        with in_directory(path):
+            result = (
+                run_on_cmdline(
+                    logger,
+                    ["svn", "status", "--no-ignore", "."],
+                )
+                .stdout.decode()
+                .splitlines()
+            )
+
+        return [line[1:].strip() for line in result if line.startswith("I")]

dfetch/project/vcs.py

@@ -92,19 +92,24 @@ def update_is_required(self, force: bool = False) -> Optional[Version]:
         logger.debug(f"{self.__project.name} Current ({current}), Available ({wanted})")
         return wanted
 
-    def update(self, force: bool = False) -> None:
+    def update(
+        self, force: bool = False, files_to_ignore: Optional[Sequence[str]] = None
+    ) -> None:
         """Update this VCS if required.
 
         Args:
             force (bool, optional): Ignore if version is ok or any local changes were done.
                                     Defaults to False.
+            files_to_ignore (Sequence[str], optional): list of files that are ok to overwrite.
         """
         to_fetch = self.update_is_required(force)
 
         if not to_fetch:
             return
 
-        if not force and self._are_there_local_changes():
+        files_to_ignore = files_to_ignore or []
+
+        if not force and self._are_there_local_changes(files_to_ignore):
             self._log_project(
                 "skipped - local changes after last update (use --force to overwrite)"
             )
@@ -151,7 +156,9 @@ def apply_patch(self) -> None:
         else:
             raise RuntimeError(f'Applying patch "{self.__project.patch}" failed')
 
-    def check_for_update(self, reporters: Sequence[AbstractCheckReporter]) -> None:
+    def check_for_update(
+        self, reporters: Sequence[AbstractCheckReporter], files_to_ignore: Sequence[str]
+    ) -> None:
         """Check if there is an update available."""
         on_disk_version = self.on_disk_version()
         with Halo(
@@ -177,7 +184,7 @@ def check_for_update(self, reporters: Sequence[AbstractCheckReporter]) -> None:
 
             return
 
-        if self._are_there_local_changes():
+        if self._are_there_local_changes(files_to_ignore):
             for reporter in reporters:
                 reporter.local_changes(self.__project)
 
@@ -339,7 +346,7 @@ def _check_for_newer_version(self) -> Optional[Version]:
         revision = self._latest_revision_on_branch(branch)
         return Version(revision=revision, branch=branch) if revision else None
 
-    def _are_there_local_changes(self) -> bool:
+    def _are_there_local_changes(self, files_to_ignore: Sequence[str]) -> bool:
         """Check if there are local changes.
 
         Returns:
@@ -349,7 +356,8 @@ def _are_there_local_changes(self) -> bool:
         on_disk_hash = self._on_disk_hash()
 
         return bool(on_disk_hash) and on_disk_hash != hash_directory(
-            self.local_path, skiplist=[self.__metadata.FILENAME]
+            self.local_path,
+            skiplist=[self.__metadata.FILENAME] + list(files_to_ignore),
         )
 
     @abstractmethod

dfetch/vcs/git.py

@@ -344,6 +344,29 @@ def create_diff(
 
         return str(result.stdout.decode())
 
+    @staticmethod
+    def ignored_files(path: str) -> Sequence[str]:
+        """List of ignored files."""
+        if not Path(path).exists():
+            return []
+
+        with in_directory(path):
+            return list(
+                run_on_cmdline(
+                    logger,
+                    [
+                        "git",
+                        "ls-files",
+                        "--ignored",
+                        "--others",
+                        "--exclude-standard",
+                        ".",
+                    ],
+                )
+                .stdout.decode()
+                .splitlines()
+            )
+
     def untracked_files_patch(self, ignore: Optional[Sequence[str]] = None) -> str:
         """Create a diff for untracked files."""
         with in_directory(self._path):

tests/test_update.py

@@ -65,7 +65,7 @@ def test_forced_update():
 
                             update(args)
                             mocked_make.return_value.update.assert_called_once_with(
-                                force=True
+                                force=True, files_to_ignore=[]
                             )
 
 

tests/test_vcs.py

@@ -137,7 +137,7 @@ def test_are_there_local_changes(
             mocked_on_disk_hash.return_value = hash_in_metadata
             mocked_hash_directory.return_value = current_hash
 
-            assert expectation == vcs._are_there_local_changes()
+            assert expectation == vcs._are_there_local_changes(files_to_ignore=[])
 
 
 @pytest.mark.parametrize(