SCANPY-138 Support python custom analyzer properties (#169)

Author: thomas-serre-sonarsource

src/pysonar_scanner/configuration/cli.py

@@ -395,5 +395,48 @@ def __parse_cli_args(cls) -> argparse.Namespace:
             type=str,
             help="Python version used for the project",
         )
+        parser.add_argument(
+            "--sonar-python-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",
+            "-Dsonar.python.coverage.reportPaths",
+            type=str,
+            help="Comma-delimited list of paths to coverage reports in the Cobertura XML format.",
+        )
+        parser.add_argument(
+            "--sonar-python-skip-unchanged",
+            type=bool,
+            action=argparse.BooleanOptionalAction,
+            help="Override the SonarQube configuration of skipping or not the analysis of unchanged Python files",
+        )
+        parser.add_argument(
+            "-Dsonar.python.skipUnchanged",
+            type=bool,
+            help="Equivalent to --sonar-python-skip-unchanged",
+        )
+        parser.add_argument(
+            "--sonar-python-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",
+            type=bool,
+            action=argparse.BooleanOptionalAction,
+            help="When enabled, the test execution statistics is provided only on project level",
+        )
+        parser.add_argument(
+            "-Dsonar.python.xunit.skipDetails",
+            type=bool,
+            help="Equivalent to -Dsonar.python.xunit.skipDetails",
+        )
+        parser.add_argument(
+            "--sonar-modules", "-Dsonar.modules", type=str, help="Comma-delimited list of modules to analyze"
+        )
 
         return parser.parse_args()

src/pysonar_scanner/configuration/properties.py

@@ -81,13 +81,18 @@
 SONAR_PULLREQUEST_BRANCH: Key = "sonar.pullrequest.branch"
 SONAR_PULLREQUEST_BASE: Key = "sonar.pullrequest.base"
 SONAR_PYTHON_VERSION: Key = "sonar.python.version"
+SONAR_PYTHON_PYLINT_REPORT_PATH: Key = "sonar.python.pylint.reportPath"
+SONAR_PYTHON_COVERAGE_REPORT_PATHS: Key = "sonar.python.coverage.reportPaths"
+SONAR_PYTHON_SKIP_UNCHANGED: Key = "sonar.python.skipUnchanged"
 SONAR_NEWCODE_REFERENCE_BRANCH: Key = "sonar.newCode.referenceBranch"
 SONAR_SCM_REVISION: Key = "sonar.scm.revision"
 SONAR_BUILD_STRING: Key = "sonar.buildString"
 SONAR_SOURCE_ENCODING: Key = "sonar.sourceEncoding"
 SONAR_WORKING_DIRECTORY: Key = "sonar.working.directory"
 SONAR_SCM_FORCE_RELOAD_ALL: Key = "sonar.scm.forceReloadAll"
-
+SONAR_MODULES: Key = "sonar.modules"
+SONAR_PYTHON_XUNIT_REPORT_PATH = "sonar.python.xunit.reportPath"
+SONAR_PYTHON_XUNIT_SKIP_DETAILS = "sonar.python.xunit.skipDetails"
 TOML_PATH: Key = "toml-path"
 
 
@@ -350,19 +355,19 @@ def env_variable_name(self) -> str:
         cli_getter=lambda args: args.toml_path
     ),
     Property(
-                name=SONAR_PROJECT_VERSION,
-                default_value=None,
-                cli_getter=lambda args: args.sonar_project_version
+        name=SONAR_PROJECT_VERSION,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_project_version
     ),
     Property(
-                name=SONAR_PROJECT_DESCRIPTION,
-                default_value=None,
-                cli_getter=lambda args: args.sonar_project_description
+        name=SONAR_PROJECT_DESCRIPTION,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_project_description
     ),
     Property(
-                name=SONAR_PYTHON_VERSION,
-                default_value=None,
-                cli_getter=lambda args: args.sonar_python_version
+        name=SONAR_PYTHON_VERSION,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_version
     ),
     Property(
         name=SONAR_QUALITYGATE_WAIT, 
@@ -453,7 +458,36 @@ def env_variable_name(self) -> str:
         name=SONAR_SCM_FORCE_RELOAD_ALL, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scm_force_reload_all or getattr(args, "Dsonar.scm.forceReloadAll")
+    ),
+    Property(
+        name=SONAR_PYTHON_PYLINT_REPORT_PATH,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_pylint_report_path
+    ),
+    Property(
+        name=SONAR_PYTHON_COVERAGE_REPORT_PATHS,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_coverage_report_paths
+    ),
+    Property(
+        name=SONAR_PYTHON_SKIP_UNCHANGED,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_skip_unchanged or getattr(args, "Dsonar.python.skipUnchanged")
+    ),
+    Property(
+        name=SONAR_PYTHON_XUNIT_REPORT_PATH,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_xunit_report_path
+    ),
+    Property(
+        name=SONAR_PYTHON_XUNIT_SKIP_DETAILS,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_python_xunit_skip_details or getattr(args, "Dsonar.python.xunit.skipDetails")
+    ),
+    Property(
+        name=SONAR_MODULES,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_modules
     )
-
 ]
 # fmt: on

tests/unit/test_configuration_cli.py

@@ -80,6 +80,12 @@
     SONAR_SOURCE_ENCODING,
     SONAR_WORKING_DIRECTORY,
     SONAR_SCM_FORCE_RELOAD_ALL,
+    SONAR_PYTHON_PYLINT_REPORT_PATH,
+    SONAR_PYTHON_COVERAGE_REPORT_PATHS,
+    SONAR_PYTHON_SKIP_UNCHANGED,
+    SONAR_PYTHON_XUNIT_REPORT_PATH,
+    SONAR_PYTHON_XUNIT_SKIP_DETAILS,
+    SONAR_MODULES,
 )
 
 EXPECTED_CONFIGURATION = {
@@ -139,6 +145,12 @@
     SONAR_SOURCE_ENCODING: "UTF-8",
     SONAR_WORKING_DIRECTORY: "/tmp/sonar",
     SONAR_SCM_FORCE_RELOAD_ALL: True,
+    SONAR_PYTHON_PYLINT_REPORT_PATH: "path/to/pylint/report",
+    SONAR_PYTHON_COVERAGE_REPORT_PATHS: "path/to/coverage1,path/to/coverage2",
+    SONAR_PYTHON_SKIP_UNCHANGED: True,
+    SONAR_PYTHON_XUNIT_REPORT_PATH: "path/to/xunit/report",
+    SONAR_PYTHON_XUNIT_SKIP_DETAILS: True,
+    SONAR_MODULES: "module1,module2",
 }
 
 
@@ -307,6 +319,16 @@ def test_impossible_os_choice(self):
             "--sonar-working-directory",
             "/tmp/sonar",
             "--sonar-scm-force-reload-all",
+            "--sonar-python-pylint-report-path",
+            "path/to/pylint/report",
+            "--sonar-python-coverage-report-paths",
+            "path/to/coverage1,path/to/coverage2",
+            "--sonar-python-skip-unchanged",
+            "--sonar-python-xunit-report-path",
+            "path/to/xunit/report",
+            "--sonar-python-xunit-skip-details",
+            "--sonar-modules",
+            "module1,module2",
         ],
     )
     def test_all_cli_args(self):
@@ -373,6 +395,12 @@ def test_all_cli_args(self):
             "-Dsonar.working.directory=/tmp/sonar",
             "-Dsonar.scm.forceReloadAll=true",
             "-Dsonar.log.level=INFO",
+            "-Dsonar.python.pylint.reportPath=path/to/pylint/report",
+            "-Dsonar.python.coverage.reportPaths=path/to/coverage1,path/to/coverage2",
+            "-Dsonar.python.skipUnchanged=true",
+            "-Dsonar.python.xunit.reportPath=path/to/xunit/report",
+            "-Dsonar.python.xunit.skipDetails=true",
+            "-Dsonar.modules=module1,module2",
         ],
     )
     def test_jvm_style_cli_args(self):