SCANPY-146 Parse properties from sonar-project.properties file (#155)

Author: guillaume-dequenne

its/tests/test_dummy.py

@@ -19,6 +19,7 @@
 #
 import unittest
 
+
 class DummyTest(unittest.TestCase):
     def test_dummy(self):
         self.assertTrue(True)

pyproject.toml

@@ -33,6 +33,7 @@ toml = '>=0.10.2'
 requests = "^2.32.3"
 responses = "^0.25.6"
 pyfakefs = "^5.7.4"
+jproperties = "^2.1.2"
 
 [tool.poetry.group]
 [tool.poetry.group.dev]

scripts/generate_licenseheaders.sh

@@ -1,4 +1,4 @@
-#!/bin/env bash
+#!/bin/bash
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 pushd "$SCRIPT_DIR/.."
 

src/pysonar_scanner/configuration/__init__.py

@@ -17,10 +17,12 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
+from pathlib import Path
 
 from pysonar_scanner.configuration import properties
 from pysonar_scanner.configuration.cli import CliConfigurationLoader
-from pysonar_scanner.configuration.properties import SONAR_TOKEN, Key
+from pysonar_scanner.configuration.properties import SONAR_TOKEN, SONAR_PROJECT_BASE_DIR, Key
+from pysonar_scanner.configuration import properties, sonar_project_properties
 
 from pysonar_scanner.exceptions import MissingKeyException
 
@@ -35,11 +37,14 @@ def load() -> dict[Key, any]:
         # each property loader is required to return NO default values.
         # E.g. if no property has been set, an empty dict must be returned.
         # Default values should be set through the get_static_default_properties() method
-
-        return {
-            **get_static_default_properties(),
-            **CliConfigurationLoader.load(),
-        }
+        resolved_properties = get_static_default_properties()
+        cli_properties = CliConfigurationLoader.load()
+        # CLI properties have a higher priority than properties file,
+        # but we need to resolve them first to load the properties file
+        base_dir = Path(cli_properties.get(SONAR_PROJECT_BASE_DIR, "."))
+        resolved_properties.update(sonar_project_properties.load(base_dir))
+        resolved_properties.update(cli_properties)
+        return resolved_properties
 
 
 def get_token(config: dict[Key, any]) -> str:

src/pysonar_scanner/configuration/properties.py

@@ -56,6 +56,10 @@
 SONAR_PROJECT_BASE_DIR: Key = "sonar.projectBaseDir"
 SONAR_SCANNER_JAVA_OPTS: Key = "sonar.scanner.javaOpts"
 SONAR_PROJECT_KEY: Key = "sonar.projectKey"
+SONAR_PROJECT_NAME: Key = "sonar.projectName"
+SONAR_SOURCES: Key = "sonar.sources"
+SONAR_EXCLUSIONS: Key = "sonar.exclusions"
+SONAR_TESTS: Key = "sonar.tests"
 
 
 @dataclass

src/pysonar_scanner/configuration/sonar_project_properties.py

@@ -0,0 +1,35 @@
+#
+# 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.
+#
+from pathlib import Path
+from typing import Dict
+import os
+from jproperties import Properties
+
+
+def load(base_dir: Path) -> Dict[str, str]:
+    filepath = base_dir / "sonar-project.properties"
+    if not os.path.isfile(filepath):
+        return {}
+
+    props = Properties()
+    with open(filepath, "rb") as f:
+        props.load(f)
+
+    return {key: value.data for key, value in props.items() if value.data is not None}

tests/test_configuration.py

@@ -17,14 +17,15 @@
 # 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 ConfigurationLoader
+import pyfakefs.fake_filesystem_unittest as pyfakefs
+
 from pysonar_scanner import configuration
 from pysonar_scanner.configuration.properties import (
     SONAR_PROJECT_KEY,
+    SONAR_PROJECT_NAME,
     SONAR_SCANNER_APP,
     SONAR_SCANNER_APP_VERSION,
     SONAR_SCANNER_BOOTSTRAP_START_TIME,
@@ -34,16 +35,21 @@
     SONAR_SCANNER_SKIP_JRE_PROVISIONING,
     SONAR_SCANNER_SOCKET_TIMEOUT,
     SONAR_SCANNER_TRUSTSTORE_PASSWORD,
+    SONAR_EXCLUSIONS,
+    SONAR_SOURCES,
+    SONAR_TESTS,
     SONAR_TOKEN,
     SONAR_USER_HOME,
     SONAR_VERBOSE,
 )
+from pysonar_scanner.configuration import ConfigurationLoader, SONAR_PROJECT_BASE_DIR
 from pysonar_scanner.exceptions import MissingKeyException
 
 
-class TestConfigurationLoader(unittest.TestCase):
+class TestConfigurationLoader(pyfakefs.TestCase):
     def setUp(self):
         self.maxDiff = None
+        self.setUpPyfakefs()
 
     @patch("sys.argv", ["myscript.py", "--token", "myToken", "--sonar-project-key", "myProjectKey"])
     def test_defaults(self):
@@ -65,7 +71,7 @@ def test_defaults(self):
         }
         self.assertDictEqual(configuration, expected_configuration)
 
-    @patch("pysonar_scanner.configuration.get_static_default_properties", result={})
+    @patch("pysonar_scanner.configuration.get_static_default_properties", return_value={})
     @patch("sys.argv", ["myscript.py"])
     def test_no_defaults_in_configuration_loaders(self, get_static_default_properties_mock):
         config = ConfigurationLoader.load()
@@ -77,3 +83,85 @@ def test_get_token(self):
 
         with self.subTest("Token is absent"), self.assertRaises(MissingKeyException):
             configuration.get_token({})
+
+    @patch("sys.argv", ["myscript.py", "--token", "myToken", "--sonar-project-key", "myProjectKey"])
+    def test_load_sonar_project_properties(self):
+
+        self.fs.create_file(
+            "sonar-project.properties",
+            contents=(
+                """
+                sonar.projectKey=overwritten-project-key
+                sonar.projectName=My Project\n
+                sonar.sources=src # my sources\n
+                sonar.exclusions=**/generated/**/*,**/deprecated/**/*,**/testdata/**/*\n
+                """
+            ),
+        )
+        configuration = ConfigurationLoader.load()
+        expected_configuration = {
+            SONAR_TOKEN: "myToken",
+            SONAR_PROJECT_KEY: "myProjectKey",
+            SONAR_PROJECT_NAME: "My Project",
+            SONAR_SOURCES: "src # my sources",
+            SONAR_EXCLUSIONS: "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*",
+            SONAR_SCANNER_APP: "python",
+            SONAR_SCANNER_APP_VERSION: "1.0",
+            SONAR_SCANNER_BOOTSTRAP_START_TIME: configuration[SONAR_SCANNER_BOOTSTRAP_START_TIME],
+            SONAR_VERBOSE: False,
+            SONAR_SCANNER_SKIP_JRE_PROVISIONING: False,
+            SONAR_USER_HOME: "~/.sonar",
+            SONAR_SCANNER_CONNECT_TIMEOUT: 5,
+            SONAR_SCANNER_SOCKET_TIMEOUT: 60,
+            SONAR_SCANNER_RESPONSE_TIMEOUT: 0,
+            SONAR_SCANNER_KEYSTORE_PASSWORD: "changeit",
+            SONAR_SCANNER_TRUSTSTORE_PASSWORD: "changeit",
+        }
+        self.assertDictEqual(configuration, expected_configuration)
+
+    @patch(
+        "sys.argv",
+        [
+            "myscript.py",
+            "--token",
+            "myToken",
+            "--sonar-project-key",
+            "myProjectKey",
+            "--sonar-project-base-dir",
+            "custom/path",
+        ],
+    )
+    def test_load_sonar_project_properties_from_custom_path(self):
+        self.fs.create_dir("custom/path")
+        self.fs.create_file(
+            "custom/path/sonar-project.properties",
+            contents=(
+                """
+                sonar.projectKey=custom-path-project-key
+                sonar.projectName=Custom Path Project
+                sonar.sources=src/main
+                sonar.tests=src/test
+                """
+            ),
+        )
+        configuration = ConfigurationLoader.load()
+        expected_configuration = {
+            SONAR_TOKEN: "myToken",
+            SONAR_PROJECT_KEY: "myProjectKey",
+            SONAR_PROJECT_NAME: "Custom Path Project",
+            SONAR_SOURCES: "src/main",
+            SONAR_PROJECT_BASE_DIR: "custom/path",
+            SONAR_TESTS: "src/test",
+            SONAR_SCANNER_APP: "python",
+            SONAR_SCANNER_APP_VERSION: "1.0",
+            SONAR_SCANNER_BOOTSTRAP_START_TIME: configuration[SONAR_SCANNER_BOOTSTRAP_START_TIME],
+            SONAR_VERBOSE: False,
+            SONAR_SCANNER_SKIP_JRE_PROVISIONING: False,
+            SONAR_USER_HOME: "~/.sonar",
+            SONAR_SCANNER_CONNECT_TIMEOUT: 5,
+            SONAR_SCANNER_SOCKET_TIMEOUT: 60,
+            SONAR_SCANNER_RESPONSE_TIMEOUT: 0,
+            SONAR_SCANNER_KEYSTORE_PASSWORD: "changeit",
+            SONAR_SCANNER_TRUSTSTORE_PASSWORD: "changeit",
+        }
+        self.assertDictEqual(configuration, expected_configuration)

tests/test_sonar_project_properties.py

@@ -0,0 +1,85 @@
+#
+# 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.
+#
+from pathlib import Path
+
+import pyfakefs.fake_filesystem_unittest as pyfakefs
+from pysonar_scanner.configuration import sonar_project_properties
+
+
+class TestPropertiesFile(pyfakefs.TestCase):
+    def setUp(self):
+        self.setUpPyfakefs()
+
+    def test_load_sonar_project_properties(self):
+        self.fs.create_file(
+            "sonar-project.properties",
+            contents=(
+                "sonar.projectKey=my-project\n"
+                "sonar.projectName=My Project\n"
+                "sonar.sources=src # my sources\n"
+                "sonar.sources=src\n"
+                "sonar.exclusions=**/generated/**/*,**/deprecated/**/*,**/testdata/**/*\n"
+            ),
+        )
+        properties = sonar_project_properties.load(Path("."))
+
+        self.assertEqual(properties.get("sonar.projectKey"), "my-project")
+        self.assertEqual(properties.get("sonar.projectName"), "My Project")
+        self.assertEqual(properties.get("sonar.sources"), "src")
+        self.assertEqual(properties.get("sonar.exclusions"), "**/generated/**/*,**/deprecated/**/*,**/testdata/**/*")
+
+    def test_load_sonar_project_properties_custom_path(self):
+        self.fs.create_file(
+            "custom/path/sonar-project.properties",
+            contents=("sonar.projectKey=my-project\n" "sonar.projectName=My Project\n"),
+        )
+        properties = sonar_project_properties.load(Path("custom/path"))
+
+        self.assertEqual(properties.get("sonar.projectKey"), "my-project")
+        self.assertEqual(properties.get("sonar.projectName"), "My Project")
+
+    def test_load_missing_file(self):
+        properties = sonar_project_properties.load(Path("."))
+        self.assertEqual(len(properties), 0)
+
+    def test_load_empty_file(self):
+        self.fs.create_file("sonar-project.properties", contents="")
+        properties = sonar_project_properties.load(Path("."))
+
+        self.assertEqual(len(properties), 0)
+
+    def test_load_with_malformed_lines_jproperties(self):
+        self.fs.create_file(
+            "sonar-project.properties",
+            contents=(
+                "valid.key=valid value\n"
+                "malformed line without equals\n"
+                "another.valid.key=another valid value\n"
+                "=value without key\n"
+            ),
+        )
+
+        properties = sonar_project_properties.load(Path("."))
+
+        self.assertEqual(properties.get("valid.key"), "valid value")
+        self.assertEqual(properties.get("another.valid.key"), "another valid value")
+        self.assertEqual(properties.get("malformed"), "line without equals")
+        self.assertEqual(properties.get(""), "value without key")
+        self.assertEqual(len(properties), 4)