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

@@ -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:
@@ -112,6 +115,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."""
@@ -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

tests/test_environment_variables.py

@@ -17,9 +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.
 #
-from json import JSONDecodeError
 import unittest
-from unittest.mock import MagicMock, patch
+from unittest.mock import patch
 
 from pysonar_scanner.configuration import environment_variables
 from pysonar_scanner.configuration.properties import (
@@ -31,6 +30,7 @@
     SONAR_TOKEN,
     SONAR_USER_HOME,
     SONAR_PROJECT_KEY,
+    SONAR_SCANNER_OPTS,
 )
 
 
@@ -134,3 +134,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.",
+            )