Refactor testing/ integration tests into pytest suite

Copilot · shenxianpeng · shenxianpeng · commit 73a4dfc2380c · 2026-04-07T00:16:56.000+03:00
- Add tests/test_integration.py with 24 parametrized pytest tests covering all scenarios from the pre-commit config YAML files: style-from-file (.clang-format), versions 16-21, style presets (LLVM/Google/Microsoft/WebKit/Mozilla/Chromium with reformat and idempotence checks), verbose flags, and parallel clang-tidy. - Rewrite testing/run.sh: replace the fragile magic-number approach (grep -c 'Failed' == 21) with a run_test() helper that explicitly declares the expected outcome for each scenario and reports pass/fail per test with human-readable descriptions. Agent-Logs-Url: https://github.com/cpp-linter/cpp-linter-hooks/sessions/509b22bb-e65e-4a6f-bc53-52d404732235 Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
diff --git a/testing/run.sh b/testing/run.sh
@@ -1,82 +1,108 @@
 #!/bin/bash
+# Pre-commit integration tests for cpp-linter-hooks.
+#
+# Each test runs a specific pre-commit configuration against testing/main.c
+# and checks whether the expected outcome (pass or fail) is observed.
+# testing/main.c is restored after every test so they are independent.
+#
+# These tests exercise the full pre-commit pipeline (hook definitions,
+# entry points, argument passing) which the pytest unit tests do not cover.
+# The hook logic itself is tested in tests/test_integration.py.
 
-configs=(
-    "pre-commit-config.yaml"
-    "pre-commit-config-version.yaml"
-    "pre-commit-config-verbose.yaml"
-    "pre-commit-config-style.yaml"
-)
+set -euo pipefail
 
-for config in "${configs[@]}"; do
-    echo "===================================="
-    echo "Test $config"
-    echo "===================================="
-    uvx pre-commit clean
-    uvx pre-commit run -c testing/$config --files testing/main.c | tee -a result.txt || true
-    git restore testing/main.c
-done
+PASS=0
+FAIL=0
 
-echo "=================================================================================="
-echo "Print result.txt"
-cat result.txt
-echo "=================================================================================="
+# run_test <description> <config-file> <files> <expect-nonzero>
+#
+#   description    – human-readable name shown in output
+#   config-file    – path to the pre-commit config (relative to repo root)
+#   files          – space-separated list of files passed to --files
+#   expect-nonzero – "true" if the hook is expected to report failures,
+#                    "false" if it should exit cleanly
+run_test() {
+    local description="$1"
+    local config="$2"
+    local files="$3"
+    local expect_nonzero="$4"
 
-failed_cases=$(grep -c "Failed" result.txt)
+    echo "---- $description ----"
+    uvx pre-commit clean -q
 
-echo "$failed_cases cases failed."
+    local output
+    # shellcheck disable=SC2086  # word-splitting of $files is intentional
+    if output=$(uvx pre-commit run -c "$config" --files $files 2>&1); then
+        local got_nonzero=false
+    else
+        local got_nonzero=true
+    fi
 
-if [[ $failed_cases -eq 21 ]]; then
-    echo "=============================="
-    echo "Test cpp-linter-hooks success."
-    echo "=============================="
-    result="success"
-    rm result.txt
-    exit_code=0
-else
-    echo "============================="
-    echo "Test cpp-linter-hooks failed."
-    echo "============================="
-    result="failure"
-    exit_code=1
-fi
+    git restore testing/main.c 2>/dev/null || true
 
-# Test parallel execution with multiple source files
-echo "===================================="
-echo "Test pre-commit-config-parallel.yaml"
-echo "===================================="
-uvx pre-commit clean
-uvx pre-commit run -c testing/pre-commit-config-parallel.yaml \
-    --files testing/main.c testing/good.c | tee -a parallel_result.txt || true
-git restore testing/main.c
+    if [[ "$expect_nonzero" == "$got_nonzero" ]]; then
+        echo "PASS: $description"
+        PASS=$((PASS + 1))
+    else
+        echo "FAIL: $description (expect_nonzero=$expect_nonzero, got_nonzero=$got_nonzero)"
+        echo "$output"
+        FAIL=$((FAIL + 1))
+    fi
+    echo ""
+}
 
-parallel_failed=$(grep -c "Failed" parallel_result.txt 2>/dev/null || echo "0")
-echo "$parallel_failed parallel cases failed."
+# ── Basic config: clang-format + clang-tidy on the unformatted file ──────────
+# Expected: clang-format rewrites main.c → pre-commit reports failure.
+run_test \
+    "basic: clang-format + clang-tidy on unformatted file" \
+    "testing/pre-commit-config.yaml" \
+    "testing/main.c" \
+    "true"
 
-if [[ $parallel_failed -ge 1 ]]; then
-    echo "========================================================"
-    echo "Parallel test passed (expected failures detected: $parallel_failed)."
-    echo "========================================================"
-    parallel_result="success"
-    rm parallel_result.txt
-else
-    echo "==========================================="
-    echo "Parallel test failed (no failures detected)."
-    echo "==========================================="
-    parallel_result="failure"
-    exit_code=1
-fi
+# ── Version config: explicit versions 16–21 ──────────────────────────────────
+# Expected: at least clang-format v16 rewrites the file → failure reported.
+run_test \
+    "versions 16-21: clang-format + clang-tidy" \
+    "testing/pre-commit-config-version.yaml" \
+    "testing/main.c" \
+    "true"
+
+# ── Verbose config: --verbose and -v flags ────────────────────────────────────
+# Expected: clang-format rewrites main.c (verbose output goes to stderr).
+run_test \
+    "verbose: --verbose and -v flags" \
+    "testing/pre-commit-config-verbose.yaml" \
+    "testing/main.c" \
+    "true"
+
+# ── Style config: LLVM / Google / Microsoft / WebKit / Mozilla / Chromium ────
+# Expected: each style reformats main.c differently → failure reported.
+run_test \
+    "styles: LLVM, Google, Microsoft, WebKit, Mozilla, Chromium" \
+    "testing/pre-commit-config-style.yaml" \
+    "testing/main.c" \
+    "true"
 
-# Add result to GitHub summary if running in GitHub Actions
-if [[ -n "$GITHUB_STEP_SUMMARY" ]]; then
+# ── Parallel config: clang-tidy --jobs=2 on two source files ─────────────────
+# Expected: clang-tidy finds issues in at least one file → failure reported.
+run_test \
+    "parallel: clang-tidy --jobs=2 on main.c + good.c" \
+    "testing/pre-commit-config-parallel.yaml" \
+    "testing/main.c testing/good.c" \
+    "true"
+
+# ── Summary ───────────────────────────────────────────────────────────────────
+echo "Results: $PASS passed, $FAIL failed"
+
+if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
     {
-        echo "### cpp-linter-hooks Test Result"
-        echo ""
-        echo "**Result:** $result"
-        echo ""
-        echo "**Failed cases:** $failed_cases"
+        echo "### cpp-linter-hooks pre-commit integration test results"
         echo ""
-        echo "**Parallel test:** $parallel_result"
+        echo "| Result | Count |"
+        echo "|--------|-------|"
+        echo "| Passed | $PASS |"
+        echo "| Failed | $FAIL |"
     } >> "$GITHUB_STEP_SUMMARY"
 fi
 
-exit $exit_code
+[[ $FAIL -eq 0 ]]
diff --git a/tests/test_integration.py b/tests/test_integration.py
@@ -0,0 +1,209 @@
+"""Integration tests that mirror the scenarios from testing/pre-commit-config-*.yaml.
+
+These tests call the hook functions directly and validate end-to-end behaviour
+for the key scenarios exercised by the pre-commit configuration files:
+
+* pre-commit-config.yaml          – basic style-from-file with .clang-format
+* pre-commit-config-version.yaml  – explicit tool versions 16–21
+* pre-commit-config-verbose.yaml  – --verbose / -v flags
+* pre-commit-config-style.yaml    – LLVM, Google, Microsoft, WebKit, Mozilla, Chromium
+
+Each scenario is a named, parametrized pytest function with explicit assertions
+so failures report the exact case that broke, and new cases can be added by
+extending the parametrize list.
+"""
+
+import shutil
+
+import pytest
+from pathlib import Path
+
+from cpp_linter_hooks.clang_format import run_clang_format
+from cpp_linter_hooks.clang_tidy import run_clang_tidy
+
+TESTING_DIR = Path("testing")
+MAIN_C = TESTING_DIR / "main.c"
+GOOD_C = TESTING_DIR / "good.c"
+
+
+# ---------------------------------------------------------------------------
+# Shared fixtures
+# ---------------------------------------------------------------------------
+
+
+@pytest.fixture()
+def unformatted_file(tmp_path):
+    """Return a temporary copy of the unformatted source file."""
+    test_file = tmp_path / "main.c"
+    test_file.write_bytes(MAIN_C.read_bytes())
+    return test_file
+
+
+@pytest.fixture()
+def clang_format_workspace(tmp_path, monkeypatch):
+    """Temp directory that contains .clang-format + an unformatted main.c.
+
+    monkeypatch.chdir ensures --style=file discovers the config file.
+    """
+    shutil.copy(TESTING_DIR / ".clang-format", tmp_path / ".clang-format")
+    test_file = tmp_path / "main.c"
+    test_file.write_bytes(MAIN_C.read_bytes())
+    monkeypatch.chdir(tmp_path)
+    return test_file
+
+
+# ---------------------------------------------------------------------------
+# pre-commit-config.yaml scenario – style-from-file
+# ---------------------------------------------------------------------------
+
+
+@pytest.mark.benchmark
+def test_clang_format_style_from_file_reformats(clang_format_workspace):
+    """--style=file reads .clang-format and reformats the unformatted file."""
+    test_file = clang_format_workspace
+    original = test_file.read_text()
+
+    ret, output = run_clang_format(["--style=file", str(test_file)])
+
+    assert ret == 0
+    assert isinstance(output, str)
+    assert test_file.read_text() != original, "file should have been reformatted"
+
+
+@pytest.mark.benchmark
+def test_clang_format_style_from_file_is_idempotent(clang_format_workspace):
+    """Running --style=file twice on an already-formatted file is a no-op."""
+    test_file = clang_format_workspace
+
+    # First pass: reformat
+    run_clang_format(["--style=file", str(test_file)])
+    after_first = test_file.read_text()
+
+    # Second pass: file should be unchanged
+    ret, output = run_clang_format(["--style=file", str(test_file)])
+
+    assert ret == 0
+    assert isinstance(output, str)
+    assert test_file.read_text() == after_first, "second pass must not change the file"
+
+
+# ---------------------------------------------------------------------------
+# pre-commit-config-version.yaml scenario – explicit versions 16–21
+# ---------------------------------------------------------------------------
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("version", ["16", "17", "18", "19", "20", "21"])
+def test_clang_format_style_from_file_with_version(tmp_path, monkeypatch, version):
+    """--style=file combined with an explicit --version reformats the file."""
+    shutil.copy(TESTING_DIR / ".clang-format", tmp_path / ".clang-format")
+    test_file = tmp_path / "main.c"
+    test_file.write_bytes(MAIN_C.read_bytes())
+    monkeypatch.chdir(tmp_path)
+
+    original = test_file.read_text()
+    ret, output = run_clang_format(
+        ["--style=file", f"--version={version}", str(test_file)]
+    )
+
+    assert ret == 0
+    assert isinstance(output, str)
+    assert test_file.read_text() != original, (
+        f"version {version}: file should have been reformatted"
+    )
+
+
+# ---------------------------------------------------------------------------
+# pre-commit-config-style.yaml scenario – various style presets
+# ---------------------------------------------------------------------------
+
+STYLE_PRESETS = ["LLVM", "Google", "Microsoft", "WebKit", "Mozilla", "Chromium"]
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("style", STYLE_PRESETS)
+def test_clang_format_style_preset_reformats_unformatted_file(style, unformatted_file):
+    """Each style preset should reformat the unformatted main.c."""
+    original = unformatted_file.read_text()
+
+    ret, output = run_clang_format([f"--style={style}", str(unformatted_file)])
+
+    assert ret == 0
+    assert isinstance(output, str)
+    assert unformatted_file.read_text() != original, (
+        f"style={style}: file should have been reformatted"
+    )
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("style", STYLE_PRESETS)
+def test_clang_format_style_preset_is_idempotent(style, tmp_path):
+    """Running clang-format twice with the same style preset is a no-op."""
+    test_file = tmp_path / "main.c"
+    test_file.write_bytes(MAIN_C.read_bytes())
+
+    # First pass: reformat
+    run_clang_format([f"--style={style}", str(test_file)])
+    after_first = test_file.read_text()
+
+    # Second pass: file must not change
+    ret, output = run_clang_format([f"--style={style}", str(test_file)])
+
+    assert ret == 0
+    assert isinstance(output, str)
+    assert test_file.read_text() == after_first, (
+        f"style={style}: second pass must not change the file"
+    )
+
+
+@pytest.mark.benchmark
+def test_clang_format_google_style_matches_good_c(unformatted_file):
+    """Google-style formatting of main.c must exactly match testing/good.c."""
+    ret, output = run_clang_format(["--style=Google", str(unformatted_file)])
+
+    assert ret == 0
+    assert isinstance(output, str)
+    assert unformatted_file.read_text() == GOOD_C.read_text()
+
+
+# ---------------------------------------------------------------------------
+# pre-commit-config-verbose.yaml scenario – verbose flags
+# ---------------------------------------------------------------------------
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("verbose_flag", ["--verbose", "-v"])
+def test_clang_format_verbose_flag_succeeds(verbose_flag, unformatted_file):
+    """Both --verbose and -v flags must be accepted and not break formatting."""
+    ret, output = run_clang_format([verbose_flag, "--style=Google", str(unformatted_file)])
+
+    assert ret == 0
+    assert isinstance(output, str)
+    assert unformatted_file.read_text() == GOOD_C.read_text()
+
+
+# ---------------------------------------------------------------------------
+# pre-commit-config-parallel.yaml scenario – parallel clang-tidy
+# ---------------------------------------------------------------------------
+
+
+@pytest.mark.benchmark
+def test_clang_tidy_parallel_execution_completes(tmp_path):
+    """clang-tidy --jobs=2 processes multiple source files without crashing."""
+    main_file = tmp_path / "main.c"
+    good_file = tmp_path / "good.c"
+    main_file.write_bytes(MAIN_C.read_bytes())
+    good_file.write_bytes(GOOD_C.read_bytes())
+
+    ret, output = run_clang_tidy(
+        [
+            "--no-compile-commands",
+            "--jobs=2",
+            str(main_file),
+            str(good_file),
+        ]
+    )
+
+    # Return code must be a valid integer (0 = clean, 1 = issues found).
+    assert isinstance(ret, int)
+    assert ret in (0, 1)
