SCANPY-161 add Python report related properties to cli (#178)

Author: Seppli11

src/pysonar_scanner/configuration/cli.py

@@ -413,12 +413,14 @@ def __parse_cli_args(cls) -> tuple[argparse.Namespace, list[str]]:
         )
         parser.add_argument(
             "--sonar-python-pylint-report-path",
+            "--pylint-report-path",
             "-Dsonar.python.pylint.reportPath",
             type=str,
             help="Path to third-parties issues report file for pylint",
         )
         parser.add_argument(
             "--sonar-python-coverage-report-paths",
+            "--coverage-report-paths",
             "-Dsonar.python.coverage.reportPaths",
             type=str,
             help="Comma-delimited list of paths to coverage reports in the Cobertura XML format.",
@@ -436,12 +438,14 @@ def __parse_cli_args(cls) -> tuple[argparse.Namespace, list[str]]:
         )
         parser.add_argument(
             "--sonar-python-xunit-report-path",
+            "--xunit-report-path",
             "-Dsonar.python.xunit.reportPath",
             type=str,
             help="Path to the report of test execution, relative to project's root",
         )
         parser.add_argument(
             "--sonar-python-xunit-skip-details",
+            "--xunit-skip-details",
             type=bool,
             action=argparse.BooleanOptionalAction,
             help="When enabled, the test execution statistics is provided only on project level",
@@ -451,6 +455,34 @@ def __parse_cli_args(cls) -> tuple[argparse.Namespace, list[str]]:
             type=bool,
             help="Equivalent to -Dsonar.python.xunit.skipDetails",
         )
+        parser.add_argument(
+            "--sonar-python-mypy-report-paths",
+            "--mypy-report-paths",
+            "-Dsonar.python.mypy.reportPaths",
+            type=str,
+            help="Comma-separated mypy report paths, relative to project's root",
+        )
+        parser.add_argument(
+            "--sonar-python-bandit-report-paths",
+            "--bandit-report-paths",
+            "-Dsonar.python.bandit.reportPaths",
+            type=str,
+            help="Comma-separated bandit report paths, relative to project's root",
+        )
+        parser.add_argument(
+            "--sonar-python-flake8-report-paths",
+            "--flake8-report-paths",
+            "-Dsonar.python.flake8.reportPaths",
+            type=str,
+            help="Comma-separated flake8 report paths, relative to project's root",
+        )
+        parser.add_argument(
+            "--sonar-python-ruff-report-paths",
+            "--ruff-report-paths",
+            "-Dsonar.python.ruff.reportPaths",
+            type=str,
+            help="Comma-separated ruff report paths, relative to project's root",
+        )
         parser.add_argument(
             "--sonar-modules", "-Dsonar.modules", type=str, help="Comma-delimited list of modules to analyze"
         )

src/pysonar_scanner/configuration/properties.py

@@ -93,6 +93,10 @@
 SONAR_MODULES: Key = "sonar.modules"
 SONAR_PYTHON_XUNIT_REPORT_PATH = "sonar.python.xunit.reportPath"
 SONAR_PYTHON_XUNIT_SKIP_DETAILS = "sonar.python.xunit.skipDetails"
+SONAR_PYTHON_MYPY_REPORT_PATHS = "sonar.python.mypy.reportPaths"
+SONAR_PYTHON_BANDIT_REPORT_PATHS = "sonar.python.bandit.reportPaths"
+SONAR_PYTHON_FLAKE8_REPORT_PATHS = "sonar.python.flake8.reportPaths"
+SONAR_PYTHON_RUFF_REPORT_PATHS = "sonar.python.ruff.reportPaths"
 TOML_PATH: Key = "toml-path"
 
 
@@ -484,6 +488,26 @@ def env_variable_name(self) -> str:
         default_value=None,
         cli_getter=lambda args: args.sonar_python_xunit_skip_details or getattr(args, "Dsonar.python.xunit.skipDetails")
     ),
+    Property(
+        name=SONAR_PYTHON_MYPY_REPORT_PATHS,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_mypy_report_paths
+    ),
+    Property(
+        name=SONAR_PYTHON_BANDIT_REPORT_PATHS,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_bandit_report_paths
+    ),
+    Property(
+        name=SONAR_PYTHON_FLAKE8_REPORT_PATHS,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_flake8_report_paths
+    ),
+    Property(
+        name=SONAR_PYTHON_RUFF_REPORT_PATHS,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_ruff_report_paths
+    ),
     Property(
         name=SONAR_MODULES,
         default_value=None,

tests/unit/test_configuration_cli.py

@@ -25,6 +25,10 @@
 from pysonar_scanner.configuration.configuration_loader import CliConfigurationLoader
 from pysonar_scanner.configuration.properties import (
     SONAR_HOST_URL,
+    SONAR_PYTHON_BANDIT_REPORT_PATHS,
+    SONAR_PYTHON_FLAKE8_REPORT_PATHS,
+    SONAR_PYTHON_MYPY_REPORT_PATHS,
+    SONAR_PYTHON_RUFF_REPORT_PATHS,
     SONAR_REGION,
     SONAR_SCANNER_API_BASE_URL,
     SONAR_SCANNER_ARCH,
@@ -151,6 +155,10 @@
     SONAR_PYTHON_SKIP_UNCHANGED: True,
     SONAR_PYTHON_XUNIT_REPORT_PATH: "path/to/xunit/report",
     SONAR_PYTHON_XUNIT_SKIP_DETAILS: True,
+    SONAR_PYTHON_MYPY_REPORT_PATHS: "path/to/mypy/reports",
+    SONAR_PYTHON_BANDIT_REPORT_PATHS: "path/to/bandit/reports",
+    SONAR_PYTHON_FLAKE8_REPORT_PATHS: "path/to/flake8/reports",
+    SONAR_PYTHON_RUFF_REPORT_PATHS: "path/to/ruff/reports",
     SONAR_MODULES: "module1,module2",
 }
 
@@ -184,6 +192,43 @@ def test_alternative_cli_args(self):
                 }
                 self.assertDictEqual(configuration, expected_configuration)
 
+    def test_alternative_report_cli_args(self):
+        base_args = ["myscript.py", "-t", "myToken", "--sonar-project-key", "myProjectKey"]
+        report_args = [
+            "--bandit-report-paths",
+            "path/to/bandit/reports",
+            "--flake8-report-paths",
+            "path/to/flake8/reports",
+            "--mypy-report-paths",
+            "path/to/mypy/reports",
+            "--pylint-report-path",
+            "path/to/pylint/report",
+            "--coverage-report-paths",
+            "path/to/coverage/reports",
+            "--xunit-report-path",
+            "path/to/xunit/report",
+            "--ruff-report-paths",
+            "path/to/ruff/reports",
+            "--xunit-skip-details",
+        ]
+
+        expected_configuration = {
+            SONAR_TOKEN: "myToken",
+            SONAR_PROJECT_KEY: "myProjectKey",
+            SONAR_PYTHON_BANDIT_REPORT_PATHS: "path/to/bandit/reports",
+            SONAR_PYTHON_FLAKE8_REPORT_PATHS: "path/to/flake8/reports",
+            SONAR_PYTHON_MYPY_REPORT_PATHS: "path/to/mypy/reports",
+            SONAR_PYTHON_PYLINT_REPORT_PATH: "path/to/pylint/report",
+            SONAR_PYTHON_COVERAGE_REPORT_PATHS: "path/to/coverage/reports",
+            SONAR_PYTHON_XUNIT_REPORT_PATH: "path/to/xunit/report",
+            SONAR_PYTHON_RUFF_REPORT_PATHS: "path/to/ruff/reports",
+            SONAR_PYTHON_XUNIT_SKIP_DETAILS: True,
+        }
+
+        with patch("sys.argv", base_args + report_args), patch("sys.stderr", new=StringIO()):
+            configuration = CliConfigurationLoader.load()
+            self.assertDictEqual(configuration, expected_configuration)
+
     def test_multiple_alias_cli_args(self):
         alternatives = [
             ["-t", "overwrittenToken", "--sonar-token", "sonarToken"],
@@ -328,6 +373,14 @@ def test_impossible_os_choice(self):
             "--sonar-python-xunit-report-path",
             "path/to/xunit/report",
             "--sonar-python-xunit-skip-details",
+            "--sonar-python-mypy-report-paths",
+            "path/to/mypy/reports",
+            "--sonar-python-bandit-report-paths",
+            "path/to/bandit/reports",
+            "--sonar-python-flake8-report-paths",
+            "path/to/flake8/reports",
+            "--sonar-python-ruff-report-paths",
+            "path/to/ruff/reports",
             "--sonar-modules",
             "module1,module2",
         ],
@@ -401,6 +454,10 @@ def test_all_cli_args(self):
             "-Dsonar.python.skipUnchanged=true",
             "-Dsonar.python.xunit.reportPath=path/to/xunit/report",
             "-Dsonar.python.xunit.skipDetails=true",
+            "-Dsonar.python.mypy.reportPaths=path/to/mypy/reports",
+            "-Dsonar.python.bandit.reportPaths=path/to/bandit/reports",
+            "-Dsonar.python.flake8.reportPaths=path/to/flake8/reports",
+            "-Dsonar.python.ruff.reportPaths=path/to/ruff/reports",
             "-Dsonar.modules=module1,module2",
         ],
     )