log error

Author: Seppli11

src/pysonar_scanner/__main__.py

@@ -20,6 +20,7 @@
 
 from pysonar_scanner import app_logging
 from pysonar_scanner import cache
+from pysonar_scanner import exceptions
 from pysonar_scanner.api import get_base_urls, SonarQubeApi, BaseUrls, MIN_SUPPORTED_SQ_VERSION
 from pysonar_scanner.configuration import configuration_loader
 from pysonar_scanner.configuration.configuration_loader import ConfigurationLoader
@@ -39,6 +40,13 @@
 
 
 def scan():
+    try:
+        return do_scan()
+    except Exception as e:
+        return exceptions.log_error(e)
+
+
+def do_scan():
     app_logging.setup()
 
     config = ConfigurationLoader.load()

src/pysonar_scanner/exceptions.py

@@ -22,6 +22,8 @@
 from dataclasses import dataclass
 import logging
 
+EXCEPTION_RETURN_CODE = 1
+
 
 @dataclass
 class MissingProperty:
@@ -66,3 +68,12 @@ class NoJreAvailableException(JreProvisioningException):
 
 class UnsupportedArchiveFormat(JreProvisioningException):
     pass
+
+
+def log_error(e: Exception):
+    logger = logging.getLogger()
+    is_debug_level = logger.getEffectiveLevel() <= logging.DEBUG
+
+    logger.error(str(e), exc_info=is_debug_level)
+
+    return EXCEPTION_RETURN_CODE

tests/its/test_minimal.py

@@ -48,4 +48,4 @@ def test_minimal_project_unexpected_arg(cli: CliClient):
 def test_invalid_token(sonarqube_client: SonarQubeClient, cli: CliClient):
     process = cli.run_analysis(sources_dir="minimal", token="invalid")
     assert process.returncode == 1, str(process.stdout)
-    assert "401 Client Error" in process.stdout
+    assert "Error while fetching the analysis version" in process.stdout

tests/unit/test_exceptions.py

@@ -0,0 +1,57 @@
+#
+# 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 pytest
+import unittest
+import logging
+from pysonar_scanner.exceptions import log_error, EXCEPTION_RETURN_CODE
+
+
+class TestExceptions(unittest.TestCase):
+    @pytest.fixture(autouse=True)
+    def set_caplog(self, caplog: pytest.LogCaptureFixture):
+        self.caplog = caplog
+
+    def test_log_error_returns_exception_return_code(self):
+        exception = Exception("Test exception")
+        result = log_error(exception)
+        self.assertEqual(result, EXCEPTION_RETURN_CODE)
+
+    def setUp(self) -> None:
+        self.caplog.clear()
+
+    def test_log_error_logs_message(self):
+        # Test that log_error logs the exception message
+        exception = Exception("Test exception")
+        with self.caplog.at_level(logging.ERROR):
+            log_error(exception)
+
+        self.assertIn("Test exception", self.caplog.text)
+        self.assertNotIn("Traceback", self.caplog.text)
+
+    def test_log_error_includes_stack_trace_in_debug_mode(self):
+        # raises an exception to get an Exception object with a strace trace
+        try:
+            raise Exception("Test exception")
+        except Exception as exception:
+            with self.caplog.at_level(logging.DEBUG):
+                log_error(exception)
+
+        self.assertIn("Test exception", self.caplog.text)
+        self.assertIn("Traceback", self.caplog.text)

tests/unit/test_main.py

@@ -84,6 +84,13 @@ def test_minimal_success_run(self, run_mock, create_jre_mock, provision_mock, lo
 
         self.assertEqual(expected_config, config)
 
+    @patch.object(ConfigurationLoader, "load")
+    def test_scan_with_exception(self, load_mock):
+        load_mock.side_effect = Exception("Test exception")
+
+        exitcode = scan()
+        self.assertEqual(1, exitcode)
+
     def test_version_check_outdated_sonarqube(self):
         sq_cloud_api = sq_api_utils.get_sq_server()
         sq_cloud_api.get_analysis_version = Mock(return_value=SQVersion.from_str("9.9.9"))