blot-git 0.3.2__tar.gz → 0.4.0__tar.gz

blot_git-0.4.0/.github/workflows/blot.yml

@@ -0,0 +1,14 @@
+name: Blot on Blot
+
+# Runs this repo's own action (action.yml) on every pull request, installing Blot from the
+# pull request's code: it tests the action end to end and reviews Blot's history with Blot.
+on: pull_request
+
+jobs:
+  blot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./
+        with:
+          blot-package: .

{blot_git-0.3.2 → blot_git-0.4.0}/.pre-commit-hooks.yaml

@@ -1,6 +1,6 @@
 # Lets users of the pre-commit framework add blot with:
 #   - repo: https://github.com/Sym-jay/Blot
-#     rev: v0.3.2
+#     rev: v0.4.0
 #     hooks: [{id: blot}]
 # The first commit indexes the repo's history; later commits refresh the index incrementally.
 - id: blot

{blot_git-0.3.2 → blot_git-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: blot-git
-Version: 0.3.2
+Version: 0.4.0
 Summary: A pre-commit check that has read your project's history: warns when a change removes a fix, re-adds a fixed bug, or forgets a file that always changes too.
 Project-URL: Homepage, https://github.com/Sym-jay/Blot
 Project-URL: Issues, https://github.com/Sym-jay/Blot/issues

{blot_git-0.3.2 → blot_git-0.4.0}/README.md

@@ -79,6 +79,27 @@ blot index --github
 
 With the [GitHub CLI](https://cli.github.com) logged in, Blot fetches the titles and labels of the issues and PRs your fix commits mention, so warnings read `fixes #2935 "copy_current_request_context copies old session object"` (a real Flask issue) instead of a bare number. A `bug` label makes a commit count as a load-bearing fix; a fix-looking commit whose issues are only labelled `enhancement` or `documentation` is demoted. Refreshes only fetch what's new. Repos with GitHub Issues turned off (they track bugs elsewhere) are skipped.
 
+## Use in CI
+
+Run Blot on every pull request and see its findings as warnings on the changed lines:
+
+```yaml
+# .github/workflows/blot.yml
+name: Blot
+on: pull_request
+jobs:
+  blot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Sym-jay/Blot@v0.4.0
+```
+
+The action checks out the pull request with its full history, installs Blot, runs `blot index` and
+`blot check --range origin/<base>..HEAD --format json`, and turns each finding into a warning annotation.
+It never fails the job because of findings. Inputs: `blot-package` (what to `pip install`; default
+`blot-git`, the latest PyPI release), `python-version` (default `3.13`) and `base-ref`
+(default: the pull request's base branch).
+
 ## Measure it on your repo
 
 ```bash

blot_git-0.4.0/action.yml

@@ -0,0 +1,73 @@
+# Run Blot on a pull request and show its findings as warning annotations.
+# Usage (in a workflow triggered by pull_request):
+#   - uses: Sym-jay/Blot@v0.4.0
+# See "Use in CI" in README.md.
+name: Blot
+description: History-aware checks on the commits of a pull request, shown as warning annotations
+author: Sym-jay
+branding:
+  icon: alert-triangle
+  color: orange
+
+inputs:
+  base-ref:
+    description: Branch the pull request merges into; the action checks origin/<base-ref>..HEAD
+    default: ${{ github.base_ref }}
+  python-version:
+    description: Python version used to run Blot
+    default: "3.13"
+  blot-package:
+    description: What to pip install (a pip requirement, e.g. blot-git==0.3.2)
+    default: blot-git  # the latest release on PyPI
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Blot reads the whole history
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install Blot
+      shell: bash
+      env:
+        BLOT_PACKAGE: ${{ inputs.blot-package }}
+      run: python -m pip install --disable-pip-version-check "$BLOT_PACKAGE"
+
+    - name: Run Blot
+      shell: bash
+      env:
+        BASE_REF: ${{ inputs.base-ref }}
+        BLOT_FINDINGS: ${{ runner.temp }}/blot-findings.json
+        PYTHONUTF8: "1"  # commit subjects in findings may not be ASCII
+      run: |
+        if [[ -z "$BASE_REF" ]]; then
+          echo "::error title=blot::No base branch: run this action on pull_request, or set base-ref"
+          exit 1
+        fi
+        blot index
+        blot check --range "origin/${BASE_REF}..HEAD" --format json > "$BLOT_FINDINGS"
+        python - <<'PY'
+        # Turn blot's JSON findings into workflow annotations (::warning file=...,line=...::message).
+        import json, os
+
+        def esc(text, prop=False):
+            text = text.replace("%", "%25").replace("\r", "%0D").replace("\n", "%0A")
+            return text.replace(":", "%3A").replace(",", "%2C") if prop else text
+
+        with open(os.environ["BLOT_FINDINGS"], encoding="utf-8") as f:
+            raw = f.read()
+        # blot check prints nothing on stdout when it hits an internal error (the reason is in the log above)
+        findings = json.loads(raw) if raw.strip() else []
+        for f in findings:
+            props = f"file={esc(f['path'], True)}"
+            if f.get("line"):
+                props += f",line={f['line']}"
+            props += f",title={esc('blot: ' + f['check'], True)}"
+            message = "\n".join([f["message"], *f.get("evidence", [])])
+            print(f"::warning {props}::{esc(message)}")
+        print(f"blot: {len(findings)} finding{'' if len(findings) == 1 else 's'}")
+        PY

{blot_git-0.3.2 → blot_git-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "blot-git"
-version = "0.3.2"
+version = "0.4.0"
 description = "A pre-commit check that has read your project's history: warns when a change removes a fix, re-adds a fixed bug, or forgets a file that always changes too."
 readme = "docs/PYPI.md"  # text-only; the GitHub README's relative Sora images break on PyPI
 license = { text = "MIT" }

{blot_git-0.3.2 → blot_git-0.4.0}/src/blot/__init__.py

@@ -1,3 +1,3 @@
 """blot: history-aware pre-commit checks."""
 
-__version__ = "0.3.2"
+__version__ = "0.4.0"

{blot_git-0.3.2 → blot_git-0.4.0}/src/blot/cli.py

@@ -60,12 +60,14 @@ def _open_index(repo: str):
 
 
 def _cmd_check(args: argparse.Namespace) -> int:
-    from blot.diff import read_changes
+    from blot.diff import range_base, read_changes
 
     try:
         config = load_config(args.repo)
         store = _open_index(args.repo)
         changes = read_changes(args.repo, rev_range=args.range)
+        if args.range:  # removed lines are numbered as in the range's base, not as in HEAD
+            store.rev = range_base(args.repo, args.range)
         findings = [f for check in all_checks(config) for f in check.run(changes, store, config)]
     except Exception as exc:  # Blot's own failures must never block a commit
         print(f"blot: internal error, skipping checks ({exc.__class__.__name__}: {exc})", file=sys.stderr)

{blot_git-0.3.2 → blot_git-0.4.0}/src/blot/diff.py

@@ -145,3 +145,13 @@ def read_changes(repo: str, rev_range: str | None = None) -> list[FileChange]:
     args = ["diff", "-U0", "--no-color", "--no-ext-diff", "-M"]
     args.append(rev_range if rev_range else "--cached")
     return parse_unified_diff(run_git(repo, *args))
+
+
+def range_base(repo: str, rev_range: str) -> str:
+    """The commit `git diff <rev_range>` compares against: A for `A..B`, the merge base for `A...B`."""
+    if "..." in rev_range:
+        left, right = rev_range.split("...", 1)
+        return run_git(repo, "merge-base", left or "HEAD", right or "HEAD").strip()
+    if ".." in rev_range:
+        return rev_range.split("..", 1)[0] or "HEAD"
+    return rev_range

blot_git-0.4.0/tests/test_action.py

@@ -0,0 +1,67 @@
+"""action.yml: the step that turns `blot check --format json` output into workflow annotations."""
+
+import json
+import os
+import subprocess
+import sys
+import textwrap
+from pathlib import Path
+
+from blot.cli import main
+
+ACTION = Path(__file__).resolve().parent.parent / "action.yml"
+
+
+def _annotate_script() -> str:
+    """The Python heredoc in action.yml's "Run Blot" step (stdlib only, so no YAML parser needed)."""
+    lines = ACTION.read_text(encoding="utf-8").splitlines()
+    start = next(i for i, line in enumerate(lines) if line.strip() == "python - <<'PY'") + 1
+    end = next(i for i in range(start, len(lines)) if lines[i].strip() == "PY")
+    return textwrap.dedent("\n".join(lines[start:end])) + "\n"
+
+
+def _annotate(tmp_path: Path, raw: str) -> list[str]:
+    findings = tmp_path / "findings.json"
+    findings.write_text(raw, encoding="utf-8")
+    out = subprocess.run([sys.executable, "-c", _annotate_script()], env={**os.environ, "BLOT_FINDINGS": str(findings)},
+                         capture_output=True, text=True, check=True).stdout
+    return out.splitlines()
+
+
+def test_findings_become_warning_annotations(tmp_path):
+    findings = [
+        {"check": "removed-fix", "path": "src/a,b.py", "line": 12, "severity": 2,
+         "message": "You're changing a line added by a bug fix: 100% sure.",
+         "evidence": ['8efea0cc "Break reference cycle" (2020-10-03, fixes #3761)']},
+        {"check": "forgot-related-file", "path": "app.py", "line": None, "severity": 1,
+         "message": "app.py usually changes with views.py.", "evidence": []},
+    ]
+    assert _annotate(tmp_path, json.dumps(findings)) == [
+        "::warning file=src/a%2Cb.py,line=12,title=blot%3A removed-fix::"
+        "You're changing a line added by a bug fix: 100%25 sure."
+        '%0A8efea0cc "Break reference cycle" (2020-10-03, fixes #3761)',
+        "::warning file=app.py,title=blot%3A forgot-related-file::app.py usually changes with views.py.",
+        "blot: 2 findings",
+    ]
+
+
+def test_no_findings_and_no_output(tmp_path):
+    assert _annotate(tmp_path, "[]\n") == ["blot: 0 findings"]
+    assert _annotate(tmp_path, "") == ["blot: 0 findings"]  # blot check hit an internal error
+
+
+def test_range_check_of_a_pr_branch_is_annotated(make_repo, tmp_path, capsys):
+    from test_checks import AFTER, BEFORE, GUARD
+
+    repo = make_repo([("Add app", {"app.py": BEFORE}),
+                      ("Break reference cycle in App (fixes #3761)", {"app.py": AFTER})])
+    git = lambda *args: subprocess.run(["git", "-C", str(repo), *args], check=True, capture_output=True)  # noqa: E731
+    git("switch", "-q", "-c", "pr")
+    (repo / "app.py").write_text(AFTER.replace(GUARD, "self_ref = self"), encoding="utf-8")
+    git("commit", "-q", "-am", "Simplify App")
+
+    assert main(["--repo", str(repo), "check", "--range", "main..HEAD", "--format", "json"]) == 0
+    lines = _annotate(tmp_path, capsys.readouterr().out)
+    assert lines[-1].startswith("blot: ") and lines[-1] != "blot: 0 findings"
+    assert any(line.startswith("::warning file=app.py,line=") and ",title=blot%3A removed-fix::" in line
+               for line in lines)

{blot_git-0.3.2 → blot_git-0.4.0}/tests/test_cli.py

@@ -78,3 +78,25 @@ def test_removed_fix_traces_past_refactor(make_repo, capsys):
     # plain blame stops at the split; blot must cite the fix behind it
     assert finding["evidence"][0].startswith(sha("HEAD~1")[:7] + ' "Break reference cycle in App (fixes #3761)"')
     assert finding["evidence"][1].startswith("traced past refactor " + sha("HEAD")[:7])
+
+
+def test_check_range_reads_removed_lines_at_the_base(make_repo, capsys):
+    """In CI the PR's commits are already in the index and HEAD no longer has the removed line."""
+    from test_checks import AFTER, BEFORE, GUARD
+
+    repo = make_repo([("Add app", {"app.py": BEFORE}),
+                      ("Break reference cycle in App (fixes #3761)", {"app.py": AFTER})])
+    git = lambda *args: subprocess.run(["git", "-C", str(repo), *args], check=True, capture_output=True)  # noqa: E731
+    git("switch", "-q", "-c", "pr")
+    (repo / "app.py").write_text(AFTER.replace(GUARD, "self_ref = self"), encoding="utf-8")
+    git("commit", "-q", "-am", "Simplify App")
+    git("switch", "-q", "main")
+    (repo / "README.md").write_text("app\n", encoding="utf-8")
+    git("add", "README.md")
+    git("commit", "-q", "-m", "docs: readme")  # main moves on, so A..B and A...B differ
+    git("switch", "-q", "pr")
+
+    for rev_range in ("HEAD~1..HEAD", "main...pr"):
+        assert main(["--repo", str(repo), "check", "--range", rev_range, "--format", "json"]) == 0
+        found = [(f["check"], f["path"], f["line"]) for f in json.loads(capsys.readouterr().out)]
+        assert ("removed-fix", "app.py", 3) in found, rev_range