SCANPY-136 Support custom analyzer properties (#171)

guillaume-dequenne · web-flow · commit ad8fbe87b0ed · 2025-03-28T16:25:02.000+01:00
diff --git a/src/pysonar_scanner/configuration/cli.py b/src/pysonar_scanner/configuration/cli.py
@@ -20,24 +20,40 @@
 import argparse
 
 from pysonar_scanner.configuration import properties
+from pysonar_scanner.exceptions import UnexpectedCliArgument
 
 
 class CliConfigurationLoader:
 
     @classmethod
     def load(cls) -> dict[str, any]:
-        args = cls.__parse_cli_args()
+        args, unknown_args = cls.__parse_cli_args()
         config = {}
         for prop in properties.PROPERTIES:
             if prop.cli_getter is not None:
                 value = prop.cli_getter(args)
                 config[prop.name] = value
 
+        # Handle unknown args starting with '-D'
+        for arg in unknown_args:
+            if not arg.startswith("-D"):
+                raise UnexpectedCliArgument(f"Unexpected argument: {arg}")
+            key_value = arg[2:].split("=", 1)
+            if len(key_value) == 2:
+                key, value = key_value
+                config[key] = value
+            else:
+                # If no value is provided, set the key to "true"
+                config[arg[2:]] = "true"
+
         return {k: v for k, v in config.items() if v is not None}
 
     @classmethod
-    def __parse_cli_args(cls) -> argparse.Namespace:
-        parser = argparse.ArgumentParser(description="Sonar scanner CLI for Python")
+    def __parse_cli_args(cls) -> tuple[argparse.Namespace, list[str]]:
+        parser = argparse.ArgumentParser(
+            description="Sonar scanner CLI for Python",
+            epilog="Analysis properties not listed here will also be accepted, as long as they start with the -D prefix.",
+        )
 
         parser.add_argument(
             "-t",
@@ -439,4 +455,4 @@ def __parse_cli_args(cls) -> argparse.Namespace:
             "--sonar-modules", "-Dsonar.modules", type=str, help="Comma-delimited list of modules to analyze"
         )
 
-        return parser.parse_args()
+        return parser.parse_known_args()
diff --git a/src/pysonar_scanner/exceptions.py b/src/pysonar_scanner/exceptions.py
@@ -39,6 +39,10 @@ class ChecksumException(Exception):
     pass
 
 
+class UnexpectedCliArgument(Exception):
+    pass
+
+
 class JreProvisioningException(Exception):
     pass
 
diff --git a/tests/its/test_minimal.py b/tests/its/test_minimal.py
@@ -41,8 +41,8 @@ def test_minimal_project(sonarqube_client: SonarQubeClient, cli: CliClient):
 
 def test_minimal_project_unexpected_arg(cli: CliClient):
     process = cli.run_analysis(params=["-unexpected"], sources_dir="minimal")
-    assert process.returncode == 2, str(process.stdout)
-    assert "error: unrecognized arguments: -unexpected" in process.stdout
+    assert process.returncode == 1, str(process.stdout)
+    assert "Unexpected argument: -unexpected" in process.stdout
 
 
 def test_invalid_token(sonarqube_client: SonarQubeClient, cli: CliClient):
diff --git a/tests/unit/test_configuration_cli.py b/tests/unit/test_configuration_cli.py
@@ -87,6 +87,7 @@
     SONAR_PYTHON_XUNIT_SKIP_DETAILS,
     SONAR_MODULES,
 )
+from pysonar_scanner.exceptions import UnexpectedCliArgument
 
 EXPECTED_CONFIGURATION = {
     SONAR_TOKEN: "myToken",
@@ -439,3 +440,82 @@ def test_both_boolean_args_given(self):
         with patch("sys.argv", [*patch_template, "-Dsonar.scm.exclusions.disabled=true"]):
             configuration = CliConfigurationLoader.load()
             self.assertTrue(configuration.get(SONAR_SCM_EXCLUSIONS_DISABLED))
+
+    @patch(
+        "sys.argv",
+        [
+            "myscript.py",
+            "--token",
+            "myToken",
+            "--sonar-project-key",
+            "myProjectKey",
+            "-Dunknown.property=unknownValue",
+            "-Danother.unknown.property=anotherValue",
+        ],
+    )
+    def test_unknown_args_with_D_prefix(self):
+        configuration = CliConfigurationLoader.load()
+        expected_configuration = {
+            SONAR_TOKEN: "myToken",
+            SONAR_PROJECT_KEY: "myProjectKey",
+            "unknown.property": "unknownValue",
+            "another.unknown.property": "anotherValue",
+        }
+        self.assertDictEqual(configuration, expected_configuration)
+
+    @patch(
+        "sys.argv",
+        [
+            "myscript.py",
+            "--token",
+            "myToken",
+            "--sonar-project-key",
+            "myProjectKey",
+            "-Dunknown.flag",
+        ],
+    )
+    def test_unknown_args_no_value(self):
+        configuration = CliConfigurationLoader.load()
+        expected_configuration = {
+            SONAR_TOKEN: "myToken",
+            SONAR_PROJECT_KEY: "myProjectKey",
+            "unknown.flag": "true",
+        }
+        self.assertDictEqual(configuration, expected_configuration)
+
+    @patch(
+        "sys.argv",
+        [
+            "myscript.py",
+            "--token",
+            "myToken",
+            "--sonar-project-key",
+            "myProjectKey",
+            "-unknown.property=some_value",
+        ],
+    )
+    def test_unknown_args_missing_D_prefix(self):
+        with self.assertRaises(
+            UnexpectedCliArgument, msg="Unexpected argument format: -unknown.property=some_value=another_value"
+        ):
+            CliConfigurationLoader.load()
+
+    @patch(
+        "sys.argv",
+        [
+            "myscript.py",
+            "--token",
+            "myToken",
+            "--sonar-project-key",
+            "myProjectKey",
+            "-Dsonar.unknown.property=some_value=another_value",
+        ],
+    )
+    def test_unknown_args_unexpected_format(self):
+        configuration = CliConfigurationLoader.load()
+        expected_configuration = {
+            SONAR_TOKEN: "myToken",
+            SONAR_PROJECT_KEY: "myProjectKey",
+            "sonar.unknown.property": "some_value=another_value",
+        }
+        self.assertDictEqual(configuration, expected_configuration)
diff --git a/tests/unit/test_configuration_loader.py b/tests/unit/test_configuration_loader.py
@@ -375,3 +375,22 @@ def test_properties_priority(self):
         # CLI args have highest priority
         self.assertEqual(configuration[SONAR_PROJECT_KEY], "ProjectKeyFromCLI")
         self.assertEqual(configuration[SONAR_TOKEN], "myToken")  # CLI overrides env var
+
+    @patch(
+        "sys.argv",
+        [
+            "myscript.py",
+            "--token",
+            "myToken",
+            "--sonar-project-key",
+            "myProjectKey",
+            "-Dunknown.property=unknownValue",
+            "-Danother.unknown.property=anotherValue",
+        ],
+    )
+    def test_unknown_args_with_D_prefix(self):
+        configuration = ConfigurationLoader.load()
+        self.assertEqual(configuration["unknown.property"], "unknownValue")
+        self.assertEqual(configuration["another.unknown.property"], "anotherValue")
+        self.assertEqual(configuration[SONAR_TOKEN], "myToken")
+        self.assertEqual(configuration[SONAR_PROJECT_KEY], "myProjectKey")
diff --git a/tests/unit/test_pyproject_toml.py b/tests/unit/test_pyproject_toml.py
@@ -36,6 +36,7 @@ def test_load_toml_file_with_sonarqube_config(self):
             projectName = "My Project"
             sources = "src"
             exclusions = "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*"
+            some.unknownProperty = "unknown_property_value"
             """,
         )
         properties = TomlConfigurationLoader.load(Path("."))
@@ -46,6 +47,7 @@ def test_load_toml_file_with_sonarqube_config(self):
         self.assertEqual(
             properties.sonar_properties.get("sonar.exclusions"), "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*"
         )
+        self.assertEqual(properties.sonar_properties.get("sonar.some.unknownProperty"), "unknown_property_value")
 
     def test_load_toml_file_kebab_case(self):
         self.fs.create_file(
diff --git a/tests/unit/test_sonar_project_properties.py b/tests/unit/test_sonar_project_properties.py
@@ -36,6 +36,7 @@ def test_load_sonar_project_properties(self):
                 "sonar.sources=src # my sources\n"
                 "sonar.sources=src\n"
                 "sonar.exclusions=**/generated/**/*,**/deprecated/**/*,**/testdata/**/*\n"
+                "sonar.some.unknownProperty=my_unknown_property_value\n"
             ),
         )
         properties = sonar_project_properties.load(Path("."))
@@ -44,6 +45,7 @@ def test_load_sonar_project_properties(self):
         self.assertEqual(properties.get("sonar.projectName"), "My Project")
         self.assertEqual(properties.get("sonar.sources"), "src")
         self.assertEqual(properties.get("sonar.exclusions"), "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*")
+        self.assertEqual(properties.get("sonar.some.unknownProperty"), "my_unknown_property_value")
 
     def test_load_sonar_project_properties_custom_path(self):
         self.fs.create_file(

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ def test_load_toml_file_with_sonarqube_config(self):`
`36`	`36`	`projectName = "My Project"`
`37`	`37`	`sources = "src"`
`38`	`38`	`exclusions = "/generated//,/deprecated//,/testdata//*"`
	`39`	`+ some.unknownProperty = "unknown_property_value"`
`39`	`40`	`""",`
`40`	`41`	`)`
`41`	`42`	`properties = TomlConfigurationLoader.load(Path("."))`
`@@ -46,6 +47,7 @@ def test_load_toml_file_with_sonarqube_config(self):`
`46`	`47`	`self.assertEqual(`
`47`	`48`	`properties.sonar_properties.get("sonar.exclusions"), "/generated//,/deprecated//,/testdata//*"`
`48`	`49`	`)`
	`50`	`+ self.assertEqual(properties.sonar_properties.get("sonar.some.unknownProperty"), "unknown_property_value")`
`49`	`51`
`50`	`52`	`def test_load_toml_file_kebab_case(self):`
`51`	`53`	`self.fs.create_file(`