sonar-scanner-python/tests/unit/test_coveragerc_loader.py at 8d293e7dc03ea014e8d0e926f562ff92e332db7a · SonarSource/sonar-scanner-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
#
# Sonar Scanner Python
# Copyright (C) 2011-2026 SonarSource Sàrl
# 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.mock import patch

from pyfakefs.fake_filesystem_unittest import TestCase

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_exclusion_properties(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_exclusion_properties(Path("."))
        self.assertEqual(len(properties), 0)
        mock_logging.debug.assert_called_with("Coverage 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_exclusion_properties(Path("."))
        self.assertEqual(len(properties), 0)
        mock_logging.debug.assert_called_with("Coverage file .coveragerc has no exclusion properties")

    @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_exclusion_properties(Path("."))
        self.assertEqual(len(properties), 0)
        mock_logging.debug.assert_called_with("Coverage file .coveragerc has no exclusion properties")

    @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_exclusion_properties(Path("."))
        self.assertEqual(len(properties), 0)