SCANPY-150 Introduce constants for property names (#152)

Author: Seppli11

src/pysonar_scanner/api.py

@@ -24,6 +24,13 @@
 import requests
 import requests.auth
 
+from pysonar_scanner.configuration.properties import (
+    SONAR_HOST_URL,
+    SONAR_SCANNER_SONARCLOUD_URL,
+    SONAR_SCANNER_API_BASE_URL,
+    SONAR_REGION,
+    Key,
+)
 from pysonar_scanner.exceptions import MissingKeyException, SonarQubeApiException
 from pysonar_scanner.utils import Arch, Os, remove_trailing_slash
 
@@ -104,22 +111,22 @@ def from_dict(dict: dict) -> "JRE":
 
 ApiConfiguration = TypedDict(
     "ApiConfiguration",
-    {"sonar.host.url": str, "sonar.scanner.sonarcloudUrl": str, "sonar.scanner.apiBaseUrl": str, "sonar.region": str},
+    {SONAR_HOST_URL: str, SONAR_SCANNER_SONARCLOUD_URL: str, SONAR_SCANNER_API_BASE_URL: str, SONAR_REGION: str},
 )
 
 
-def to_api_configuration(config_dict: dict[str, any]) -> ApiConfiguration:
+def to_api_configuration(config_dict: dict[Key, any]) -> ApiConfiguration:
     return {
-        "sonar.host.url": config_dict.get("sonar.host.url", ""),
-        "sonar.scanner.sonarcloudUrl": config_dict.get("sonar.scanner.sonarcloudUrl", ""),
-        "sonar.scanner.apiBaseUrl": config_dict.get("sonar.scanner.apiBaseUrl", ""),
-        "sonar.region": config_dict.get("sonar.region", ""),
+        SONAR_HOST_URL: config_dict.get(SONAR_HOST_URL, ""),
+        SONAR_SCANNER_SONARCLOUD_URL: config_dict.get(SONAR_SCANNER_SONARCLOUD_URL, ""),
+        SONAR_SCANNER_API_BASE_URL: config_dict.get(SONAR_SCANNER_API_BASE_URL, ""),
+        SONAR_REGION: config_dict.get(SONAR_REGION, ""),
     }
 
 
-def get_base_urls(config_dict: dict[str, any]) -> BaseUrls:
+def get_base_urls(config_dict: dict[Key, any]) -> BaseUrls:
     def is_sq_cloud_url(api_config: ApiConfiguration, sonar_host_url: str) -> bool:
-        sq_cloud_url = api_config["sonar.scanner.sonarcloudUrl"] or "https://sonarcloud.io"
+        sq_cloud_url = api_config[SONAR_SCANNER_SONARCLOUD_URL] or "https://sonarcloud.io"
         return remove_trailing_slash(sonar_host_url) == remove_trailing_slash(sq_cloud_url)
 
     def is_blank(str) -> bool:
@@ -130,14 +137,14 @@ def region_with_dot(region: str) -> str:
 
     api_config: ApiConfiguration = to_api_configuration(config_dict)
 
-    sonar_host_url = remove_trailing_slash(api_config["sonar.host.url"])
+    sonar_host_url = remove_trailing_slash(api_config[SONAR_HOST_URL])
     if is_blank(sonar_host_url) or is_sq_cloud_url(api_config, sonar_host_url):
-        region = region_with_dot(api_config["sonar.region"])
-        sonar_host_url = api_config["sonar.scanner.sonarcloudUrl"] or f"https://{region}sonarcloud.io"
-        api_base_url = api_config["sonar.scanner.apiBaseUrl"] or f"https://api.{region}sonarcloud.io"
+        region = region_with_dot(api_config[SONAR_REGION])
+        sonar_host_url = api_config[SONAR_SCANNER_SONARCLOUD_URL] or f"https://{region}sonarcloud.io"
+        api_base_url = api_config[SONAR_SCANNER_API_BASE_URL] or f"https://api.{region}sonarcloud.io"
         return BaseUrls(base_url=sonar_host_url, api_base_url=api_base_url, is_sonar_qube_cloud=True)
     else:
-        api_base_url = api_config["sonar.scanner.apiBaseUrl"] or f"{sonar_host_url}/api/v2"
+        api_base_url = api_config[SONAR_SCANNER_API_BASE_URL] or f"{sonar_host_url}/api/v2"
         return BaseUrls(base_url=sonar_host_url, api_base_url=api_base_url, is_sonar_qube_cloud=False)
 
 

src/pysonar_scanner/configuration/__init__.py

@@ -20,17 +20,18 @@
 
 from pysonar_scanner.configuration import properties
 from pysonar_scanner.configuration.cli import CliConfigurationLoader
+from pysonar_scanner.configuration.properties import SONAR_TOKEN, Key
 
 from pysonar_scanner.exceptions import MissingKeyException
 
 
-def get_static_default_properties() -> dict[str, any]:
+def get_static_default_properties() -> dict[Key, any]:
     return {prop.name: prop.default_value for prop in properties.PROPERTIES if prop.default_value is not None}
 
 
 class ConfigurationLoader:
     @staticmethod
-    def load() -> dict[str, any]:
+    def load() -> dict[Key, any]:
         # each property loader is required to return NO default values.
         # E.g. if no property has been set, an empty dict must be returned.
         # Default values should be set through the get_static_default_properties() method
@@ -41,7 +42,7 @@ def load() -> dict[str, any]:
         }
 
 
-def get_token(config: dict[str, any]) -> str:
-    if "sonar.token" not in config:
-        raise MissingKeyException('Missing property "sonar.token"')
-    return config["sonar.token"]
+def get_token(config: dict[Key, any]) -> str:
+    if SONAR_TOKEN not in config:
+        raise MissingKeyException(f'Missing property "{SONAR_TOKEN}"')
+    return config[SONAR_TOKEN]

src/pysonar_scanner/configuration/properties.py

@@ -22,10 +22,45 @@
 from dataclasses import dataclass
 from typing import Callable, Optional
 
+Key = str
+
+SONAR_HOST_URL: Key = "sonar.host.url"
+SONAR_SCANNER_SONARCLOUD_URL: Key = "sonar.scanner.sonarcloudUrl"
+SONAR_SCANNER_API_BASE_URL: Key = "sonar.scanner.apiBaseUrl"
+SONAR_REGION: Key = "sonar.region"
+SONAR_SCANNER_APP: Key = "sonar.scanner.app"
+SONAR_SCANNER_APP_VERSION: Key = "sonar.scanner.appVersion"
+SONAR_SCANNER_BOOTSTRAP_START_TIME: Key = "sonar.scanner.bootstrapStartTime"
+SONAR_SCANNER_WAS_JRE_CACHE_HIT: Key = "sonar.scanner.wasJreCacheHit"
+SONAR_SCANNER_WAS_ENGINE_CACHE_HIT: Key = "sonar.scanner.wasEngineCacheHit"
+SONAR_VERBOSE: Key = "sonar.verbose"
+SONAR_TOKEN: Key = "sonar.token"
+SONAR_SCANNER_OS: Key = "sonar.scanner.os"
+SONAR_SCANNER_ARCH: Key = "sonar.scanner.arch"
+SONAR_SCANNER_SKIP_JRE_PROVISIONING: Key = "sonar.scanner.skipJreProvisioning"
+SONAR_USER_HOME: Key = "sonar.userHome"
+SONAR_SCANNER_JAVA_EXE_PATH: Key = "sonar.scanner.javaExePath"
+SONAR_SCANNER_INTERNAL_DUMP_TO_FILE: Key = "sonar.scanner.internal.dumpToFile"
+SONAR_SCANNER_INTERNAL_SQ_VERSION: Key = "sonar.scanner.internal.sqVersion"
+SONAR_SCANNER_CONNECT_TIMEOUT: Key = "sonar.scanner.connectTimeout"
+SONAR_SCANNER_SOCKET_TIMEOUT: Key = "sonar.scanner.socketTimeout"
+SONAR_SCANNER_RESPONSE_TIMEOUT: Key = "sonar.scanner.responseTimeout"
+SONAR_SCANNER_TRUSTSTORE_PATH: Key = "sonar.scanner.truststorePath"
+SONAR_SCANNER_TRUSTSTORE_PASSWORD: Key = "sonar.scanner.truststorePassword"
+SONAR_SCANNER_KEYSTORE_PATH: Key = "sonar.scanner.keystorePath"
+SONAR_SCANNER_KEYSTORE_PASSWORD: Key = "sonar.scanner.keystorePassword"
+SONAR_SCANNER_PROXY_HOST: Key = "sonar.scanner.proxyHost"
+SONAR_SCANNER_PROXY_PORT: Key = "sonar.scanner.proxyPort"
+SONAR_SCANNER_PROXY_USER: Key = "sonar.scanner.proxyUser"
+SONAR_SCANNER_PROXY_PASSWORD: Key = "sonar.scanner.proxyPassword"
+SONAR_PROJECT_BASE_DIR: Key = "sonar.projectBaseDir"
+SONAR_SCANNER_JAVA_OPTS: Key = "sonar.scanner.javaOpts"
+SONAR_PROJECT_KEY: Key = "sonar.projectKey"
+
 
 @dataclass
 class Property:
-    name: str
+    name: Key
     """name in the format of `sonar.scanner.appVersion`"""
 
     default_value: Optional[any]
@@ -38,162 +73,162 @@ class Property:
 # fmt: off
 PROPERTIES: list[Property] = [
     Property(
-        name="sonar.scanner.app", 
+        name=SONAR_SCANNER_APP, 
         default_value="python", 
         cli_getter=None
     ),
     Property(
-        name="sonar.scanner.appVersion", 
+        name=SONAR_SCANNER_APP_VERSION, 
         default_value="1.0", 
         cli_getter=None
     ),
     Property(
-        name="sonar.scanner.bootstrapStartTime",
+        name=SONAR_SCANNER_BOOTSTRAP_START_TIME,
         default_value=int(time.time() * 1000),
         cli_getter=None
     ),
     Property(
-        name="sonar.scanner.wasJreCacheHit", 
+        name=SONAR_SCANNER_WAS_JRE_CACHE_HIT, 
         default_value=None, 
         cli_getter=None
     ),
     Property(
-        name="sonar.scanner.wasEngineCacheHit", 
+        name=SONAR_SCANNER_WAS_ENGINE_CACHE_HIT, 
         default_value=None, 
         cli_getter=None
     ),
     Property(
-        name="sonar.verbose", 
+        name=SONAR_VERBOSE, 
         default_value=False, 
         cli_getter=lambda args: args.verbose
     ),
     Property(
-        name="sonar.host.url", 
+        name=SONAR_HOST_URL, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_host_url
     ),  
     Property(
-        name="sonar.region", 
+        name=SONAR_REGION, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_region
     ),
     Property(
-        name="sonar.scanner.sonarcloudUrl",
+        name=SONAR_SCANNER_SONARCLOUD_URL,
         default_value=None,
         cli_getter=lambda args: args.sonar_scanner_cloud_url
     ),  
     Property(
-        name="sonar.scanner.apiBaseUrl", 
+        name=SONAR_SCANNER_API_BASE_URL, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_api_url
     ),  
     Property(
-        name="sonar.token", 
+        name=SONAR_TOKEN, 
         default_value=None, 
         cli_getter=lambda args: args.token
     ),
     Property(
-        name="sonar.scanner.os", 
+        name=SONAR_SCANNER_OS, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_os
     ),
     Property(
-        name="sonar.scanner.arch", 
+        name=SONAR_SCANNER_ARCH, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_arch
     ),
     Property(
-        name="sonar.scanner.skipJreProvisioning",
+        name=SONAR_SCANNER_SKIP_JRE_PROVISIONING,
         default_value=False,
         cli_getter=lambda args: args.skip_jre_provisioning
     ),
     Property(
-        name="sonar.userHome", 
+        name=SONAR_USER_HOME, 
         default_value="~/.sonar", 
         cli_getter=lambda args: args.sonar_user_home
     ),  
     Property(
-        name="sonar.scanner.javaExePath", 
+        name=SONAR_SCANNER_JAVA_EXE_PATH, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_java_exe_path
     ),
     Property(
-        name="sonar.scanner.internal.dumpToFile",
+        name=SONAR_SCANNER_INTERNAL_DUMP_TO_FILE,
         default_value=None,
         cli_getter=lambda args: args.sonar_scanner_internal_dump_to_file
     ),
     Property(
-        name="sonar.scanner.internal.sqVersion",
+        name=SONAR_SCANNER_INTERNAL_SQ_VERSION,
         default_value=None,
         cli_getter=lambda args: args.sonar_scanner_internal_sq_version
     ),
     Property(
-        name="sonar.scanner.connectTimeout",
+        name=SONAR_SCANNER_CONNECT_TIMEOUT,
         default_value=5,
         cli_getter=lambda args: args.sonar_scanner_connect_timeout
     ),
     Property(
-        name="sonar.scanner.socketTimeout",
+        name=SONAR_SCANNER_SOCKET_TIMEOUT,
         default_value=60,
         cli_getter=lambda args: args.sonar_scanner_socket_timeout
     ),
     Property(
-        name="sonar.scanner.responseTimeout",
+        name=SONAR_SCANNER_RESPONSE_TIMEOUT,
         default_value=0,
         cli_getter=lambda args: args.sonar_scanner_response_timeout
     ),
     Property(
-        name="sonar.scanner.truststorePath",
+        name=SONAR_SCANNER_TRUSTSTORE_PATH,
         default_value=None,  
         cli_getter=lambda args: args.sonar_scanner_truststore_path
     ),
     Property(
-        name="sonar.scanner.truststorePassword",
+        name=SONAR_SCANNER_TRUSTSTORE_PASSWORD,
         default_value="changeit",  
         cli_getter=lambda args: args.sonar_scanner_truststore_password
     ),
     Property(
-        name="sonar.scanner.keystorePath",
+        name=SONAR_SCANNER_KEYSTORE_PATH,
         default_value=None,
         cli_getter=lambda args: args.sonar_scanner_keystore_path
     ),  
     Property(
-        name="sonar.scanner.keystorePassword",
+        name=SONAR_SCANNER_KEYSTORE_PASSWORD,
         default_value="changeit",  
         cli_getter=lambda args: args.sonar_scanner_keystore_password
     ),
     Property(
-        name="sonar.scanner.proxyHost", 
+        name=SONAR_SCANNER_PROXY_HOST, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_proxy_host
     ),
     Property(
-        name="sonar.scanner.proxyPort", 
+        name=SONAR_SCANNER_PROXY_PORT, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_proxy_port
     ),  
     Property(
-        name="sonar.scanner.proxyUser", 
+        name=SONAR_SCANNER_PROXY_USER, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_proxy_user
     ),
     Property(
-        name="sonar.scanner.proxyPassword",
+        name=SONAR_SCANNER_PROXY_PASSWORD,
         default_value=None,
         cli_getter=lambda args: args.sonar_scanner_proxy_password
     ),
     Property(
-        name="sonar.projectBaseDir", 
+        name=SONAR_PROJECT_BASE_DIR, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_project_base_dir
     ),  
     Property(
-        name="sonar.scanner.javaOpts", 
+        name=SONAR_SCANNER_JAVA_OPTS, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_java_opts
     ),
     Property(
-        name="sonar.projectKey", 
+        name=SONAR_PROJECT_KEY, 
         default_value=None, 
         cli_getter=lambda args: args.sonar_project_key
     ),

src/pysonar_scanner/jre.py

@@ -33,6 +33,12 @@
     UnsupportedArchiveFormat,
 )
 from pysonar_scanner.exceptions import JreProvisioningException
+from pysonar_scanner.configuration.properties import (
+    SONAR_SCANNER_JAVA_EXE_PATH,
+    SONAR_SCANNER_SKIP_JRE_PROVISIONING,
+    SONAR_SCANNER_OS,
+    Key,
+)
 
 
 @dataclass(frozen=True)
@@ -130,11 +136,11 @@ class JREResolverConfiguration:
     sonar_scanner_os: Optional[str]
 
     @staticmethod
-    def from_dict(config_dict: dict[str, any]) -> "JREResolverConfiguration":
+    def from_dict(config_dict: dict[Key, any]) -> "JREResolverConfiguration":
         return JREResolverConfiguration(
-            sonar_scanner_java_exe_path=config_dict.get("sonar.scanner.javaExePath", None),
-            sonar_scanner_skip_jre_provisioning=config_dict.get("sonar.scanner.skipJreProvisioning", False),
-            sonar_scanner_os=config_dict.get("sonar.scanner.os", None),
+            sonar_scanner_java_exe_path=config_dict.get(SONAR_SCANNER_JAVA_EXE_PATH, None),
+            sonar_scanner_skip_jre_provisioning=config_dict.get(SONAR_SCANNER_SKIP_JRE_PROVISIONING, False),
+            sonar_scanner_os=config_dict.get(SONAR_SCANNER_OS, None),
         )