diff-cover 8.0.3__tar.gz → 9.1.0__tar.gz

{diff_cover-8.0.3 → diff_cover-9.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diff_cover
-Version: 8.0.3
+Version: 9.1.0
 Summary: Run coverage and linting reports on diffs
 Home-page: https://github.com/Bachmann1234/diff-cover
 License: Apache-2.0
@@ -223,6 +223,33 @@ By default, ``diff-cover`` compares the current branch to ``origin/main``.  To s
 
     diff-cover coverage.xml --compare-branch=origin/release
 
+Diff File
+--------------
+
+You may provide a file containing the output of ``git diff`` to ``diff-cover`` instead of using a branch name.
+
+For example, Say you have 2 branches ``main`` and ``feature``. Lets say after creating and checking out the feature branch,
+you make commits ``A``, ``B``, and ``C`` in that order.
+
+
+If you want to see all changes between the ``feature`` and ``main`` branch, you can generate a diff file like this:
+
+.. code:: bash
+
+    git diff main..feature > diff.txt
+
+If you want to see the changes between the ``feature`` branch and the commit ``A``, you can generate a diff file using the following command:
+
+.. code:: bash
+
+    git diff A..feature > diff.txt
+
+You can then run ``diff-cover`` with the diff file as an argument:
+
+.. code:: bash
+
+    diff-cover coverage.xml --diff-file=diff.txt
+
 Fail Under
 ----------
 

{diff_cover-8.0.3 → diff_cover-9.1.0}/README.rst

@@ -190,6 +190,33 @@ By default, ``diff-cover`` compares the current branch to ``origin/main``.  To s
 
     diff-cover coverage.xml --compare-branch=origin/release
 
+Diff File
+--------------
+
+You may provide a file containing the output of ``git diff`` to ``diff-cover`` instead of using a branch name.
+
+For example, Say you have 2 branches ``main`` and ``feature``. Lets say after creating and checking out the feature branch,
+you make commits ``A``, ``B``, and ``C`` in that order.
+
+
+If you want to see all changes between the ``feature`` and ``main`` branch, you can generate a diff file like this:
+
+.. code:: bash
+
+    git diff main..feature > diff.txt
+
+If you want to see the changes between the ``feature`` branch and the commit ``A``, you can generate a diff file using the following command:
+
+.. code:: bash
+
+    git diff A..feature > diff.txt
+
+You can then run ``diff-cover`` with the diff file as an argument:
+
+.. code:: bash
+
+    diff-cover coverage.xml --diff-file=diff.txt
+
 Fail Under
 ----------
 

{diff_cover-8.0.3 → diff_cover-9.1.0}/diff_cover/command_runner.py

@@ -31,9 +31,11 @@ def execute(command, exit_codes=None):
         sys.stderr.write(
             " ".join(
                 [
-                    cmd.decode(sys.getfilesystemencoding())
-                    if isinstance(cmd, bytes)
-                    else cmd
+                    (
+                        cmd.decode(sys.getfilesystemencoding())
+                        if isinstance(cmd, bytes)
+                        else cmd
+                    )
                     for cmd in command
                 ]
             )

{diff_cover-8.0.3 → diff_cover-9.1.0}/diff_cover/diff_cover_tool.py

@@ -8,7 +8,7 @@ import xml.etree.ElementTree as etree
 from diff_cover import DESCRIPTION, VERSION
 from diff_cover.config_parser import Tool, get_config
 from diff_cover.diff_reporter import GitDiffReporter
-from diff_cover.git_diff import GitDiffTool
+from diff_cover.git_diff import GitDiffFileTool, GitDiffTool
 from diff_cover.git_path import GitPathTool
 from diff_cover.report_generator import (
     HtmlReportGenerator,
@@ -43,6 +43,7 @@ QUIET_HELP = "Only print errors and failures"
 SHOW_UNCOVERED = "Show uncovered lines on the console"
 INCLUDE_UNTRACKED_HELP = "Include untracked files"
 CONFIG_FILE_HELP = "The configuration file to use"
+DIFF_FILE_HELP = "The diff file to use"
 
 LOGGER = logging.getLogger(__name__)
 
@@ -169,6 +170,8 @@ def parse_coverage_args(argv):
         "-c", "--config-file", help=CONFIG_FILE_HELP, metavar="CONFIG_FILE"
     )
 
+    parser.add_argument("--diff-file", type=str, default=None, help=DIFF_FILE_HELP)
+
     defaults = {
         "show_uncovered": False,
         "compare_branch": "origin/main",
@@ -188,6 +191,7 @@ def parse_coverage_args(argv):
 def generate_coverage_report(
     coverage_files,
     compare_branch,
+    diff_tool,
     html_report=None,
     css_file=None,
     json_report=None,
@@ -198,8 +202,6 @@ def generate_coverage_report(
     exclude=None,
     include=None,
     src_roots=None,
-    diff_range_notation=None,
-    ignore_whitespace=False,
     quiet=False,
     show_uncovered=False,
 ):
@@ -208,7 +210,7 @@ def generate_coverage_report(
     """
     diff = GitDiffReporter(
         compare_branch,
-        git_diff=GitDiffTool(diff_range_notation, ignore_whitespace),
+        git_diff=diff_tool,
         ignore_staged=ignore_staged,
         ignore_unstaged=ignore_unstaged,
         include_untracked=include_untracked,
@@ -281,9 +283,19 @@ def main(argv=None, directory=None):
 
     GitPathTool.set_cwd(directory)
     fail_under = arg_dict.get("fail_under")
+    diff_tool = None
+
+    if not arg_dict["diff_file"]:
+        diff_tool = GitDiffTool(
+            arg_dict["diff_range_notation"], arg_dict["ignore_whitespace"]
+        )
+    else:
+        diff_tool = GitDiffFileTool(arg_dict["diff_file"])
+
     percent_covered = generate_coverage_report(
         arg_dict["coverage_file"],
         arg_dict["compare_branch"],
+        diff_tool,
         html_report=arg_dict["html_report"],
         json_report=arg_dict["json_report"],
         markdown_report=arg_dict["markdown_report"],
@@ -294,8 +306,6 @@ def main(argv=None, directory=None):
         exclude=arg_dict["exclude"],
         include=arg_dict["include"],
         src_roots=arg_dict["src_roots"],
-        diff_range_notation=arg_dict["diff_range_notation"],
-        ignore_whitespace=arg_dict["ignore_whitespace"],
         quiet=quiet,
         show_uncovered=arg_dict["show_uncovered"],
     )

{diff_cover-8.0.3 → diff_cover-9.1.0}/diff_cover/diff_reporter.py

@@ -1,6 +1,7 @@
 """
 Classes for querying which lines have changed based on a diff.
 """
+
 import fnmatch
 import glob
 import os

{diff_cover-8.0.3 → diff_cover-9.1.0}/diff_cover/git_diff.py

@@ -1,6 +1,7 @@
 """
 Wrapper for `git diff` command.
 """
+
 from textwrap import dedent
 
 from diff_cover.command_runner import CommandError, execute
@@ -109,3 +110,38 @@ class GitDiffTool:
         if not output:
             return []
         return [line for line in output.splitlines() if line]
+
+
+class GitDiffFileTool(GitDiffTool):
+
+    def __init__(self, diff_file_path):
+
+        self.diff_file_path = diff_file_path
+        super().__init__("...", False)
+
+    def diff_committed(self, compare_branch="origin/main"):
+        """
+        Returns the contents of a diff file.
+
+        Raises a `GitDiffError` if the file cannot be read.
+        """
+        try:
+            with open(self.diff_file_path, "r") as file:
+                return file.read()
+        except IOError as e:
+            raise ValueError(
+                dedent(
+                    f"""
+                    Could not read the diff file. Make sure '{self.diff_file_path}' exists?
+                    """
+                )
+            )
+
+    def diff_unstaged(self):
+        return ""
+
+    def diff_staged(self):
+        return ""
+
+    def untracked(self):
+        return ""

{diff_cover-8.0.3 → diff_cover-9.1.0}/diff_cover/git_path.py

@@ -1,6 +1,7 @@
 """
 Converter for `git diff` paths
 """
+
 import os
 import sys
 

{diff_cover-8.0.3 → diff_cover-9.1.0}/diff_cover/report_generator.py

@@ -1,6 +1,7 @@
 """
 Classes for generating diff coverage reports.
 """
+
 import contextlib
 import json
 import os

{diff_cover-8.0.3 → diff_cover-9.1.0}/diff_cover/snippets.py

@@ -2,6 +2,7 @@
 Load snippets from source files to show violation lines
 in HTML reports.
 """
+
 import contextlib
 from tokenize import open as openpy
 
@@ -115,18 +116,33 @@ class Snippet:
         Return a Markdown representation of the snippet using Markdown fenced code blocks.
         See https://github.github.com/gfm/#fenced-code-blocks.
         """
+
+        line_number_length = len(str(self._last_line))
+
+        text = ""
+        for i, line in enumerate(self.text().splitlines(), start=self._start_line):
+            if i > self._start_line:
+                text += "\n"
+
+            notice = " "
+            if i in self._violation_lines:
+                notice = "!"
+
+            format_string = "{} {:>" + str(line_number_length) + "} {}"
+            text += format_string.format(notice, i, line)
+
         header = "Lines %d-%d\n\n" % (self._start_line, self._last_line)
         if self._lexer_name in self.LEXER_TO_MARKDOWN_CODE_HINT:
             return header + (
                 "```"
                 + self.LEXER_TO_MARKDOWN_CODE_HINT[self._lexer_name]
                 + "\n"
-                + self.text()
+                + text
                 + "\n```\n"
             )
 
         # unknown programming language, return a non-decorated fenced code block:
-        return "```\n" + self.text() + "\n```\n"
+        return "```\n" + text + "\n```\n"
 
     def terminal(self):
         """

{diff_cover-8.0.3 → diff_cover-9.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "diff_cover"
-version = "8.0.3"
+version = "9.1.0"
 description = "Run coverage and linting reports on diffs"
 authors = ["See Contributors"]
 homepage = "https://github.com/Bachmann1234/diff-cover"
@@ -49,16 +49,16 @@ tomli = {version = ">=1.2.1", optional = true}
 setuptools = { version = ">=17.0.0", python = "<3.8" }
 
 [tool.poetry.dev-dependencies]
-pytest-cov = "^4.1.0"
+pytest-cov = "^5.0.0"
 pytest-datadir = "^1.5.0"
-pytest-mock = "^3.12.0"
+pytest-mock = "^3.14.0"
 pycodestyle = ">=2.9.1"
 flake8 = "^5.0.4"
 pyflakes = "^2.5.0"
-pylint = "^3.0.3"
-pylint-pytest = "^1.1.7"
+pylint = "^3.2.2"
+pylint-pytest = "^1.1.8"
 pydocstyle = "^6.1.1"
-black = "^23.12.1"
+black = "^24.4.2"
 isort = "^5.13.2"
 doc8 = "1.1.1"
 

diff_cover-9.1.0/tests/fixtures/snippet_list.md

@@ -0,0 +1,38 @@
+Lines 6-17
+
+```python
+   6 Line 6
+   7 Line 7
+   8 Line 8
+   9 Line 9
+! 10 Line 10
+  11 Line 11
+! 12 Line 12
+! 13 Line 13
+  14 Line 14
+  15 Line 15
+  16 Line 16
+  17 Line 17
+```
+
+
+Lines 46-61
+
+```python
+  46 Line 46
+  47 Line 47
+  48 Line 48
+  49 Line 49
+! 50 Line 50
+! 51 Line 51
+  52 Line 52
+  53 Line 53
+! 54 Line 54
+! 55 Line 55
+  56 Line 56
+! 57 Line 57
+  58 Line 58
+  59 Line 59
+  60 Line 60
+  61 Line 61
+```

diff_cover-9.1.0/tests/fixtures/snippet_list2.md

@@ -0,0 +1,10 @@
+Lines 1-7
+
+```cpp
+  1 #include <iostream>
+  2 
+  3 int main() {
+! 4     std::cout << "Hello World!";
+! 5     return 0;
+  6 }
+```

diff_cover-9.1.0/tests/fixtures/snippet_list3.md

@@ -0,0 +1,13 @@
+Lines 8-16
+
+```cpp
+   8     // this is line 8
+   9     printf("Test2");
+  10 
+  11     // this is line 11
+! 12     printf("Test");
+  13 }
+  14 
+  15 int main()
+  16 {
+```

{diff_cover-8.0.3 → diff_cover-9.1.0}/tests/helpers.py

@@ -1,6 +1,7 @@
 """
 Test helper functions.
 """
+
 import os.path
 import random
 

diff_cover-9.1.0/tests/test_git_diff_file.py

@@ -0,0 +1,72 @@
+# pylint: disable=missing-function-docstring
+
+"""Test for diff_cover.git_diff.GitDiffFileTool"""
+
+import pytest
+
+from diff_cover.git_diff import GitDiffFileTool
+
+
+@pytest.fixture
+def mock_file(mocker):
+    def _inner(file_content):
+        mock_open = mocker.mock_open(read_data=file_content)
+        mocker.patch("builtins.open", mock_open)
+
+    return _inner
+
+
+@pytest.fixture
+def diff_tool():
+    def _inner(file):
+        return GitDiffFileTool(file)
+
+    return _inner
+
+
+def test_diff_file_not_found(mocker, diff_tool):
+    mocker.patch("builtins.open", side_effect=IOError)
+
+    _diff_tool = diff_tool("non_existent_diff_file.txt")
+
+    with pytest.raises(ValueError) as excinfo:
+        _diff_tool.diff_committed()
+
+    assert (
+        f"Could not read the diff file. Make sure '{_diff_tool.diff_file_path}' exists?"
+        in str(excinfo.value)
+    )
+    assert _diff_tool.diff_file_path == "non_existent_diff_file.txt"
+
+
+def test_large_diff_file(mock_file, diff_tool):
+    large_diff = "diff --git a/file1 b/file2\n" * 1000000
+
+    mock_file(large_diff)
+
+    _diff_tool = diff_tool("large_diff_file.txt")
+
+    assert _diff_tool.diff_committed() == large_diff
+    assert _diff_tool.diff_file_path == "large_diff_file.txt"
+
+
+def test_diff_committed(mock_file, diff_tool):
+    diff = "diff --git a/file1 b/file2\n"
+
+    mock_file(diff)
+
+    _diff_tool = diff_tool("diff_file.txt")
+
+    assert _diff_tool.diff_committed() == diff
+    assert _diff_tool.diff_file_path == "diff_file.txt"
+
+
+def test_empty_diff_file(mock_file, diff_tool):
+    empty_diff = ""
+
+    mock_file(empty_diff)
+
+    _diff_tool = diff_tool("empty_diff.txt")
+
+    assert _diff_tool.diff_committed() == empty_diff
+    assert _diff_tool.diff_file_path == "empty_diff.txt"

diff_cover-8.0.3/tests/fixtures/snippet_list.md

@@ -1,38 +0,0 @@
-Lines 6-17
-
-```python
-Line 6
-Line 7
-Line 8
-Line 9
-Line 10
-Line 11
-Line 12
-Line 13
-Line 14
-Line 15
-Line 16
-Line 17
-```
-
-
-Lines 46-61
-
-```python
-Line 46
-Line 47
-Line 48
-Line 49
-Line 50
-Line 51
-Line 52
-Line 53
-Line 54
-Line 55
-Line 56
-Line 57
-Line 58
-Line 59
-Line 60
-Line 61
-```

diff_cover-8.0.3/tests/fixtures/snippet_list2.md

@@ -1,11 +0,0 @@
-Lines 1-7
-
-```cpp
-#include <iostream>
-
-int main() {
-    std::cout << "Hello World!";
-    return 0;
-}
-
-```

diff_cover-8.0.3/tests/fixtures/snippet_list3.md

@@ -1,13 +0,0 @@
-Lines 8-16
-
-```cpp
-    // this is line 8
-    printf("Test2");
-
-    // this is line 11
-    printf("Test");
-}
-
-int main()
-{
-```