add coverage

Author: maksim-grebeniuk-sonarsource

src/pysonar_scanner/configuration/coveragerc_loader.py

@@ -31,6 +31,8 @@ def load(base_dir: pathlib.Path) -> dict[str, str]:
         result_dict: dict[str, str] = {}
 
         coverage_properties = CoverageRCConfigurationLoader.__read_config(config_file_path)
+        if len(coverage_properties) == 0:
+            return result_dict
         exclusion_properties = CoverageRCConfigurationLoader.__read_coverage_exclusions_properties(
             config_file_path, coverage_properties
         )
@@ -55,10 +57,8 @@ def __read_config(config_file_path: pathlib.Path) -> dict[str, Any]:
                     section_values[key] = value
 
                 config_dict[section] = section_values
-        except configparser.Error as e:
-            logging.debug(f"Error decoding coverage file {config_file_path}: {e}")
         except Exception as e:
-            logging.debug(f"An unexpected error occurred while processing {config_file_path}: {e}")
+            logging.debug(f"Error decoding coverage file {config_file_path}: {e}")
         return config_dict
 
     @staticmethod
@@ -71,7 +71,7 @@ def __read_coverage_exclusions_properties(
             return result_dict
 
         if "omit" not in coverage_properties["run"]:
-            logging.debug(f"The run.omit was not found in {config_file_path}")
+            logging.debug(f"The run.omit key was not found in {config_file_path}")
             return result_dict
 
         omit_exclusions = coverage_properties["run"]["omit"]

tests/unit/test_coveragerc_loader.py

@@ -0,0 +1,87 @@
+#
+# 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 unittest import mock
+from unittest.mock import MagicMock, patch
+
+from pyfakefs.fake_filesystem_unittest import TestCase
+from pysonar_scanner.configuration.pyproject_toml import TomlConfigurationLoader
+from pysonar_scanner.configuration.coveragerc_loader import CoverageRCConfigurationLoader
+
+class TestCoverageRcFile(TestCase):
+    def setUp(self):
+        self.setUpPyfakefs()
+
+    def test_load_coverage_file(self):
+        self.fs.create_file(
+            ".coveragerc",
+            contents="""
+            [run]
+            omit =
+                */.local/*
+                /usr/*
+                utils/tirefire.py
+            """,
+        )
+        properties = CoverageRCConfigurationLoader.load(Path("."))
+
+        self.assertEqual(properties["sonar.coverage.exclusions"], "*/.local/*, /usr/*, utils/tirefire.py")
+
+    @patch("pysonar_scanner.configuration.coveragerc_loader.logging")
+    def test_load_missing_file(self, mock_logging):
+        properties = CoverageRCConfigurationLoader.load(Path("."))
+        self.assertEqual(len(properties), 0)
+        mock_logging.debug.assert_called_with("Configuration file not found: .coveragerc")
+
+    @patch("pysonar_scanner.configuration.coveragerc_loader.logging")
+    def test_load_without_run_section(self, mock_logging):
+        self.fs.create_file(
+            ".coveragerc",
+            contents="""
+                    [something_else]
+                    """,
+        )
+        properties = CoverageRCConfigurationLoader.load(Path("."))
+        self.assertEqual(len(properties), 0)
+        mock_logging.debug.assert_called_with("The run key was not found in .coveragerc")
+
+    @patch("pysonar_scanner.configuration.coveragerc_loader.logging")
+    def test_load_without_exclusions_property(self, mock_logging):
+        self.fs.create_file(
+            ".coveragerc",
+            contents="""
+                    [run]
+                    """,
+        )
+        properties = CoverageRCConfigurationLoader.load(Path("."))
+        self.assertEqual(len(properties), 0)
+        mock_logging.debug.assert_called_with("The run.omit key was not found in .coveragerc")
+
+    @patch("pysonar_scanner.configuration.coveragerc_loader.logging")
+    def test_load_malformed_file(self, mock_logging):
+        self.fs.create_file(
+            ".coveragerc",
+            contents="""
+                    [run
+                    omit = 
+                    """,
+        )
+        properties = CoverageRCConfigurationLoader.load(Path("."))
+        self.assertEqual(len(properties), 0)