SCANPY-114 Parse the scanner properties from the environnement variables (#162)

guillaume-dequenne · web-flow · commit ca88ec588cd1 · 2025-03-25T15:31:38.000+01:00
diff --git a/src/pysonar_scanner/configuration/configuration_loader.py b/src/pysonar_scanner/configuration/configuration_loader.py
@@ -23,7 +23,7 @@
 from pysonar_scanner.configuration.pyproject_toml import TomlConfigurationLoader
 from pysonar_scanner.configuration.properties import SONAR_TOKEN, SONAR_PROJECT_BASE_DIR, Key
 from pysonar_scanner.configuration.properties import PROPERTIES
-from pysonar_scanner.configuration import sonar_project_properties
+from pysonar_scanner.configuration import sonar_project_properties, environment_variables
 
 from pysonar_scanner.exceptions import MissingKeyException
 
@@ -51,6 +51,7 @@ def load() -> dict[Key, any]:
         resolved_properties.update(toml_properties.project_properties)
         resolved_properties.update(sonar_project_properties.load(base_dir))
         resolved_properties.update(toml_properties.sonar_properties)
+        resolved_properties.update(environment_variables.load())
         resolved_properties.update(cli_properties)
         return resolved_properties
 
diff --git a/src/pysonar_scanner/configuration/environment_variables.py b/src/pysonar_scanner/configuration/environment_variables.py
@@ -0,0 +1,40 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2024 SonarSource SA.
+# mailto:info AT sonarsource DOT com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+# This program is distributed in the hope that it will be useful,
+#
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+import os
+from typing import Dict
+
+from pysonar_scanner.configuration.properties import Key, PROPERTIES
+
+
+def load() -> Dict[Key, str]:
+    """
+    Load configuration properties from environment variables.
+
+    Returns:
+        Dictionary of property keys and their values extracted from environment variables.
+    """
+    properties = {}
+    # Extract properties from environment variables using the env_variable_name() method
+    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
diff --git a/src/pysonar_scanner/configuration/properties.py b/src/pysonar_scanner/configuration/properties.py
@@ -88,6 +88,21 @@ def python_name(self) -> str:
             result.append(char.lower())
         return "".join(result)
 
+    def env_variable_name(self) -> str:
+        """Convert property name to environment variable name format.
+        Example: sonar.scanner.proxyPort -> SONAR_SCANNER_PROXY_PORT"""
+        # Replace dots with underscores
+        env_name = self.name.replace(".", "_")
+
+        # Insert underscores before uppercase letters (camelCase to snake_case)
+        result = []
+        for i, char in enumerate(env_name):
+            if char.isupper() and i > 0 and env_name[i - 1] != "_":
+                result.append("_")
+            result.append(char)
+        # Convert to uppercase
+        return "".join(result).upper()
+
 
 # fmt: off
 PROPERTIES: list[Property] = [
diff --git a/tests/test_configuration_loader.py b/tests/test_configuration_loader.py
@@ -44,6 +44,8 @@
     TOML_PATH,
     SONAR_PROJECT_DESCRIPTION,
     SONAR_PYTHON_VERSION,
+    SONAR_HOST_URL,
+    SONAR_SCANNER_JAVA_OPTS,
 )
 from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader, SONAR_PROJECT_BASE_DIR
 from pysonar_scanner.exceptions import MissingKeyException
@@ -53,6 +55,8 @@ class TestConfigurationLoader(pyfakefs.TestCase):
     def setUp(self):
         self.maxDiff = None
         self.setUpPyfakefs()
+        self.env_patcher = patch.dict("os.environ", {}, clear=True)
+        self.env_patcher.start()
 
     @patch("sys.argv", ["myscript.py", "--token", "myToken", "--sonar-project-key", "myProjectKey"])
     def test_defaults(self):
@@ -265,6 +269,19 @@ def test_load_pyproject_toml_from_toml_path(self):
         }
         self.assertDictEqual(configuration, expected_configuration)
 
+    @patch("sys.argv", ["myscript.py"])
+    @patch.dict("os.environ", {"SONAR_TOKEN": "TokenFromEnv", "SONAR_PROJECT_KEY": "KeyFromEnv"}, clear=True)
+    def test_load_from_env_variables_only(self):
+        """Test that configuration can be loaded exclusively from environment variables"""
+        configuration = ConfigurationLoader.load()
+
+        # Check that environment variables are loaded correctly
+        self.assertEqual(configuration[SONAR_TOKEN], "TokenFromEnv")
+        self.assertEqual(configuration[SONAR_PROJECT_KEY], "KeyFromEnv")
+
+        # Default values should still be populated
+        self.assertEqual(configuration[SONAR_SCANNER_APP], "python")
+
     @patch(
         "sys.argv",
         [
@@ -275,18 +292,38 @@ def test_load_pyproject_toml_from_toml_path(self):
             "ProjectKeyFromCLI",
         ],
     )
-    def test_properties_and_toml_priority(self):
-        """Test that sonar-project.properties has priority over pyproject.toml when both exist"""
+    @patch.dict(
+        "os.environ",
+        {
+            "SONAR_TOKEN": "TokenFromEnv",  # Should be overridden by CLI
+            "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
+        },
+        clear=True,
+    )
+    def test_properties_priority(self):
+        """Test the priority order of different configuration sources:
+        1. CLI args (highest)
+        2. Environment variables
+        3. Generic environment variable
+        4. pyproject.toml [tool.sonar] section
+        5. sonar-project.properties
+        6. Generic properties from pyproject.toml [project] section
+        7. Default values (lowest)
+        """
         # Create both configuration files
         self.fs.create_file(
             "sonar-project.properties",
             contents=(
                 """
                 sonar.projectKey=ProjectKeyFromProperties
                 sonar.projectName=Properties Project
+                sonar.projectDescription=Properties Project Description
                 sonar.sources=src/properties
                 sonar.tests=test/properties
                 sonar.exclusions=properties-exclusions/**/*
+                sonar.userHome=/properties/sonar/home
                 """
             ),
         )
@@ -303,23 +340,35 @@ def test_properties_and_toml_priority(self):
                 project-name = "TOML Project"
                 sources = "src/toml"
                 exclusions = "toml-exclusions/**/*"
+                userHome = "/toml/sonar/home"
                 """
             ),
         )
 
         configuration = ConfigurationLoader.load()
 
-        # Generic pyproject.toml properties are retrieved when no other source is available
-        self.assertEqual(configuration[SONAR_PROJECT_DESCRIPTION], "My Project Description")
+        # Test Default values (lowest priority)
+        self.assertNotEqual(configuration[SONAR_SCANNER_CONNECT_TIMEOUT], "5")  # Default value would be 5
+
+        # Generic pyproject.toml properties from [project] section
         self.assertEqual(configuration[SONAR_PYTHON_VERSION], "3.6,3.7,3.8")
 
-        # sonar-project.properties values have priority over generic properties from pyproject.toml
-        self.assertEqual(configuration[SONAR_PROJECT_NAME], "TOML Project")
+        # sonar-project.properties values
+        self.assertEqual(configuration[SONAR_TESTS], "test/properties")
+        self.assertEqual(
+            configuration[SONAR_PROJECT_DESCRIPTION], "Properties Project Description"
+        )  # Overrides [project] toml
 
-        # Sonar pyproject.toml values have priority over sonar-project.properties
+        # 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
 
-        # CLI args still have highest priority
+        # Environment variables override pyproject.toml [tool.sonar]
+        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
+
+        # CLI args have highest priority
         self.assertEqual(configuration[SONAR_PROJECT_KEY], "ProjectKeyFromCLI")
-        self.assertEqual(configuration[SONAR_TESTS], "test/properties")
+        self.assertEqual(configuration[SONAR_TOKEN], "myToken")  # CLI overrides env var
diff --git a/tests/test_environment_variables.py b/tests/test_environment_variables.py
@@ -0,0 +1,93 @@
+#
+# Sonar Scanner Python
+# Copyright (C) 2011-2024 SonarSource SA.
+# mailto:info AT sonarsource DOT com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+# This program is distributed in the hope that it will be useful,
+#
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+import unittest
+from unittest.mock import patch
+
+from pysonar_scanner.configuration import environment_variables
+from pysonar_scanner.configuration.properties import (
+    SONAR_HOST_URL,
+    SONAR_REGION,
+    SONAR_SCANNER_ARCH,
+    SONAR_SCANNER_JAVA_OPTS,
+    SONAR_SCANNER_OS,
+    SONAR_TOKEN,
+    SONAR_USER_HOME,
+    SONAR_PROJECT_KEY,
+)
+
+
+class TestEnvironmentVariables(unittest.TestCase):
+    def setUp(self):
+        self.maxDiff = None
+
+    def test_empty_environment(self):
+        with patch.dict("os.environ", {}, clear=True):
+            properties = environment_variables.load()
+            self.assertEqual(len(properties), 0)
+            self.assertDictEqual(properties, {})
+
+    def test__environment_variables(self):
+        env = {
+            "SONAR_TOKEN": "my-token",
+            "SONAR_HOST_URL": "https://sonarqube.example.com",
+            "SONAR_USER_HOME": "/custom/sonar/home",
+            "SONAR_SCANNER_JAVA_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_JAVA_OPTS: "-Xmx1024m -XX:MaxPermSize=256m",
+                SONAR_REGION: "us",
+            }
+            self.assertEqual(len(properties), 5)
+            self.assertDictEqual(properties, expected_properties)
+
+    def test_irrelevant_environment_variables(self):
+        env = {"UNRELATED_VAR": "some-value", "PATH": "/usr/bin:/bin", "HOME": "/home/user"}
+        with patch.dict("os.environ", env, clear=True):
+            properties = environment_variables.load()
+            self.assertEqual(len(properties), 0)
+            self.assertDictEqual(properties, {})
+
+    def test_mixed_environment_variables(self):
+        env = {
+            "SONAR_TOKEN": "my-token",
+            "SONAR_HOST_URL": "https://sonarqube.example.com",
+            "SONAR_PROJECT_KEY": "MyProjectKey",
+            "UNRELATED_VAR": "some-value",
+            "SONAR_SCANNER_OS": "linux",
+            "SONAR_SCANNER_ARCH": "x64",
+            "PATH": "/usr/bin:/bin",
+        }
+        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_PROJECT_KEY: "MyProjectKey",
+                SONAR_SCANNER_OS: "linux",
+                SONAR_SCANNER_ARCH: "x64",
+            }
+            self.assertEqual(len(properties), 5)
+            self.assertDictEqual(properties, expected_properties)
diff --git a/tests/test_properties.py b/tests/test_properties.py
