SCANPY-116 Parse the scanner properties from pyproject.toml files

Author: guillaume-dequenne

poetry.lock

@@ -29,7 +29,7 @@ relative_files = true
 
 [tool.poetry.dependencies]
 python = '>=3.9'
-toml = '>=0.10.2'
+tomli = '^2.2.1'
 requests = "^2.32.3"
 responses = "^0.25.6"
 pyfakefs = "^5.7.4"

pyproject.toml

@@ -22,7 +22,7 @@
 from pysonar_scanner.configuration import properties
 from pysonar_scanner.configuration.cli import CliConfigurationLoader
 from pysonar_scanner.configuration.properties import SONAR_TOKEN, SONAR_PROJECT_BASE_DIR, Key
-from pysonar_scanner.configuration import properties, sonar_project_properties
+from pysonar_scanner.configuration import properties, sonar_project_properties, toml_file
 
 from pysonar_scanner.exceptions import MissingKeyException
 
@@ -43,6 +43,11 @@ def load() -> dict[Key, any]:
         # but we need to resolve them first to load the properties file
         base_dir = Path(cli_properties.get(SONAR_PROJECT_BASE_DIR, "."))
         resolved_properties.update(sonar_project_properties.load(base_dir))
+
+        toml_path_property = cli_properties.get("toml-path", ".")
+        toml_dir = Path(toml_path_property) if "toml-path" in cli_properties else base_dir
+        resolved_properties.update(toml_file.load(toml_dir))
+
         resolved_properties.update(cli_properties)
         return resolved_properties
 

src/pysonar_scanner/configuration/__init__.py

@@ -207,4 +207,10 @@ def __parse_cli_args(cls) -> argparse.Namespace:
             help="Directory containing the project to be analyzed. Default is the current directory",
         )
 
+        parser.add_argument(
+            "--toml-path",
+            type=str,
+            help="Path to the pyproject.toml file. If not provided, it will look in the SONAR_PROJECT_BASE_DIR",
+        )
+
         return parser.parse_args()

src/pysonar_scanner/configuration/cli.py

@@ -61,6 +61,9 @@
 SONAR_EXCLUSIONS: Key = "sonar.exclusions"
 SONAR_TESTS: Key = "sonar.tests"
 
+# pysonar scanner specific properties
+TOML_PATH: Key = "toml-path"
+
 
 @dataclass
 class Property:
@@ -73,6 +76,15 @@ 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)
+
 
 # fmt: off
 PROPERTIES: list[Property] = [
@@ -123,7 +135,7 @@ class Property:
     ),  
     Property(
         name=SONAR_SCANNER_API_BASE_URL, 
-        default_value=None, 
+        default_value=None,
         cli_getter=lambda args: args.sonar_scanner_api_url
     ),  
     Property(
@@ -241,5 +253,10 @@ class Property:
             default_value=None,
             cli_getter=lambda args: args.sonar_project_name
     ),
+    Property(
+            name=TOML_PATH,
+            default_value=None,
+            cli_getter=lambda args: args.toml_path
+    ),
 ]
 # fmt: on

src/pysonar_scanner/configuration/properties.py

@@ -0,0 +1,59 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2024 SonarSource SA.
+# mailto:info AT sonarsource DOT com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+# This program is distributed in the hope that it will be useful,
+#
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+from pathlib import Path
+from typing import Dict
+import os
+import tomli
+
+from pysonar_scanner.configuration import properties
+
+
+def flatten_config_dict(config: dict[str, any], prefix: str) -> dict[str, any]:
+    """Flatten nested dictionaries into dot notation keys"""
+    result = {}
+    for key, value in config.items():
+        if isinstance(value, dict):
+            result.update(flatten_config_dict(value, f"{prefix}{key}."))
+        else:
+            property_name = f"{prefix}{key}"
+            result[property_name] = value
+    return result
+
+
+def load(base_dir: Path) -> Dict[str, str]:
+    filepath = base_dir / "pyproject.toml"
+    if not os.path.isfile(filepath):
+        return {}
+
+    try:
+        with open(filepath, "rb") as f:
+            toml_dict = tomli.load(f)
+
+        # Look for configuration in the tool.sonar section
+        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}
+            flattened_sonar_config = 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 {}
+    except Exception:
+        # If there's any error parsing the TOML file, return empty dict
+        # SCANPY-135: We should log the pyproject.toml parsing error
+        return {}