Merge pull request #133 from Pennycook/symlink-files

Fix handling of symlink files

Author: Pennycook

codebasin/finder.py

@@ -98,6 +98,12 @@ def get_setmap(self, codebase: CodeBase) -> dict[frozenset, int]:
         """
         setmap = collections.defaultdict(int)
         for fn in codebase:
+            # Don't count symlinks if their target is in the code base.
+            # The target will be counted separately.
+            path = Path(fn)
+            if path.is_symlink() and path.resolve() in codebase:
+                continue
+
             tree = self.get_tree(fn)
             association = self.get_map(fn)
             for node in [n for n in tree.walk() if isinstance(n, CodeNode)]:

tests/duplicates/test_duplicates.py

@@ -2,6 +2,8 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 import logging
+import os
+import tempfile
 import unittest
 from pathlib import Path
 
@@ -50,8 +52,8 @@ def test_duplicates(self):
         setmap = state.get_setmap(codebase)
         self.assertDictEqual(setmap, expected_setmap, "Mismatch in setmap")
 
-    def test_symlinks(self):
-        """Check that symlinks do not count towards divergence."""
+    def test_symlink_directories(self):
+        """Check that symlink directories do not count towards divergence."""
 
         cpufile = str(self.rootdir / "cpu/foo.cpp")
         cpu2file = str(self.rootdir / "cpu2/foo.cpp")
@@ -83,6 +85,40 @@ def test_symlinks(self):
         setmap = state.get_setmap(codebase)
         self.assertDictEqual(setmap, expected_setmap, "Mismatch in setmap")
 
+    def test_symlink_files(self):
+        """Check that symlink files do not count towards divergence."""
+        tmp = tempfile.TemporaryDirectory()
+        p = Path(tmp.name)
+        with open(p / "base.cpp", mode="w") as f:
+            f.write("void foo();")
+        os.symlink(p / "base.cpp", p / "symlink.cpp")
+
+        codebase = CodeBase(p)
+        configuration = {
+            "test": [
+                {
+                    "file": str(p / "base.cpp"),
+                    "defines": [],
+                    "include_paths": [],
+                    "include_files": [],
+                },
+                {
+                    "file": str(p / "symlink.cpp"),
+                    "defines": [],
+                    "include_paths": [],
+                    "include_files": [],
+                },
+            ],
+        }
+
+        expected_setmap = {frozenset(["test"]): 1}
+
+        state = finder.find(self.rootdir, codebase, configuration)
+        setmap = state.get_setmap(codebase)
+        self.assertDictEqual(setmap, expected_setmap, "Mismatch in setmap")
+
+        tmp.cleanup()
+
 
 if __name__ == "__main__":
     unittest.main()