Avoid keeping business logic in __init__.py

Author: guillaume-dequenne

src/pysonar_scanner/__main__.py

@@ -18,10 +18,11 @@
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 
-from pysonar_scanner import app_logging, cache
-from pysonar_scanner import configuration
+from pysonar_scanner import app_logging
+from pysonar_scanner import cache
 from pysonar_scanner.api import get_base_urls, SonarQubeApi
-from pysonar_scanner.configuration import ConfigurationLoader
+from pysonar_scanner.configuration import configuration_loader
+from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader
 from pysonar_scanner.configuration.properties import SONAR_VERBOSE
 from pysonar_scanner.scannerengine import ScannerEngine
 
@@ -43,6 +44,6 @@ def set_logging_options(config):
 
 
 def __build_api(config: dict[str, any]) -> SonarQubeApi:
-    token = configuration.get_token(config)
+    token = configuration_loader.get_token(config)
     base_urls = get_base_urls(config)
     return SonarQubeApi(base_urls, token)

src/pysonar_scanner/configuration/__init__.py

@@ -17,42 +17,3 @@
 # 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, SONAR_PROJECT_BASE_DIR, Key
-from pysonar_scanner.configuration import properties, sonar_project_properties, toml_file
-
-from pysonar_scanner.exceptions import MissingKeyException
-
-
-def get_static_default_properties() -> dict[Key, any]:
-    return {prop.name: prop.default_value for prop in properties.PROPERTIES if prop.default_value is not None}
-
-
-class ConfigurationLoader:
-    @staticmethod
-    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
-        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))
-
-        toml_path_property = cli_properties.get("toml-path", ".")
-        toml_dir = Path(toml_path_property) if "toml-path" in cli_properties else base_dir
-        resolved_properties.update(toml_file.load(toml_dir))
-
-        resolved_properties.update(cli_properties)
-        return resolved_properties
-
-
-def get_token(config: dict[Key, any]) -> str:
-    if SONAR_TOKEN not in config:
-        raise MissingKeyException(f'Missing property "{SONAR_TOKEN}"')
-    return config[SONAR_TOKEN]

src/pysonar_scanner/configuration/configuration_loader.py

@@ -0,0 +1,58 @@
+#
+# 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 pysonar_scanner.configuration.cli import CliConfigurationLoader
+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, pyproject_toml
+
+from pysonar_scanner.exceptions import MissingKeyException
+
+
+def get_static_default_properties() -> dict[Key, any]:
+    return {prop.name: prop.default_value for prop in PROPERTIES if prop.default_value is not None}
+
+
+class ConfigurationLoader:
+    @staticmethod
+    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
+        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))
+
+        toml_path_property = cli_properties.get("toml-path", ".")
+        toml_dir = Path(toml_path_property) if "toml-path" in cli_properties else base_dir
+        resolved_properties.update(pyproject_toml.load(toml_dir))
+
+        resolved_properties.update(cli_properties)
+        return resolved_properties
+
+
+def get_token(config: dict[Key, any]) -> str:
+    if SONAR_TOKEN not in config:
+        raise MissingKeyException(f'Missing property "{SONAR_TOKEN}"')
+    return config[SONAR_TOKEN]

tests/test_configuration_cli.py

@@ -22,7 +22,7 @@
 from unittest.mock import patch
 from io import StringIO
 
-from pysonar_scanner.configuration import CliConfigurationLoader
+from pysonar_scanner.configuration.configuration_loader import CliConfigurationLoader
 from pysonar_scanner.configuration.properties import (
     SONAR_HOST_URL,
     SONAR_REGION,

tests/test_configuration.py renamed to tests/test_configuration_loader.py

@@ -22,7 +22,7 @@
 
 import pyfakefs.fake_filesystem_unittest as pyfakefs
 
-from pysonar_scanner import configuration
+from pysonar_scanner.configuration import configuration_loader
 from pysonar_scanner.configuration.properties import (
     SONAR_PROJECT_KEY,
     SONAR_PROJECT_NAME,
@@ -43,7 +43,7 @@
     SONAR_VERBOSE,
     TOML_PATH,
 )
-from pysonar_scanner.configuration import ConfigurationLoader, SONAR_PROJECT_BASE_DIR
+from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader, SONAR_PROJECT_BASE_DIR
 from pysonar_scanner.exceptions import MissingKeyException
 
 
@@ -72,18 +72,18 @@ def test_defaults(self):
         }
         self.assertDictEqual(configuration, expected_configuration)
 
-    @patch("pysonar_scanner.configuration.get_static_default_properties", return_value={})
+    @patch("pysonar_scanner.configuration.configuration_loader.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()
         self.assertDictEqual(config, {})
 
     def test_get_token(self):
         with self.subTest("Token is present"):
-            self.assertEqual(configuration.get_token({SONAR_TOKEN: "myToken"}), "myToken")
+            self.assertEqual(configuration_loader.get_token({SONAR_TOKEN: "myToken"}), "myToken")
 
         with self.subTest("Token is absent"), self.assertRaises(MissingKeyException):
-            configuration.get_token({})
+            configuration_loader.get_token({})
 
     @patch("sys.argv", ["myscript.py", "--token", "myToken", "--sonar-project-key", "myProjectKey"])
     def test_load_sonar_project_properties(self):

tests/test_main.py

@@ -17,14 +17,13 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
-from unittest import mock
 from unittest.mock import patch
 
 from pyfakefs import fake_filesystem_unittest as pyfakefs
 
-from pysonar_scanner.configuration import ConfigurationLoader
-from pysonar_scanner.configuration.properties import SONAR_PROJECT_KEY, SONAR_TOKEN
 from pysonar_scanner.__main__ import scan
+from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader
+from pysonar_scanner.configuration.properties import SONAR_PROJECT_KEY, SONAR_TOKEN
 from pysonar_scanner.scannerengine import ScannerEngine