SCANPY-162 Allow for shorter property names in pyproject.toml

Author: guillaume-dequenne

src/pysonar_scanner/configuration/properties.py

@@ -111,14 +111,27 @@ class Property:
     cli_getter: Optional[Callable[[argparse.Namespace], any]] = None
     """function to get the value from the CLI arguments namespace. If None, the property is not settable via CLI"""
 
-    def python_name(self) -> str:
-        """Convert Java-style camel case name to Python-style kebab-case name."""
-        result = []
-        for i, char in enumerate(self.name):
-            if char.isupper() and i > 0:
-                result.append("-")
-            result.append(char.lower())
-        return "".join(result)
+    def python_names(self) -> list[str]:
+        """Convert Java-style camel case name to Python-style kebab-case names.
+        Additionally, if the property has 4 or more parts and the second part is 'python',
+        generate an alternative name omitting the 'python' part."""
+        parts = self.name.split(".")
+        kebab_parts = []
+        for part in parts:
+            kebab_part = []
+            for i, char in enumerate(part):
+                if char.isupper() and i > 0:
+                    kebab_part.append("-")
+                kebab_part.append(char.lower())
+            kebab_parts.append("".join(kebab_part))
+
+        names = [".".join(kebab_parts)]
+
+        if len(parts) >= 4 and parts[1] == "python":
+            alt_parts = [kebab_parts[0]] + kebab_parts[2:]
+            names.append(".".join(alt_parts))
+
+        return names
 
     def env_variable_name(self) -> str:
         """Convert property name to environment variable name format.

src/pysonar_scanner/configuration/pyproject_toml.py

@@ -58,7 +58,9 @@ def load(base_dir: Path) -> TomlProperties:
     def __read_sonar_properties(toml_dict) -> Dict[str, str]:
         if "tool" in toml_dict and "sonar" in toml_dict["tool"]:
             sonar_config = toml_dict["tool"]["sonar"]
-            python_to_java_names = {prop.python_name(): prop.name for prop in properties.PROPERTIES}
+            python_to_java_names = {
+                python_name: prop.name for prop in properties.PROPERTIES for python_name in prop.python_names()
+            }
             flattened_sonar_config = TomlConfigurationLoader.__flatten_config_dict(sonar_config, prefix="sonar.")
             return {python_to_java_names.get(key, key): value for key, value in flattened_sonar_config.items()}
         return {}

tests/test_properties.py

@@ -40,35 +40,40 @@ def test_python_name_conversion(self):
         """Test conversion of property names to Python-style kebab-case names"""
         test_cases = [
             # Simple properties
-            (SONAR_HOST_URL, "sonar.host.url"),
-            (SONAR_TOKEN, "sonar.token"),
-            (SONAR_VERBOSE, "sonar.verbose"),
+            (SONAR_HOST_URL, ["sonar.host.url"]),
+            (SONAR_TOKEN, ["sonar.token"]),
+            (SONAR_VERBOSE, ["sonar.verbose"]),
             # CamelCase properties
-            (SONAR_SCANNER_APP_VERSION, "sonar.scanner.app-version"),
-            (SONAR_SCANNER_SOCKET_TIMEOUT, "sonar.scanner.socket-timeout"),
-            (SONAR_SCANNER_PROXY_PASSWORD, "sonar.scanner.proxy-password"),
+            (SONAR_SCANNER_APP_VERSION, ["sonar.scanner.app-version"]),
+            (SONAR_SCANNER_SOCKET_TIMEOUT, ["sonar.scanner.socket-timeout"]),
+            (SONAR_SCANNER_PROXY_PASSWORD, ["sonar.scanner.proxy-password"]),
             # Complex properties
-            (SONAR_SCANNER_INTERNAL_DUMP_TO_FILE, "sonar.scanner.internal.dump-to-file"),
-            (SONAR_PROJECT_KEY, "sonar.project-key"),
-            (SONAR_PROJECT_BASE_DIR, "sonar.project-base-dir"),
+            (SONAR_SCANNER_INTERNAL_DUMP_TO_FILE, ["sonar.scanner.internal.dump-to-file"]),
+            (SONAR_PROJECT_KEY, ["sonar.project-key"]),
+            (SONAR_PROJECT_BASE_DIR, ["sonar.project-base-dir"]),
+            # Python-specific properties with alternative names
+            ("sonar.python.pylint.reportPath", ["sonar.python.pylint.report-path", "sonar.pylint.report-path"]),
+            (
+                "sonar.python.coverage.reportPaths",
+                ["sonar.python.coverage.report-paths", "sonar.coverage.report-paths"],
+            ),
+            ("sonar.python.version", ["sonar.python.version"]),  # No alternative name (only 3 parts)
         ]
 
-        for name, expected_python_name in test_cases:
-            # Find property in PROPERTIES list
+        for name, expected_python_names in test_cases:
             prop = next((p for p in PROPERTIES if p.name == name), None)
             if prop:
                 self.assertEqual(
-                    prop.python_name(),
-                    expected_python_name,
-                    f"Failed to convert {name} to Python name, got {prop.python_name()}",
+                    prop.python_names(),
+                    expected_python_names,
+                    f"Failed to convert {name} to Python names, got {prop.python_names()}",
                 )
             else:
-                # Create test property if not in list
                 prop = Property(name=name, default_value=None)
                 self.assertEqual(
-                    prop.python_name(),
-                    expected_python_name,
-                    f"Failed to convert {name} to Python name, got {prop.python_name()}",
+                    prop.python_names(),
+                    expected_python_names,
+                    f"Failed to convert {name} to Python names, got {prop.python_names()}",
                 )
 
     def test_env_variable_name_conversion(self):

tests/unit/test_pyproject_toml.py

@@ -36,6 +36,8 @@ def test_load_toml_file_with_sonarqube_config(self):
             projectName = "My Project"
             sources = "src"
             exclusions = "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*"
+            python.mypy.report-paths = "mypy-report.xml,my/other/mypy/report.xml"
+            ruff.report-paths = "ruff-report.xml,my/other/ruff/report.xml"
             some.unknownProperty = "unknown_property_value"
             """,
         )
@@ -44,6 +46,13 @@ def test_load_toml_file_with_sonarqube_config(self):
         self.assertEqual(properties.sonar_properties.get("sonar.projectKey"), "my-project")
         self.assertEqual(properties.sonar_properties.get("sonar.projectName"), "My Project")
         self.assertEqual(properties.sonar_properties.get("sonar.sources"), "src")
+        self.assertEqual(properties.sonar_properties.get("sonar.sources"), "src")
+        self.assertEqual(
+            properties.sonar_properties.get("sonar.python.mypy.reportPaths"), "mypy-report.xml,my/other/mypy/report.xml"
+        )
+        self.assertEqual(
+            properties.sonar_properties.get("sonar.python.ruff.reportPaths"), "ruff-report.xml,my/other/ruff/report.xml"
+        )
         self.assertEqual(
             properties.sonar_properties.get("sonar.exclusions"), "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*"
         )