SCANPY-178: The scanner should respect the SONAR_SCANNER_OPTS environment variable

Author: joke1196

src/pysonar_scanner/configuration/environment_variables.py

@@ -63,4 +63,6 @@ def load_properties_env_variables():
         env_var_name = prop.env_variable_name()
         if env_var_name in os.environ:
             properties[prop.name] = os.environ[env_var_name]
+            if prop.deprecated:
+                logging.warning(prop.deprecation_message)
     return properties

src/pysonar_scanner/configuration/properties.py

@@ -17,8 +17,8 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
-import time
 import argparse
+import time
 from dataclasses import dataclass
 from typing import Any, Callable, Optional
 
@@ -101,6 +101,9 @@
 SONAR_PYTHON_RUFF_REPORT_PATHS = "sonar.python.ruff.reportPaths"
 TOML_PATH: Key = "toml-path"
 
+# ============ DEPRECATED ==============
+SONAR_SCANNER_OPTS = "sonar.scanner.opts"
+
 
 @dataclass
 class Property:
@@ -113,6 +116,10 @@ class Property:
     cli_getter: Optional[Callable[[argparse.Namespace], Any]] = None
     """function to get the value from the CLI arguments namespace. If None, the property is not settable via CLI"""
 
+    deprecated: bool = False
+
+    deprecation_message: Optional[str] = None
+
     def python_name(self) -> str:
         """Convert Java-style camel case name to Python-style kebab-case name."""
         result = []
@@ -524,6 +531,13 @@ def env_variable_name(self) -> str:
         name=SONAR_MODULES,
         default_value=None,
         cli_getter=lambda args: args.sonar_modules
+    ),
+    Property(
+        name=SONAR_SCANNER_OPTS,
+        default_value=None,
+        cli_getter=None,
+        deprecated=True,
+        deprecation_message="SONAR_SCANNER_OPTS is deprecated, please use SONAR_SCANNER_JAVA_OPTS instead."
     )
 ]
 # fmt: on

src/pysonar_scanner/scannerengine.py

@@ -20,15 +20,18 @@
 import json
 import logging
 import pathlib
-from dataclasses import dataclass
 import shlex
-from subprocess import Popen, PIPE
+from dataclasses import dataclass
+from subprocess import PIPE, Popen
 from threading import Thread
 from typing import IO, Any, Callable, Optional
 
 from pysonar_scanner.api import EngineInfo, SonarQubeApi
 from pysonar_scanner.cache import Cache, CacheFile
-from pysonar_scanner.configuration.properties import SONAR_SCANNER_JAVA_OPTS
+from pysonar_scanner.configuration.properties import (
+    SONAR_SCANNER_JAVA_OPTS,
+    SONAR_SCANNER_OPTS,
+)
 from pysonar_scanner.exceptions import ChecksumException
 from pysonar_scanner.jre import JREResolvedPath
 
@@ -97,7 +100,9 @@ def __log_output(self, stream: IO[bytes]):
             log_line = parse_log_line(decoded_line)
             self.log_line_listener(log_line)
 
-    def __process_output(self, output_thread: Thread, error_thread: Thread, process: Popen) -> int:
+    def __process_output(
+        self, output_thread: Thread, error_thread: Thread, process: Popen
+    ) -> int:
         output_thread.start()
         error_thread.start()
         process.wait()
@@ -117,7 +122,9 @@ def provision(self) -> pathlib.Path:
         if scanner_file is not None:
             return scanner_file.filepath
         # Retry once in case the checksum failed due to the scanner engine being updated between getting the checksum and downloading the jar
-        logging.warning("Something went wrong while downloading the scanner engine. Retrying...")
+        logging.warning(
+            "Something went wrong while downloading the scanner engine. Retrying..."
+        )
         scanner_file = self.__download_and_verify()
         if scanner_file is not None:
             return scanner_file.filepath
@@ -132,7 +139,9 @@ def __download_and_verify(self) -> Optional[CacheFile]:
             self.__download_scanner_engine(cache_file, engine_info)
         return cache_file if cache_file.is_valid() else None
 
-    def __download_scanner_engine(self, cache_file: CacheFile, engine_info: EngineInfo) -> None:
+    def __download_scanner_engine(
+        self, cache_file: CacheFile, engine_info: EngineInfo
+    ) -> None:
         with cache_file.open(mode="wb") as f:
             if engine_info.download_url is not None:
                 self.api.download_file_from_url(engine_info.download_url, f)
@@ -148,6 +157,7 @@ def __init__(self, jre_path: JREResolvedPath, scanner_engine_path: pathlib.Path)
     def run(self, config: dict[str, Any]):
         # Extract Java options if present; they must influence the JVM invocation, not the scanner engine itself
         java_opts = config.get(SONAR_SCANNER_JAVA_OPTS)
+        java_opts = config.get(SONAR_SCANNER_OPTS) if not java_opts else java_opts
 
         cmd = self.__build_command(self.jre_path, self.scanner_engine_path, java_opts)
         logging.debug(f"Command: {cmd}")
@@ -173,7 +183,11 @@ def __build_command(
 
     def __config_to_json(self, config: dict[str, Any]) -> str:
         # SONAR_SCANNER_JAVA_OPTS are properties that shouldn't be passed to the engine, only to the JVM
-        scanner_properties = [{"key": k, "value": v} for k, v in config.items() if k != SONAR_SCANNER_JAVA_OPTS]
+        scanner_properties = [
+            {"key": k, "value": v}
+            for k, v in config.items()
+            if k != SONAR_SCANNER_JAVA_OPTS and k != SONAR_SCANNER_OPTS
+        ]
         return json.dumps({"scannerProperties": scanner_properties})
 
     def __decompose_java_opts(self, java_opts: str) -> list[str]:

tests/test_environment_variables.py

@@ -31,6 +31,7 @@
     SONAR_TOKEN,
     SONAR_USER_HOME,
     SONAR_PROJECT_KEY,
+    SONAR_SCANNER_OPTS,
 )
 
 
@@ -134,3 +135,27 @@ def test_environment_variables_priority_over_json_params(self):
             }
             self.assertEqual(len(properties), 3)
             self.assertDictEqual(properties, expected_properties)
+
+    @patch("pysonar_scanner.configuration.environment_variables.logging")
+    def test_SONAR_SCANNER_OPTS(self, mock_logging):
+        env = {
+            "SONAR_TOKEN": "my-token",
+            "SONAR_HOST_URL": "https://sonarqube.example.com",
+            "SONAR_USER_HOME": "/custom/sonar/home",
+            "SONAR_SCANNER_OPTS": "-Xmx1024m -XX:MaxPermSize=256m",
+            "SONAR_REGION": "us",
+        }
+        with patch.dict("os.environ", env, clear=True):
+            properties = environment_variables.load()
+            expected_properties = {
+                SONAR_TOKEN: "my-token",
+                SONAR_HOST_URL: "https://sonarqube.example.com",
+                SONAR_USER_HOME: "/custom/sonar/home",
+                SONAR_SCANNER_OPTS: "-Xmx1024m -XX:MaxPermSize=256m",
+                SONAR_REGION: "us",
+            }
+            self.assertEqual(len(properties), 5)
+            self.assertDictEqual(properties, expected_properties)
+            mock_logging.warning.assert_called_once_with(
+                "SONAR_SCANNER_OPTS is deprecated, please use SONAR_SCANNER_JAVA_OPTS instead.",
+            )