SCANPY-130 Accept options of the form -Dsonar.*** (#156)

Author: thomas-serre-sonarsource

src/pysonar_scanner/configuration/cli.py

@@ -44,116 +44,159 @@ def __parse_cli_args(cls) -> argparse.Namespace:
             "-t",
             "--token",
             "--sonar-token",
+            "-Dsonar.token",
             type=str,
             help="Token used to authenticate against the SonarQube Server or SonarQube Cloud",
         )
         parser.add_argument(
             "--sonar-project-key",
+            "-Dsonar.projectKey",
             type=str,
             help="Key of the project that usually corresponds to the project name in SonarQube",
         )
 
         parser.add_argument(
-            "-v", "--verbose", "--sonar-verbose", action="store_true", default=None, help="Increase output verbosity"
+            "-v",
+            "--verbose",
+            "--sonar-verbose",
+            "-Dsonar.verbose",
+            action="store_true",
+            default=None,
+            help="Increase output verbosity",
         )
 
         parser.add_argument(
             "--sonar-host-url",
+            "-Dsonar.host.url",
             type=str,
             help="SonarQube Server base URL. For example, http://localhost:9000 for a local instance of SonarQube Server",
         )
         parser.add_argument(
             "--sonar-region",
+            "-Dsonar.region",
             type=str,
             choices=["us"],
             help="The region to contact, only for SonarQube Cloud",
         )
-        parser.add_argument("--sonar-user-home", type=str, help="Base sonar directory, ~/.sonar by default")
+        parser.add_argument(
+            "--sonar-user-home", "-Dsonar.userHome", type=str, help="Base sonar directory, ~/.sonar by default"
+        )
 
         parser.add_argument(
             "--sonar-scanner-cloud-url",
+            "-Dsonar.scanner.cloudUrl",
             type=str,
             help="SonarQube Cloud base URL, https://sonarcloud.io for example",
         )
         parser.add_argument(
             "--sonar-scanner-api-url",
+            "-Dsonar.scanner.apiUrl",
             type=str,
             help="Base URL for all REST-compliant API calls, https://api.sonarcloud.io for example",
         )
         parser.add_argument(
             "--sonar-scanner-os",
+            "-Dsonar.scanner.os",
             type=str,
             choices=["windows", "linux", "macos", "alpine"],
             help="OS running the scanner",
         )
         parser.add_argument(
             "--sonar-scanner-arch",
+            "-Dsonar.scanner.arch",
             type=str,
             choices=["x64", "aarch64"],
             help="Architecture on which the scanner will be running",
         )
 
         parser.add_argument(
             "--skip-jre-provisioning",
+            "-Dsonar.scanner.skipJreProvisioning",
             action="store_true",
             default=None,
             help="If provided, the provisioning of the JRE will be skipped",
         )
         parser.add_argument(
-            "--sonar-scanner-java-exe-path", type=str, help="If defined, the scanner engine will be run with this JRE"
+            "--sonar-scanner-java-exe-path",
+            "-Dsonar.scanner.javaExePath",
+            type=str,
+            help="If defined, the scanner engine will be run with this JRE",
         )
         parser.add_argument(
-            "--sonar-scanner-java-opts", type=str, help="Arguments provided to the JVM when running the scanner"
+            "--sonar-scanner-java-opts",
+            "-Dsonar.scanner.javaOpts",
+            type=str,
+            help="Arguments provided to the JVM when running the scanner",
         )
 
         parser.add_argument(
             "--sonar-scanner-internal-dump-to-file",
+            "-Dsonar.scanner.internal.dumpToFile",
             type=str,
             help="Filename where the input to the scanner engine will be dumped. Useful for debugging",
         )
         parser.add_argument(
             "--sonar-scanner-internal-sq-version",
+            "-Dsonar.scanner.internal.sqVersion",
             type=str,
             help="Emulate the result of the call to get SQ server version.  Useful for debugging with --sonar-scanner-internal-dump-to-file",
         )
 
         parser.add_argument(
             "--sonar-scanner-connect-timeout",
+            "-Dsonar.scanner.connectTimeout",
             type=int,
             help="Time period to establish connections with the server (in seconds)",
         )
         parser.add_argument(
             "--sonar-scanner-socket-timeout",
+            "-Dsonar.scanner.socketTimeout",
             type=int,
             help="Maximum time of inactivity between two data packets when exchanging data with the server (in seconds)",
         )
         parser.add_argument(
             "--sonar-scanner-response-timeout",
+            "-Dsonar.scanner.responseTimeout",
             type=int,
             help="Time period required to process an HTTP call: from sending a request to receiving a response (in seconds)",
         )
 
         parser.add_argument(
             "--sonar-scanner-truststore-path",
+            "-Dsonar.scanner.truststorePath",
             type=str,
             help="Path to the keystore containing trusted server certificates, used by the Scanner in addition to OS and the built-in certificates",
         )
-        parser.add_argument("--sonar-scanner-truststore-password", type=str, help="Password to access the truststore")
+        parser.add_argument(
+            "--sonar-scanner-truststore-password",
+            "-Dsonar.scanner.truststorePassword",
+            type=str,
+            help="Password to access the truststore",
+        )
 
         parser.add_argument(
             "--sonar-scanner-keystore-path",
+            "-Dsonar.scanner.keystorePath",
             type=str,
             help="Path to the keystore containing the client certificates used by the scanner. By default, <sonar.userHome>/ssl/keystore.p12",
         )
-        parser.add_argument("--sonar-scanner-keystore-password", type=str, help="Password to access the keystore")
+        parser.add_argument(
+            "--sonar-scanner-keystore-password",
+            "-Dsonar.scanner.keystorePassword",
+            type=str,
+            help="Password to access the keystore",
+        )
 
-        parser.add_argument("--sonar-scanner-proxy-host", type=str, help="Proxy host")
-        parser.add_argument("--sonar-scanner-proxy-port", type=int, help="Proxy port")
-        parser.add_argument("--sonar-scanner-proxy-user", type=str, help="Proxy user")
-        parser.add_argument("--sonar-scanner-proxy-password", type=str, help="Proxy password")
+        parser.add_argument("--sonar-scanner-proxy-host", "-Dsonar.scanner.proxyHost", type=str, help="Proxy host")
+        parser.add_argument("--sonar-scanner-proxy-port", "-Dsonar.scanner.proxyPort", type=int, help="Proxy port")
+        parser.add_argument("--sonar-scanner-proxy-user", "-Dsonar.scanner.proxyUser", type=str, help="Proxy user")
+        parser.add_argument(
+            "--sonar-scanner-proxy-password", "-Dsonar.scanner.proxyPassword", type=str, help="Proxy password"
+        )
 
         parser.add_argument(
             "--sonar-project-base-dir",
+            "-Dsonar.projectBaseDir",
             type=str,
             help="Directory containing the project to be analyzed. Default is the current directory",
         )

tests/test_configuration_cli.py

@@ -106,7 +106,7 @@ def test_impossible_os_choice(self):
                 CliConfigurationLoader.load()
 
         error_output = mock_stderr.getvalue()
-        self.assertIn("""argument --sonar-scanner-os: invalid choice: 'windows2'""", error_output)
+        self.assertIn("""invalid choice: 'windows2'""", error_output)
 
     @patch(
         "sys.argv",
@@ -199,3 +199,71 @@ def test_all_cli_args(self):
         }
 
         self.assertEqual(configuration, expected_configuration)
+
+    @patch(
+        "sys.argv",
+        [
+            "myscript.py",
+            "-Dsonar.token=myToken",
+            "-Dsonar.projectKey=myProjectKey",
+            "-Dsonar.verbose",
+            "-Dsonar.host.url=mySonarHostUrl",
+            "-Dsonar.scanner.cloudUrl=mySonarScannerCloudUrl",
+            "-Dsonar.scanner.apiUrl=mySonarScannerApiUrl",
+            "-Dsonar.scanner.os=windows",
+            "-Dsonar.scanner.arch=x64",
+            "-Dsonar.scanner.connectTimeout=42",
+            "-Dsonar.scanner.internal.dumpToFile=mySonarScannerInternalDumpToFile",
+            "-Dsonar.scanner.internal.sqVersion=mySonarScannerInternalSqVersion",
+            "-Dsonar.scanner.socketTimeout=43",
+            "-Dsonar.scanner.responseTimeout=44",
+            "-Dsonar.scanner.truststorePath=mySonarScannerTruststorePath",
+            "-Dsonar.scanner.truststorePassword=mySonarScannerTruststorePassword",
+            "-Dsonar.scanner.keystorePath=mySonarScannerKeystorePath",
+            "-Dsonar.scanner.keystorePassword=mySonarScannerKeystorePassword",
+            "-Dsonar.scanner.proxyHost=mySonarScannerProxyHost",
+            "-Dsonar.scanner.proxyPort=45",
+            "-Dsonar.scanner.proxyUser=mySonarScannerProxyUser",
+            "-Dsonar.scanner.proxyPassword=mySonarScannerProxyPassword",
+            "-Dsonar.scanner.skipJreProvisioning",
+            "-Dsonar.scanner.javaExePath=mySonarScannerJavaExePath",
+            "-Dsonar.scanner.javaOpts=mySonarScannerJavaOpts",
+            "-Dsonar.region=us",
+            "-Dsonar.userHome=mySonarUserHome",
+            "-Dsonar.projectBaseDir=mySonarProjectBaseDir",
+        ],
+    )
+    def test_jvm_style_cli_args(self):
+        configuration = CliConfigurationLoader.load()
+        expected_configuration = {
+            "sonar.token": "myToken",
+            "sonar.projectKey": "myProjectKey",
+            "sonar.verbose": True,
+            "sonar.host.url": "mySonarHostUrl",
+            "sonar.scanner.sonarcloudUrl": "mySonarScannerCloudUrl",
+            "sonar.scanner.apiBaseUrl": "mySonarScannerApiUrl",
+            "sonar.scanner.os": "windows",
+            "sonar.scanner.arch": "x64",
+            "sonar.scanner.connectTimeout": 42,
+            "sonar.scanner.internal.dumpToFile": "mySonarScannerInternalDumpToFile",
+            "sonar.scanner.internal.sqVersion": "mySonarScannerInternalSqVersion",
+            "sonar.scanner.socketTimeout": 43,
+            "sonar.scanner.responseTimeout": 44,
+            "sonar.scanner.truststorePath": "mySonarScannerTruststorePath",
+            "sonar.scanner.truststorePassword": "mySonarScannerTruststorePassword",
+            "sonar.scanner.keystorePath": "mySonarScannerKeystorePath",
+            "sonar.scanner.keystorePassword": "mySonarScannerKeystorePassword",
+            "sonar.scanner.proxyHost": "mySonarScannerProxyHost",
+            "sonar.scanner.proxyPort": 45,
+            "sonar.scanner.proxyUser": "mySonarScannerProxyUser",
+            "sonar.scanner.proxyPassword": "mySonarScannerProxyPassword",
+            "sonar.scanner.skipJreProvisioning": True,
+            "sonar.scanner.javaExePath": "mySonarScannerJavaExePath",
+            "sonar.scanner.javaOpts": "mySonarScannerJavaOpts",
+            "sonar.region": "us",
+            "sonar.userHome": "mySonarUserHome",
+            "sonar.projectBaseDir": "mySonarProjectBaseDir",
+        }
+        for key in expected_configuration:
+            self.assertEqual(configuration[key], expected_configuration[key])
+        self.assertEqual(configuration, expected_configuration)