Prevent heuristics from running when attempt to set test is made

Author: guillaume-dequenne

src/pysonar_scanner/configuration/configuration_loader.py

@@ -29,6 +29,7 @@
     SONAR_TOKEN,
     SONAR_PROJECT_BASE_DIR,
     SONAR_TESTS,
+    SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED,
     Key,
 )
 from pysonar_scanner.configuration.properties import PROPERTIES
@@ -76,9 +77,12 @@ def load() -> dict[Key, Any]:
         # Auto-detect sonar.tests only when the user has not set it in any higher-priority source
         # and has not explicitly disabled the sonar-python test file heuristic. When the heuristic
         # is disabled the intent is to analyse all files as main code with no test classification.
-        heuristic_disabled = resolved_properties.get("sonar.python.testFileHeuristic.disabled", "").lower() == "true"
+        heuristic_disabled = resolved_properties.get(SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED, "").lower() == "true"
         if SONAR_TESTS not in resolved_properties and not heuristic_disabled:
-            resolved_properties.update(test_paths_loader.load(base_dir))
+            inferred_props, disable_heuristic = test_paths_loader.load(base_dir)
+            resolved_properties.update(inferred_props)
+            if disable_heuristic and SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED not in resolved_properties:
+                resolved_properties[SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED] = "true"
 
         return resolved_properties
 

src/pysonar_scanner/configuration/properties.py

@@ -94,6 +94,7 @@
 SONAR_WORKING_DIRECTORY: Key = "sonar.working.directory"
 SONAR_SCM_FORCE_RELOAD_ALL: Key = "sonar.scm.forceReloadAll"
 SONAR_MODULES: Key = "sonar.modules"
+SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED: Key = "sonar.python.testFileHeuristic.disabled"
 SONAR_PYTHON_ANALYSIS_PARALLEL: Key = "sonar.python.analysis.parallel"
 SONAR_PYTHON_ANALYSIS_THREADS: Key = "sonar.python.analysis.threads"
 SONAR_PYTHON_XUNIT_REPORT_PATH: Key = "sonar.python.xunit.reportPath"

src/pysonar_scanner/configuration/test_paths_loader.py

@@ -30,25 +30,27 @@
 _SETUP_CFG_PYTEST_SECTION = "tool:pytest"
 
 
-def load(base_dir: pathlib.Path) -> dict[str, str]:
+def load(base_dir: pathlib.Path) -> tuple[dict[str, str], bool]:
     """Infer sonar.tests from Python tooling configuration and filesystem conventions.
 
-    Returns sonar.tests if a test directory can be reliably inferred; empty dict otherwise.
-    Filesystem convention fallback only runs when no config file declares a testpaths key.
+    Returns (properties, disable_heuristic) where:
+    - properties contains sonar.tests if a test directory was reliably inferred
+    - disable_heuristic is True when a config file declared testpaths but all paths were
+      invalid — the user expressed intent, so the sonar-python heuristic should not fire
     """
     for loader in [_load_from_pyproject_toml, _load_from_pytest_ini, _load_from_tox_ini, _load_from_setup_cfg]:
         result = loader(base_dir)
         if result is None:
-            continue  # file absent or no testpaths key — try next source
+            continue  # file absent, no testpaths key, or empty testpaths (no restriction) — try next
         if result:
-            return {SONAR_TESTS: result}
-        return {}  # testpaths declared but all paths were invalid — stop chain, set nothing
+            return {SONAR_TESTS: result}, False
+        return {}, True  # declared but all paths invalid: user expressed intent, disable heuristic
 
-    # No config file declared a testpaths key; fall back to filesystem conventions.
+    # No config file gave a non-empty testpaths declaration; fall back to filesystem conventions.
     filesystem_result = _load_from_filesystem(base_dir)
     if filesystem_result:
-        return {SONAR_TESTS: filesystem_result}
-    return {}
+        return {SONAR_TESTS: filesystem_result}, False
+    return {}, False
 
 
 def _existing_paths(base_dir: pathlib.Path, paths: list[str]) -> list[str]:
@@ -102,7 +104,7 @@ def _load_from_pyproject_toml(base_dir: pathlib.Path) -> Optional[str]:
     testpaths = ini_options["testpaths"]
     raw = [str(p) for p in (testpaths if isinstance(testpaths, list) else testpaths.split()) if str(p).strip()]
     if not raw:
-        return ""  # testpaths key present but empty — stop chain
+        return None  # testpaths = [] means "no path restriction" — same as key absent, continue chain
     paths = _existing_paths(base_dir, raw)
     if paths:
         result = ",".join(paths)
@@ -129,7 +131,7 @@ def _load_from_ini_file(base_dir: pathlib.Path, filename: str, section: str) ->
         return None
     raw = [p for p in config[section]["testpaths"].split() if p]
     if not raw:
-        return ""  # testpaths key present but empty — stop chain
+        return None  # empty testpaths means "no path restriction" — same as key absent, continue chain
     paths = _existing_paths(base_dir, raw)
     if paths:
         result = ",".join(paths)

tests/unit/test_configuration_loader.py

@@ -53,6 +53,7 @@
     SONAR_SCANNER_ARCH,
     SONAR_SCANNER_OS,
     SONAR_COVERAGE_EXCLUSIONS,
+    SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED,
 )
 from pysonar_scanner.utils import Arch, Os
 from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader, SONAR_PROJECT_BASE_DIR
@@ -499,6 +500,33 @@ def test_test_paths_loader_not_called_when_heuristic_disabled(self, mock_loader,
         ConfigurationLoader.load()
         mock_loader.load.assert_not_called()
 
+    @patch("sys.argv", ["myscript.py"])
+    def test_declared_invalid_testpaths_disables_heuristic_in_resolved_properties(self, mock_get_os, mock_get_arch):
+        """When testpaths is declared but all paths are invalid, the loader signals intent and
+        configuration_loader sets sonar.python.testFileHeuristic.disabled=true."""
+        self.fs.create_file(
+            "pytest.ini",
+            contents="[pytest]\ntestpaths = nonexistent\n",
+        )
+        configuration = ConfigurationLoader.load()
+        self.assertEqual(configuration.get(SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED), "true")
+        self.assertNotIn(SONAR_TESTS, configuration)
+
+    @patch("sys.argv", ["myscript.py"])
+    def test_user_heuristic_disable_not_overridden_by_loader(self, mock_get_os, mock_get_arch):
+        """An explicit sonar.python.testFileHeuristic.disabled set by the user is not overridden
+        by the loader's suggestion, even when testpaths resolves to nothing."""
+        self.fs.create_file(
+            "sonar-project.properties",
+            contents="sonar.python.testFileHeuristic.disabled=false\n",
+        )
+        self.fs.create_file(
+            "pytest.ini",
+            contents="[pytest]\ntestpaths = nonexistent\n",
+        )
+        configuration = ConfigurationLoader.load()
+        self.assertEqual(configuration.get(SONAR_PYTHON_TEST_FILE_HEURISTIC_DISABLED), "false")
+
     @patch("sys.argv", ["myscript.py"])
     @patch.dict("os.environ", {"SONAR_TOKEN": "TokenFromEnv", "SONAR_PROJECT_KEY": "KeyFromEnv"}, clear=True)
     def test_load_from_env_variables_only(self, mock_get_os, mock_get_arch):