SCANPY-135 Add log messages through the code

Author: thomas-serre-sonarsource

src/pysonar_scanner/__main__.py

@@ -48,19 +48,22 @@ def scan():
 
 def do_scan():
     app_logging.setup()
-
+    app_logging.get_logger().info("Starting Pysonar, the Sonar scanner CLI for Python")
     config = ConfigurationLoader.load()
     set_logging_options(config)
+    app_logging.get_logger().debug(f"Loaded configuration: {config}")
 
     ConfigurationLoader.check_configuration(config)
 
     api = build_api(config)
     check_version(api)
     update_config_with_api_urls(config, api.base_urls)
+    app_logging.get_logger().debug(f"Configuration after update from API URL: {config}")
 
     cache_manager = cache.get_cache(config)
     scanner = create_scanner_engine(api, cache_manager, config)
 
+    app_logging.get_logger().info("Starting the analysis...")
     return scanner.run(config)
 
 
@@ -75,9 +78,12 @@ def build_api(config: dict[str, any]) -> SonarQubeApi:
 
 
 def check_version(api: SonarQubeApi):
+    app_logging.get_logger().info("Checking SonarQube version...")
     if api.is_sonar_qube_cloud():
+        app_logging.get_logger().info("Analysis will be run on SonarQube Cloud")
         return
     version = api.get_analysis_version()
+    app_logging.get_logger().info("Analysis will be run on SonarQube version %s", version)
     if not version.does_support_bootstrapping():
         raise SQTooOldException(
             f"This scanner only supports SonarQube versions >= {MIN_SUPPORTED_SQ_VERSION}. \n"
@@ -95,8 +101,10 @@ def update_config_with_api_urls(config, base_urls: BaseUrls):
 
 
 def create_scanner_engine(api, cache_manager, config):
+    app_logging.get_logger().info("Creating the scanner engine...")
     jre_path = create_jre(api, cache_manager, config)
     config[SONAR_SCANNER_JAVA_EXE_PATH] = str(jre_path.path)
+    app_logging.get_logger().debug(f"JRE path: {jre_path.path}")
     scanner_engine_path = ScannerEngineProvisioner(api, cache_manager).provision()
     scanner = ScannerEngine(jre_path, scanner_engine_path)
     return scanner

src/pysonar_scanner/api.py

@@ -24,6 +24,7 @@
 import requests
 import requests.auth
 
+from pysonar_scanner import app_logging
 from pysonar_scanner.configuration.properties import (
     SONAR_HOST_URL,
     SONAR_SCANNER_SONARCLOUD_URL,
@@ -231,7 +232,7 @@ def download_analysis_engine(self, handle: typing.BinaryIO) -> None:
         This method can raise a SonarQubeApiException if the server doesn't respond successfully.
         Alternative, if the file IO fails, an IOError or OSError can be raised.
         """
-
+        app_logging.get_logger().info("Download the analysis engine...")
         try:
             res = requests.get(
                 f"{self.base_urls.api_base_url}/analysis/engine",

src/pysonar_scanner/app_logging.py

@@ -26,3 +26,7 @@ def setup() -> None:
 
 def configure_logging_level(verbose: bool) -> None:
     logging.getLogger().setLevel(logging.DEBUG if verbose else logging.INFO)
+
+
+def get_logger() -> logging.Logger:
+    return logging.getLogger()

src/pysonar_scanner/configuration/cli.py

@@ -19,6 +19,7 @@
 #
 import argparse
 
+from pysonar_scanner import app_logging
 from pysonar_scanner.configuration import properties
 from pysonar_scanner.exceptions import UnexpectedCliArgument
 

src/pysonar_scanner/configuration/configuration_loader.py

@@ -19,6 +19,7 @@
 #
 from pathlib import Path
 
+from pysonar_scanner import app_logging
 from pysonar_scanner.configuration.cli import CliConfigurationLoader
 from pysonar_scanner.configuration.pyproject_toml import TomlConfigurationLoader
 from pysonar_scanner.configuration.properties import SONAR_PROJECT_KEY, SONAR_TOKEN, SONAR_PROJECT_BASE_DIR, Key
@@ -35,6 +36,8 @@ def get_static_default_properties() -> dict[Key, any]:
 class ConfigurationLoader:
     @staticmethod
     def load() -> dict[Key, any]:
+        app_logging.get_logger().info("Loading configuration properties...")
+
         # 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

src/pysonar_scanner/configuration/environment_variables.py

@@ -21,6 +21,7 @@
 import json
 from typing import Dict
 
+from pysonar_scanner import app_logging
 from pysonar_scanner.configuration.properties import Key, PROPERTIES
 
 
@@ -48,10 +49,12 @@ def load_json_env_variables():
             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
+        except json.JSONDecodeError as e:
+            app_logging.get_logger().warning(
+                "The JSON in SONAR_SCANNER_JSON_PARAMS environment variable is invalid. The other environment variables will still be loaded.",
+                e,
+            )
+
     return properties
 
 

src/pysonar_scanner/configuration/pyproject_toml.py

@@ -20,6 +20,7 @@
 from pathlib import Path
 from typing import Dict
 import os
+from pysonar_scanner import app_logging
 import tomli
 
 from pysonar_scanner.configuration import properties
@@ -49,9 +50,11 @@ def load(base_dir: Path) -> TomlProperties:
             # Look for general project configuration
             project_properties = TomlConfigurationLoader.__read_project_properties(toml_dict)
             return TomlProperties(sonar_properties, project_properties)
-        except Exception:
-            # If there's any error parsing the TOML file, return empty TomlProperties
-            # SCANPY-135: We should log the pyproject.toml parsing error
+        except Exception as e:
+            app_logging.get_logger().warning(
+                "There was an error reading the pyproject.toml file. No properties from the TOML file were extracted.",
+                e,
+            )
             return TomlProperties({}, {})
 
     @staticmethod

src/pysonar_scanner/scannerengine.py

@@ -25,6 +25,7 @@
 from threading import Thread
 from typing import IO, Callable, Optional
 
+from pysonar_scanner import app_logging
 from pysonar_scanner.api import SonarQubeApi
 from pysonar_scanner.cache import Cache, CacheFile
 from pysonar_scanner.exceptions import ChecksumException
@@ -122,9 +123,11 @@ def provision(self) -> pathlib.Path:
             raise ChecksumException.create("scanner engine JAR")
 
     def __download_and_verify(self) -> Optional[CacheFile]:
+        app_logging.get_logger().info("Get the analysis engine info ...")
         engine_info = self.api.get_analysis_engine()
         cache_file = self.cache.get_file(engine_info.filename, engine_info.sha256)
         if not cache_file.is_valid():
+            app_logging.get_logger().info("Cached analysis engine is not valid.")
             self.__download_scanner_engine(cache_file)
         return cache_file if cache_file.is_valid() else None
 
@@ -140,7 +143,9 @@ def __init__(self, jre_path: JREResolvedPath, scanner_engine_path: pathlib.Path)
 
     def run(self, config: dict[str, any]):
         cmd = self.__build_command(self.jre_path, self.scanner_engine_path)
+        app_logging.get_logger().debug(f"Command: {cmd}")
         properties_str = self.__config_to_json(config)
+        app_logging.get_logger().debug(f"Properties: {properties_str}")
         return CmdExecutor(cmd, properties_str).execute()
 
     def __build_command(self, jre_path: JREResolvedPath, scanner_engine_path: pathlib.Path) -> list[str]:

tests/test_environment_variables.py

@@ -17,8 +17,9 @@
 # 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 patch
+from unittest.mock import MagicMock, patch
 
 from pysonar_scanner.configuration import environment_variables
 from pysonar_scanner.configuration.properties import (
@@ -105,13 +106,22 @@ def test_environment_variables_from_json_params(self):
             self.assertEqual(len(properties), 2)
             self.assertDictEqual(properties, expected_properties)
 
-    def test_invalid_json_params(self):
+    @patch("pysonar_scanner.configuration.environment_variables.app_logging.get_logger")
+    def test_invalid_json_params(self, mock_get_logger):
+        mock_logger = MagicMock()
+        mock_get_logger.return_value = mock_logger
+
         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, {})
 
+        mock_logger.warning.assert_called_once_with(
+            "The JSON in SONAR_SCANNER_JSON_PARAMS environment variable is invalid. The other environment variables will still be loaded.",
+            unittest.mock.ANY,
+        )
+
     def test_environment_variables_priority_over_json_params(self):
         env = {
             "SONAR_TOKEN": "regular-token",  # This should take priority

tests/unit/test_configuration_loader.py

@@ -18,7 +18,7 @@
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 import os
-from unittest.mock import patch
+from unittest.mock import MagicMock, patch
 
 import pyfakefs.fake_filesystem_unittest as pyfakefs