raise issue on sonar.token and sonar.projectKey

Author: Seppli11

src/pysonar_scanner/__main__.py

@@ -44,6 +44,8 @@ def scan():
     config = ConfigurationLoader.load()
     set_logging_options(config)
 
+    ConfigurationLoader.check_configuration(config)
+
     api = build_api(config)
     check_version(api)
     update_config_with_api_urls(config, api.base_urls)

src/pysonar_scanner/api.py

@@ -31,8 +31,8 @@
     SONAR_REGION,
     Key,
 )
-from pysonar_scanner.exceptions import MissingKeyException, SonarQubeApiException, InconsistentConfiguration
 from pysonar_scanner.utils import remove_trailing_slash, OsStr, ArchStr
+from pysonar_scanner.exceptions import SonarQubeApiException, InconsistentConfiguration
 
 GLOBAL_SONARCLOUD_URL = "https://sonarcloud.io"
 US_SONARCLOUD_URL = "https://sonarqube.us"
@@ -98,18 +98,15 @@ class JRE:
 
     @staticmethod
     def from_dict(dict: dict) -> "JRE":
-        try:
-            return JRE(
-                id=dict["id"],
-                filename=dict["filename"],
-                sha256=dict["sha256"],
-                java_path=dict["javaPath"],
-                os=dict["os"],
-                arch=dict["arch"],
-                download_url=dict.get("downloadUrl", None),
-            )
-        except KeyError as e:
-            raise MissingKeyException(f"Missing key in dictionary {dict}") from e
+        return JRE(
+            id=dict["id"],
+            filename=dict["filename"],
+            sha256=dict["sha256"],
+            java_path=dict["javaPath"],
+            os=dict["os"],
+            arch=dict["arch"],
+            download_url=dict.get("downloadUrl", None),
+        )
 
 
 ApiConfiguration = TypedDict(
@@ -243,7 +240,7 @@ def get_analysis_jres(self, os: OsStr, arch: ArchStr) -> list[JRE]:
             res.raise_for_status()
             json_array = res.json()
             return [JRE.from_dict(jre) for jre in json_array]
-        except (requests.RequestException, MissingKeyException) as e:
+        except (requests.RequestException, KeyError) as e:
             raise SonarQubeApiException("Error while fetching the analysis version") from e
 
     def download_analysis_jre(self, id: str, handle: typing.BinaryIO) -> None:

src/pysonar_scanner/configuration/configuration_loader.py

@@ -21,11 +21,11 @@
 
 from pysonar_scanner.configuration.cli import CliConfigurationLoader
 from pysonar_scanner.configuration.pyproject_toml import TomlConfigurationLoader
-from pysonar_scanner.configuration.properties import SONAR_TOKEN, SONAR_PROJECT_BASE_DIR, Key
+from pysonar_scanner.configuration.properties import SONAR_PROJECT_KEY, SONAR_TOKEN, SONAR_PROJECT_BASE_DIR, Key
 from pysonar_scanner.configuration.properties import PROPERTIES
 from pysonar_scanner.configuration import sonar_project_properties, environment_variables, dynamic_defaults_loader
 
-from pysonar_scanner.exceptions import MissingKeyException
+from pysonar_scanner.exceptions import MissingProperty, MissingPropertyException
 
 
 def get_static_default_properties() -> dict[Key, any]:
@@ -56,8 +56,20 @@ def load() -> dict[Key, any]:
         resolved_properties.update(cli_properties)
         return resolved_properties
 
+    @staticmethod
+    def check_configuration(config: dict[Key, any]) -> None:
+        missing_keys = []
+        if SONAR_TOKEN not in config:
+            missing_keys.append(MissingProperty(SONAR_TOKEN, "--token"))
+
+        if SONAR_PROJECT_KEY not in config:
+            missing_keys.append(MissingProperty(SONAR_PROJECT_KEY, "--project-key"))
+
+        if len(missing_keys) > 0:
+            raise MissingPropertyException.from_missing_keys(*missing_keys)
+
 
 def get_token(config: dict[Key, any]) -> str:
     if SONAR_TOKEN not in config:
-        raise MissingKeyException(f'Missing property "{SONAR_TOKEN}"')
+        raise MissingPropertyException(f'Missing property "{SONAR_TOKEN}"')
     return config[SONAR_TOKEN]

src/pysonar_scanner/exceptions.py

@@ -19,8 +19,21 @@
 #
 
 
-class MissingKeyException(Exception):
-    pass
+from dataclasses import dataclass
+import logging
+
+
+@dataclass
+class MissingProperty:
+    property: str
+    cli_arg: str
+
+
+class MissingPropertyException(Exception):
+    @staticmethod
+    def from_missing_keys(*properties: MissingProperty) -> "MissingPropertyException":
+        missing_properties = ", ".join([f"{prop.property} ({prop.cli_arg})" for prop in properties])
+        return MissingPropertyException(f"Missing required properties: {missing_properties}")
 
 
 class SonarQubeApiException(Exception):

tests/unit/test_configuration_loader.py

@@ -51,8 +51,9 @@
     SONAR_SCANNER_ARCH,
     SONAR_SCANNER_OS,
 )
-from pysonar_scanner.exceptions import MissingKeyException
 from pysonar_scanner.utils import Arch, Os
+from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader, SONAR_PROJECT_BASE_DIR
+from pysonar_scanner.exceptions import MissingPropertyException
 
 
 # Mock utils.get_os and utils.get_arch at the module level
@@ -116,7 +117,7 @@ def test_get_token(self, mock_get_os, mock_get_arch):
         with self.subTest("Token is present"):
             self.assertEqual(configuration_loader.get_token({SONAR_TOKEN: "myToken"}), "myToken")
 
-        with self.subTest("Token is absent"), self.assertRaises(MissingKeyException):
+        with self.subTest("Token is absent"), self.assertRaises(MissingPropertyException):
             configuration_loader.get_token({})
 
     @patch("sys.argv", ["myscript.py", "--token", "myToken", "--sonar-project-key", "myProjectKey"])
@@ -428,3 +429,21 @@ def test_unknown_args_with_D_prefix(self, mock_get_os, mock_get_arch):
         self.assertEqual(configuration["another.unknown.property"], "anotherValue")
         self.assertEqual(configuration[SONAR_TOKEN], "myToken")
         self.assertEqual(configuration[SONAR_PROJECT_KEY], "myProjectKey")
+
+    def test_check_configuration(self, mock_get_os, mock_get_arch):
+        with self.subTest("Both values present"):
+            ConfigurationLoader.check_configuration({SONAR_TOKEN: "", SONAR_PROJECT_KEY: ""})
+
+        with self.subTest("missing keys"):
+            with self.assertRaises(MissingPropertyException) as cm:
+                ConfigurationLoader.check_configuration({SONAR_PROJECT_KEY: "myKey"})
+            self.assertIn(SONAR_TOKEN, str(cm.exception))
+
+            with self.assertRaises(MissingPropertyException) as cm:
+                ConfigurationLoader.check_configuration({SONAR_TOKEN: "myToken"})
+            self.assertIn(SONAR_PROJECT_KEY, str(cm.exception))
+
+            with self.assertRaises(MissingPropertyException) as cm:
+                ConfigurationLoader.check_configuration({})
+            self.assertIn(SONAR_PROJECT_KEY, str(cm.exception))
+            self.assertIn(SONAR_TOKEN, str(cm.exception))