SCANPY-155 Provide properties computed during bootstrapping to the scanner engine

Author: guillaume-dequenne

src/pysonar_scanner/__main__.py

@@ -20,10 +20,16 @@
 
 from pysonar_scanner import app_logging
 from pysonar_scanner import cache
-from pysonar_scanner.api import get_base_urls, SonarQubeApi
+from pysonar_scanner.api import get_base_urls, SonarQubeApi, BaseUrls
 from pysonar_scanner.configuration import configuration_loader
 from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader
-from pysonar_scanner.configuration.properties import SONAR_VERBOSE
+from pysonar_scanner.configuration.properties import (
+    SONAR_VERBOSE,
+    SONAR_HOST_URL,
+    SONAR_SCANNER_API_BASE_URL,
+    SONAR_SCANNER_SONARCLOUD_URL,
+    SONAR_SCANNER_PROXY_PORT,
+)
 from pysonar_scanner.scannerengine import ScannerEngine
 
 
@@ -35,6 +41,7 @@ def scan():
 
     cache_manager = cache.get_default()
     api = __build_api(config)
+    __update_config_with_api_urls(config, api.base_urls)
     scanner = ScannerEngine(api, cache_manager)
     return scanner.run(config)
 
@@ -47,3 +54,12 @@ def __build_api(config: dict[str, any]) -> SonarQubeApi:
     token = configuration_loader.get_token(config)
     base_urls = get_base_urls(config)
     return SonarQubeApi(base_urls, token)
+
+
+def __update_config_with_api_urls(config, base_urls: BaseUrls):
+    config[SONAR_HOST_URL] = base_urls.base_url
+    config[SONAR_SCANNER_API_BASE_URL] = base_urls.api_base_url
+    if base_urls.is_sonar_qube_cloud:
+        config[SONAR_SCANNER_SONARCLOUD_URL] = base_urls.base_url
+    config[SONAR_SCANNER_SONARCLOUD_URL] = base_urls.base_url
+    config[SONAR_SCANNER_PROXY_PORT] = "443" if base_urls.base_url.startswith("https") else "80"

src/pysonar_scanner/scannerengine.py

@@ -17,23 +17,20 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
-from enum import Enum
 import json
 import logging
-from operator import le
 import pathlib
+from dataclasses import dataclass
+from subprocess import Popen, PIPE
 from threading import Thread
 from typing import IO, Callable, Optional
 
-from dataclasses import dataclass
-
 import pysonar_scanner.api as api
-
 from pysonar_scanner.api import SonarQubeApi
 from pysonar_scanner.cache import Cache, CacheFile
+from pysonar_scanner.configuration.properties import SONAR_SCANNER_JAVA_EXE_PATH
 from pysonar_scanner.exceptions import ChecksumException, SQTooOldException
 from pysonar_scanner.jre import JREProvisioner, JREResolvedPath, JREResolver, JREResolverConfiguration
-from subprocess import Popen, PIPE
 
 
 @dataclass(frozen=True)
@@ -149,6 +146,8 @@ def __fetch_scanner_engine(self) -> pathlib.Path:
     def run(self, config: dict[str, any]):
         self.__version_check()
         jre_path = self.__resolve_jre(config)
+
+        config[SONAR_SCANNER_JAVA_EXE_PATH] = str(jre_path.path)
         scanner_engine_path = self.__fetch_scanner_engine()
         cmd = self.__build_command(jre_path, scanner_engine_path)
         properties_str = self.__config_to_json(config)

tests/unit/test_main.py

@@ -23,13 +23,36 @@
 
 from pysonar_scanner.__main__ import scan
 from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader
-from pysonar_scanner.configuration.properties import SONAR_PROJECT_KEY, SONAR_TOKEN
+from pysonar_scanner.configuration.properties import (
+    SONAR_PROJECT_KEY,
+    SONAR_TOKEN,
+    SONAR_HOST_URL,
+    SONAR_SCANNER_API_BASE_URL,
+    SONAR_SCANNER_SONARCLOUD_URL,
+    SONAR_SCANNER_PROXY_PORT,
+)
 from pysonar_scanner.scannerengine import ScannerEngine
 
 
 class TestMain(pyfakefs.TestCase):
     @patch.object(ConfigurationLoader, "load", return_value={SONAR_TOKEN: "myToken", SONAR_PROJECT_KEY: "myProjectKey"})
     @patch.object(ScannerEngine, "run", return_value=0)
-    def test_minimal_success_run(self, load_mock, run_mock):
+    def test_minimal_success_run(self, run_mock, load_mock):
         exitcode = scan()
         self.assertEqual(exitcode, 0)
+
+        # Verify that run was called with the expected configuration
+        run_mock.assert_called_once()
+        config = run_mock.call_args[0][0]  # Extract the configuration arg
+
+        # Check expected configuration with a single assertion
+        expected_config = {
+            SONAR_TOKEN: "myToken",
+            SONAR_PROJECT_KEY: "myProjectKey",
+            SONAR_HOST_URL: "https://sonarcloud.io",
+            SONAR_SCANNER_API_BASE_URL: "https://api.sonarcloud.io",
+            SONAR_SCANNER_SONARCLOUD_URL: "https://sonarcloud.io",
+            SONAR_SCANNER_PROXY_PORT: "443",
+        }
+
+        self.assertEqual(expected_config, config)

tests/unit/test_scannerengine.py

@@ -19,29 +19,26 @@
 #
 import json
 import logging
-from math import log
-from subprocess import PIPE
-import unittest
 import pathlib
+import unittest
+from subprocess import PIPE
+from unittest.mock import Mock
+from unittest.mock import patch, MagicMock
+
 import pyfakefs.fake_filesystem_unittest as pyfakefs
 
-from pysonar_scanner import app_logging, cache
+from pysonar_scanner import cache
 from pysonar_scanner import scannerengine
+from pysonar_scanner.api import SQVersion
 from pysonar_scanner.exceptions import ChecksumException, SQTooOldException
-from pysonar_scanner.jre import JREProvisioner, JREResolvedPath, JREResolver
+from pysonar_scanner.jre import JREResolvedPath, JREResolver
 from pysonar_scanner.scannerengine import (
-    CmdExecutor,
     LogLine,
     ScannerEngine,
     ScannerEngineProvisioner,
     default_log_line_listener,
-    parse_log_line,
 )
-from unittest.mock import Mock
-
-from pysonar_scanner.api import SQVersion
 from tests.unit import sq_api_utils
-from unittest.mock import patch, MagicMock
 
 
 class TestLogLine(unittest.TestCase):
@@ -154,6 +151,9 @@ def test_command_building(self, provision_mock, resolve_jre_mock, execute_mock):
                 "scannerProperties": [
                     {"key": "sonar.token", "value": "myToken"},
                     {"key": "sonar.projectKey", "value": "myProjectKey"},
+                    {"key": "sonar.scanner.os", "value": "linux"},
+                    {"key": "sonar.scanner.arch", "value": "x64"},
+                    {"key": "sonar.scanner.javaExePath", "value": "jre/bin/java"},
                 ]
             }
         )