SCANPY-115 Parse the scanner properties from the generic environnement variables (#164)

Author: guillaume-dequenne

src/pysonar_scanner/configuration/environment_variables.py

@@ -18,6 +18,7 @@
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 import os
+import json
 from typing import Dict
 
 from pysonar_scanner.configuration.properties import Key, PROPERTIES
@@ -30,11 +31,34 @@ def load() -> Dict[Key, str]:
     Returns:
         Dictionary of property keys and their values extracted from environment variables.
     """
-    properties = {}
     # Extract properties from environment variables using the env_variable_name() method
+
+    # First check for JSON params environment variable
+    properties = load_json_env_variables()
+    # Extract properties from environment variables using the mapping in Property objects
+    properties.update(load_properties_env_variables())
+
+    return properties
+
+
+def load_json_env_variables():
+    properties = {}
+    if "SONAR_SCANNER_JSON_PARAMS" in os.environ:
+        try:
+            json_params = os.environ["SONAR_SCANNER_JSON_PARAMS"]
+            json_properties = json.loads(json_params)
+            properties.update(json_properties)
+        except json.JSONDecodeError:
+            # If JSON is invalid, continue with regular environment variables
+            # SCANPY-135 should log the error
+            pass
+    return properties
+
+
+def load_properties_env_variables():
+    properties = {}
     for prop in PROPERTIES:
         env_var_name = prop.env_variable_name()
         if env_var_name in os.environ:
             properties[prop.name] = os.environ[env_var_name]
-
     return properties

tests/test_configuration_loader.py

@@ -299,6 +299,7 @@ def test_load_from_env_variables_only(self):
             "SONAR_HOST_URL": "https://sonar.env.example.com",  # Not set elsewhere, should be used
             "SONAR_USER_HOME": "/env/sonar/home",  # Should be used (overriding sonar-project.properties)
             "SONAR_SCANNER_JAVA_OPTS": "-Xmx2048m",  # Unique to env vars
+            "SONAR_SCANNER_JSON_PARAMS": '{"sonar.exclusions": "json-exclusions/**/*", "SONAR_HOST_URL": "https://sonar.env.example.com"}',  # JSON params
         },
         clear=True,
     )
@@ -361,10 +362,12 @@ def test_properties_priority(self):
 
         # pyproject.toml [tool.sonar] section overrides sonar-project.properties
         self.assertEqual(configuration[SONAR_SOURCES], "src/toml")
-        self.assertEqual(configuration[SONAR_EXCLUSIONS], "toml-exclusions/**/*")
         self.assertEqual(configuration[SONAR_PROJECT_NAME], "TOML Project")  # Overrides sonar-project.properties
 
-        # Environment variables override pyproject.toml [tool.sonar]
+        # JSON params from environment variable should override toml but be overridden by regular env vars
+        self.assertEqual(configuration[SONAR_EXCLUSIONS], "json-exclusions/**/*")  # JSON overrides toml
+
+        # Environment variables override pyproject.toml [tool.sonar] and JSON params
         self.assertEqual(configuration[SONAR_HOST_URL], "https://sonar.env.example.com")
         self.assertEqual(configuration[SONAR_SCANNER_JAVA_OPTS], "-Xmx2048m")
         self.assertEqual(configuration[SONAR_USER_HOME], "/env/sonar/home")  # Env var overrides [sonar] toml

tests/test_environment_variables.py

@@ -91,3 +91,39 @@ def test_mixed_environment_variables(self):
             }
             self.assertEqual(len(properties), 5)
             self.assertDictEqual(properties, expected_properties)
+
+    def test_environment_variables_from_json_params(self):
+        env = {
+            "SONAR_SCANNER_JSON_PARAMS": '{"sonar.token": "json-token", "sonar.host.url": "https://json.example.com"}'
+        }
+        with patch.dict("os.environ", env, clear=True):
+            properties = environment_variables.load()
+            expected_properties = {
+                SONAR_TOKEN: "json-token",
+                SONAR_HOST_URL: "https://json.example.com",
+            }
+            self.assertEqual(len(properties), 2)
+            self.assertDictEqual(properties, expected_properties)
+
+    def test_invalid_json_params(self):
+        env = {"SONAR_SCANNER_JSON_PARAMS": '{"sonar.token": "json-token"'}
+        with patch.dict("os.environ", env, clear=True):
+            properties = environment_variables.load()
+            self.assertEqual(len(properties), 0)
+            self.assertDictEqual(properties, {})
+
+    def test_environment_variables_priority_over_json_params(self):
+        env = {
+            "SONAR_TOKEN": "regular-token",  # This should take priority
+            "SONAR_HOST_URL": "https://regular.example.com",  # This should take priority
+            "SONAR_SCANNER_JSON_PARAMS": '{"sonar.token": "json-token", "sonar.host.url": "https://json.example.com", "sonar.region": "eu"}',
+        }
+        with patch.dict("os.environ", env, clear=True):
+            properties = environment_variables.load()
+            expected_properties = {
+                SONAR_TOKEN: "regular-token",  # Regular env var takes priority
+                SONAR_HOST_URL: "https://regular.example.com",  # Regular env var takes priority
+                SONAR_REGION: "eu",  # Only in JSON, so this value is used
+            }
+            self.assertEqual(len(properties), 3)
+            self.assertDictEqual(properties, expected_properties)