Ensure no overlap with auto-detected tests

Author: guillaume-dequenne

src/pysonar_scanner/configuration/configuration_loader.py

@@ -28,6 +28,7 @@
     SONAR_PROJECT_KEY,
     SONAR_TOKEN,
     SONAR_PROJECT_BASE_DIR,
+    SONAR_EXCLUSIONS,
     SONAR_SOURCES,
     SONAR_TESTS,
     SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED,
@@ -90,6 +91,15 @@ def load() -> dict[Key, Any]:
         if SONAR_SOURCES not in resolved_properties:
             logging.info("sonar.sources is not set; defaulting to the current directory '.'")
             resolved_properties[SONAR_SOURCES] = "."
+            if SONAR_TESTS in resolved_properties:
+                test_dirs = [d.strip() for d in resolved_properties[SONAR_TESTS].split(",") if d.strip()]
+                test_exclusion_patterns = ",".join(f"{d}/**" for d in test_dirs)
+                existing = resolved_properties.get(SONAR_EXCLUSIONS, "")
+                resolved_properties[SONAR_EXCLUSIONS] = f"{existing},{test_exclusion_patterns}" if existing else test_exclusion_patterns
+                logging.info(
+                    "sonar.sources defaults to '.'; adding test directories to sonar.exclusions to avoid overlap: '%s'",
+                    test_exclusion_patterns,
+                )
 
         return resolved_properties
 

tests/unit/test_configuration_loader.py

@@ -455,6 +455,24 @@ def test_explicit_sources_overrides_default(self, mock_get_os, mock_get_arch):
         configuration = ConfigurationLoader.load()
         self.assertEqual(configuration[SONAR_SOURCES], "src")
 
+    @patch("sys.argv", ["myscript.py"])
+    def test_default_sources_adds_test_dirs_to_exclusions(self, mock_get_os, mock_get_arch):
+        """When sonar.sources defaults to '.' and sonar.tests is set, test dirs must be excluded from sources."""
+        self.fs.create_dir("tests")
+        configuration = ConfigurationLoader.load()
+        self.assertEqual(configuration[SONAR_SOURCES], ".")
+        self.assertEqual(configuration[SONAR_TESTS], "tests")
+        self.assertEqual(configuration[SONAR_EXCLUSIONS], "tests/**")
+
+    @patch("sys.argv", ["myscript.py"])
+    def test_default_sources_appends_test_dirs_to_existing_exclusions(self, mock_get_os, mock_get_arch):
+        """When sonar.exclusions is already set, test dirs are appended rather than replacing it."""
+        self.fs.create_dir("tests")
+        self.fs.create_file("sonar-project.properties", contents="sonar.exclusions=generated/**\n")
+        configuration = ConfigurationLoader.load()
+        self.assertEqual(configuration[SONAR_SOURCES], ".")
+        self.assertEqual(configuration[SONAR_EXCLUSIONS], "generated/**,tests/**")
+
     @patch("sys.argv", ["myscript.py"])
     def test_sonar_project_properties_sonar_tests_overrides_auto_detection(self, mock_get_os, mock_get_arch):
         """sonar.tests in sonar-project.properties must override auto-detected value from filesystem/pytest config."""