diff-cover 9.4.0__tar.gz → 9.5.0__tar.gz

{diff_cover-9.4.0 → diff_cover-9.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: diff_cover
-Version: 9.4.0
+Version: 9.5.0
 Summary: Run coverage and linting reports on diffs
 License: Apache-2.0
 Author: See Contributors
@@ -161,7 +161,7 @@ You can use diff-cover to see quality reports on the diff as well by running
     diff-quality --violations=<tool>
 
 Where ``tool`` is the quality checker to use. Currently ``pycodestyle``, ``pyflakes``,
-``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml``, ``ruff check`` are supported, but more
+``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml``, ``ruff check``, ``clang`` are supported, but more
 checkers can (and should!) be supported. See the section "Adding `diff-quality``
 Support for a New Quality Checker".
 

{diff_cover-9.4.0 → diff_cover-9.5.0}/README.rst

@@ -129,7 +129,7 @@ You can use diff-cover to see quality reports on the diff as well by running
     diff-quality --violations=<tool>
 
 Where ``tool`` is the quality checker to use. Currently ``pycodestyle``, ``pyflakes``,
-``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml``, ``ruff check`` are supported, but more
+``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml``, ``ruff check``, ``clang`` are supported, but more
 checkers can (and should!) be supported. See the section "Adding `diff-quality``
 Support for a New Quality Checker".
 

{diff_cover-9.4.0 → diff_cover-9.5.0}/diff_cover/diff_quality_tool.py

@@ -50,6 +50,7 @@ from diff_cover.violationsreporters.java_violations_reporter import (
     checkstyle_driver,
 )
 from diff_cover.violationsreporters.violations_reporter import (
+    ClangFormatDriver,
     CppcheckDriver,
     EslintDriver,
     PylintDriver,
@@ -63,6 +64,7 @@ from diff_cover.violationsreporters.violations_reporter import (
 )
 
 QUALITY_DRIVERS = {
+    "clang": ClangFormatDriver(),
     "cppcheck": CppcheckDriver(),
     "pycodestyle": pycodestyle_driver,
     "pyflakes": pyflakes_driver,

{diff_cover-9.4.0 → diff_cover-9.5.0}/diff_cover/violationsreporters/violations_reporter.py

@@ -308,8 +308,7 @@ class LcovCoverageReporter(BaseViolationReporter):
     def parse(lcov_file):
         """
         Parse a single LCov coverage report
-        File format: https://linux.die.net/man/1/geninfo
-        More info: https://github.com/linux-test-project/lcov/issues/113#issuecomment-762335134
+        File format: https://github.com/linux-test-project/lcov/blob/master/man/geninfo.1
         """
         branch_coverage = defaultdict(
             lambda: defaultdict(lambda: {"total": 0, "hit": 0, "executions": 0})
@@ -361,14 +360,18 @@ class LcovCoverageReporter(BaseViolationReporter):
                     branch_coverage[source_file][line_no]["hit"] += 1
             elif directive == "FN":
                 args = content.split(",")
-                if len(args) != 2:
+                # FN:<line number of function start>,[<line number of function end>,]<function name>
+                if len(args) != 2 and len(args) != 3:
                     raise ValueError(f"Unknown syntax in lcov report: {line}")
                 if source_file is None:
                     raise ValueError(
                         f"No source file specified for line coverage: {line}"
                     )
                 line_no = int(args[0])
-                func_name = args[1]
+                if len(args) == 3:
+                    func_name = args[2]
+                else:
+                    func_name = args[1]
                 function_lines[source_file][func_name] = (line_no, 0)
             elif directive == "FNDA":
                 args = content.split(",")
@@ -828,3 +831,67 @@ class CppcheckDriver(QualityDriver):
         Returns: boolean True if installed
         """
         return run_command_for_code(self.command_to_check_install) == 0
+
+
+class ClangFormatDriver(QualityDriver):
+    """
+    Driver for clang-format
+    """
+
+    def __init__(self):
+        """
+        args:
+            expression: regex used to parse report
+        See super for other args
+        """
+        super().__init__(
+            "clang",
+            ["c", "cpp", "h", "hpp"],
+            ["clang-format", "--dry-run"],  # Use dry-run option to not modify files
+            output_stderr=True,
+        )
+
+        # Errors look like:
+        # src/foo.c:8:1: warning: code should be clang-formatted [-Wclang-format-violations]
+        # int foo;
+        #   ^
+        # Match for everything, including ":" in the file name (first capturing
+        # group), in case there are pathological path names with ":"
+        self.clang_expression = re.compile(
+            r"^(.*?):(\d+):\d+: ([^[]* \[[^]]*\])\n(.+)\n(.+)$",
+            re.MULTILINE,
+        )
+        self.command_to_check_install = ["clang-format", "--version"]
+
+    def parse_reports(self, reports):
+        """
+        Args:
+            reports: list[str] - output from the report
+        Return:
+            A dict[Str:Violation]
+            Violation is a simple named tuple Defined above
+        """
+        violations_dict = defaultdict(list)
+        for report in reports:
+
+            matches = list(re.finditer(self.clang_expression, report))
+            for match in matches:
+                if match is not None:
+                    (
+                        clang_src_path,
+                        line_number,
+                        message,
+                        code_extract,
+                        cursor_error,
+                    ) = match.groups()
+                    full_message = f"{message}\n{code_extract}\n{cursor_error}"
+                    violation = Violation(int(line_number), full_message)
+                    violations_dict[clang_src_path].append(violation)
+        return violations_dict
+
+    def installed(self):
+        """
+        Method checks if the provided tool is installed.
+        Returns: boolean True if installed
+        """
+        return run_command_for_code(self.command_to_check_install) == 0

{diff_cover-9.4.0 → diff_cover-9.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "diff_cover"
-version = "9.4.0"
+version = "9.5.0"
 description = "Run coverage and linting reports on diffs"
 authors = ["See Contributors"]
 homepage = "https://github.com/Bachmann1234/diff-cover"

diff_cover-9.5.0/tests/fixtures/real_python_coverage.lcov

@@ -0,0 +1,75 @@
+SF:calculator.py
+DA:1,1
+DA:3,1
+DA:4,1
+DA:6,1
+DA:8,1
+DA:10,1
+DA:11,1
+DA:12,1
+DA:14,1
+DA:16,1
+DA:17,1
+DA:18,1
+DA:20,1
+DA:22,1
+DA:23,1
+DA:25,1
+DA:26,1
+DA:27,1
+DA:28,1
+DA:29,1
+DA:30,1
+DA:32,1
+LF:22
+LH:22
+FN:4,6,Calculator.add
+FNDA:1,Calculator.add
+FN:8,12,Calculator.divide
+FNDA:1,Calculator.divide
+FN:14,18,Calculator.process_numbers
+FNDA:1,Calculator.process_numbers
+FN:20,32,Calculator.get_grade
+FNDA:1,Calculator.get_grade
+FNF:4
+FNH:4
+end_of_record
+SF:test_calculator.py
+DA:1,1
+DA:2,1
+DA:4,1
+DA:5,1
+DA:6,1
+DA:8,1
+DA:10,1
+DA:12,1
+DA:14,1
+DA:15,1
+DA:16,1
+DA:18,1
+DA:21,1
+DA:24,1
+DA:26,1
+DA:28,1
+DA:29,1
+DA:30,1
+DA:31,1
+DA:33,1
+DA:34,1
+DA:35,1
+DA:36,1
+LF:23
+LH:23
+FN:5,6,calculator
+FNDA:1,calculator
+FN:8,10,test_add
+FNDA:1,test_add
+FN:12,16,test_divide
+FNDA:1,test_divide
+FN:18,24,test_process_numbers
+FNDA:1,test_process_numbers
+FN:26,36,test_get_grade
+FNDA:1,test_get_grade
+FNF:5
+FNH:5
+end_of_record

{diff_cover-9.4.0 → diff_cover-9.5.0}/tests/test_violations_reporter.py

@@ -17,6 +17,7 @@ from diff_cover.command_runner import CommandError, run_command_for_code
 from diff_cover.violationsreporters import base
 from diff_cover.violationsreporters.base import QualityReporter
 from diff_cover.violationsreporters.violations_reporter import (
+    ClangFormatDriver,
     CppcheckDriver,
     EslintDriver,
     LcovCoverageReporter,
@@ -999,8 +1000,8 @@ class TestLcovCoverageReporterTest:
         # line 50: function not hit (should NOT be covered)
         function_data = {
             "file1.cpp": {
-                "func_hit": (40, 3),
-                "func_not_hit": (50, 0),
+                "func_hit": (40, 40, 3),
+                "func_not_hit": (50, 50, 0),
             }
         }
 
@@ -1012,6 +1013,15 @@ class TestLcovCoverageReporterTest:
             function_data=function_data,
         )
 
+        lcov_report_obsolete_format = self._coverage_lcov(
+            file_paths,
+            violations,
+            measured,
+            branch_data=branch_data,
+            function_data=function_data,
+            use_obsolete_format=True,
+        )
+
         assert lcov_report == {
             "file1.cpp": {
                 10: 1,  # covered (no branch/function)
@@ -1027,6 +1037,7 @@ class TestLcovCoverageReporterTest:
                 60: 0,  # DA=0 and branch executions=0 (no override)
             }
         }
+        assert lcov_report_obsolete_format == lcov_report
 
     def _coverage_lcov(
         self,
@@ -1035,12 +1046,13 @@ class TestLcovCoverageReporterTest:
         measured,
         branch_data=None,
         function_data=None,
+        use_obsolete_format=False,
     ):
         """
         Build an LCOV document based on the provided arguments.
         Optionally include branch and function coverage data.
         - branch_data: dict {file: {line: [(block, branch, taken), ...]}}
-        - function_data: dict {file: {func_name: (line, hit_count)}}
+        - function_data: dict {file: {func_name: (line, end_line, hit_count)}}
         """
         violation_lines = {violation.line for violation in violations}
         branch_data = branch_data or {}
@@ -1050,9 +1062,14 @@ class TestLcovCoverageReporterTest:
             for path in file_paths:
                 f.write(f"SF:{path}\n")
                 # Write function data
-                for func_name, (line, _) in function_data.get(path, {}).items():
-                    f.write(f"FN:{line},{func_name}\n")
-                for func_name, (_, hit_count) in function_data.get(path, {}).items():
+                for func_name, (line, end_line, _) in function_data.get(
+                    path, {}
+                ).items():
+                    if use_obsolete_format:
+                        f.write(f"FN:{line},{end_line},{func_name}\n")
+                    else:
+                        f.write(f"FN:{line},{func_name}\n")
+                for func_name, (_, _, hit_count) in function_data.get(path, {}).items():
                     f.write(f"FNDA:{hit_count},{func_name}\n")
                 # Write line data
                 for line in measured:
@@ -2222,3 +2239,23 @@ class TestRuffCheckQualityDriverTest:
 
         assert quality.name() == "ruff.check"
         assert actual_violations == expected_violations
+
+
+class TestClangFormatcheckQualityDriverTest:
+    """Tests for clang-format quality driver."""
+
+    def test_parse_report(self):
+        """Basic report test parse"""
+        expected_violations = {
+            "src/foo.c": [
+                Violation(
+                    12,
+                    "warning: code should be clang-formatted [-Wclang-format-violations]\n        int  bar;\n           ^",
+                ),
+            ]
+        }
+        report = "src/foo.c:12:1: warning: code should be clang-formatted [-Wclang-format-violations]\n        int  bar;\n           ^"
+
+        driver = ClangFormatDriver()
+        actual_violations = driver.parse_reports([report])
+        assert actual_violations == expected_violations

diff_cover-9.4.0/tests/fixtures/real_python_coverage.lcov

@@ -1,55 +0,0 @@
-TN:
-SF:calculator.py
-DA:1,1,IHjYfPUnPG8XenhaH5YO/A
-DA:3,1,R5ld61rEtMw8k5QnLG/J2Q
-DA:4,1,824CHOF+HuLf/TU8YUFs3A
-DA:6,1,7sXP/iICKUB6zWn67Juhgw
-DA:8,1,VsQ+B+HRaHmq81Fqbx2QvA
-DA:10,1,BhU+8GTrCvRmgSqWExCDtw
-DA:11,1,iaVNZHjse2AAQEIo1DuElQ
-DA:12,1,DrJU7aquMDtN+H52evA2kQ
-DA:14,1,vz2ZrwkD72YsQlDFhatNTw
-DA:16,1,ej3lkHPyE9SPnHBQWhY2QA
-DA:17,1,dfjHCoNB/lnYATH1PKxTig
-DA:18,1,QDzepsBi0Nd5VGR1pIoG7g
-DA:20,1,dSPjq3qexO3trH1KNMOIrQ
-DA:22,1,KYYfniyp2UPWWb+toC9jEg
-DA:23,1,ysgtnA7MU8LBfvqFnGW6vg
-DA:25,1,VoeqHedB53YTCJlr69LfAA
-DA:26,1,GbubG/XPO1WUDJqws3/Mhw
-DA:27,1,zbu7HynDC8IUMxz1TO8jAQ
-DA:28,1,6u/GbyzwJH3M/dAabCl9xQ
-DA:29,1,G75rLj1DYjeHhEjySNy/jQ
-DA:30,1,8Lrh8yJ/HPW1l96Gijc30g
-DA:32,1,l51yLGGGnM963UYCPo5N+A
-LF:22
-LH:22
-end_of_record
-TN:
-SF:test_calculator.py
-DA:1,1,6EqVyswJtxIE+9LVqyxOlA
-DA:2,1,O+96DUKqth1yjtUSIiMjXg
-DA:4,1,94X4nhA7Pe/OFJ+DxO73Mg
-DA:5,1,AKQyaclVFU9MNkdGMkzs1g
-DA:6,1,QK9KC7UVGwqStuMy+v3pYg
-DA:8,1,bTRe83kvssxoIveAKlMtfw
-DA:10,1,Vp4R4VgS/waq+RKmbztn/w
-DA:12,1,CFpmjrG5+jyhBoDLp/j5SQ
-DA:14,1,fWVWF2PjNTR1w2tnzAHuPA
-DA:15,1,lBb4Sb8TwZ/RIs6NdopHxA
-DA:16,1,L6hOpXMze2kVzf4at7QkPA
-DA:18,1,IzGG+ih8CeOLfQ7c+2tpCw
-DA:21,1,Fa2YbvHqjM0BMTarkRYeZQ
-DA:24,1,RKMlQwK1jpAcAaOjSB1sxQ
-DA:26,1,hwE0rNvci2CH1ZL7MP5D8A
-DA:28,1,xljWfj7mIHapHiNDY9x5vw
-DA:29,1,3Hd39iqUHWrP0w5fTsT+BA
-DA:30,1,CKdSOYRMADcYxuWGZZR5tA
-DA:31,1,Yt+uqA6V839ujVOYeX4Zfg
-DA:33,1,L4rVXtVP7DKlM4zvi6GP9w
-DA:34,1,1rUMQgfQLoAH5Bwk7IVFnA
-DA:35,1,L4rVXtVP7DKlM4zvi6GP9w
-DA:36,1,XF0EF2+Yi+Rg8tvFiw13qg
-LF:23
-LH:23
-end_of_record