|
1 | 1 | #!/usr/bin/env bash |
2 | | -# Regression contract for clang-tidy's `,-warnings-as-errors` diagnostic suffix. |
| 2 | +# Regression contract for clang-tidy's `,-warnings-as-errors` diagnostic suffix |
| 3 | +# (#2442). With WarningsAsErrors enabled, clang-tidy prints an analyzer check as |
| 4 | +# [clang-analyzer-<check>,-warnings-as-errors]; a gate that only accepts |
| 5 | +# [<check>] drops every such line and reports a clean gate. A suffixed finding |
| 6 | +# WITH an argued whitelist entry must be counted under its plain check name and |
| 7 | +# suppressed (exit 0, "1 argued false positive"). Every assertion is reported, |
| 8 | +# so a regression names what broke. |
| 9 | +# |
| 10 | +# The gate runs from inside the fixture directory with RELATIVE paths. On the |
| 11 | +# Windows leg python3 is a native MSYS2 build: MSYS converts path ARGUMENTS for |
| 12 | +# it, but never the diagnostic text on stdin, so an absolute /c/... path in a |
| 13 | +# finding would not resolve there, and a C:/... one would not parse (the file |
| 14 | +# field ends at the first colon). |
3 | 15 | set -euo pipefail |
4 | 16 |
|
5 | 17 | ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" |
| 18 | +GATE="$ROOT/scripts/lint-mem-gate.py" |
6 | 19 | FIX="$(mktemp -d "${TMPDIR:-/tmp}/lint-mem-gate.XXXXXX")" |
7 | 20 | trap 'rm -rf "$FIX"' EXIT |
8 | 21 |
|
| 22 | +failures=0 |
| 23 | +fail() { |
| 24 | + echo "FAIL: $*" >&2 |
| 25 | + failures=$((failures + 1)) |
| 26 | +} |
| 27 | + |
| 28 | +show() { |
| 29 | + sed 's/^/ | /' "$1" >&2 |
| 30 | +} |
| 31 | + |
| 32 | +# A subshell, so the test's own shell never sits inside $FIX (Windows cannot |
| 33 | +# remove a directory that is a process's working directory). |
| 34 | +run_gate() { |
| 35 | + (cd "$FIX" && LINT_MEM_WHITELIST=whitelist.txt python3 "$GATE" "$@") |
| 36 | +} |
| 37 | + |
9 | 38 | cat > "$FIX/sample.c" <<'EOF' |
10 | 39 | int sample(int *value) { |
11 | 40 | return *value; |
12 | 41 | } |
13 | 42 | EOF |
14 | 43 |
|
| 44 | +# A native Windows python3 writes CRLF; strip it before the hash is reused. |
| 45 | +HASH="$(run_gate --hash sample.c sample | tr -d '\r' | awk '/^segment-sha256:/ {print $2}')" |
| 46 | +if [[ ! "$HASH" =~ ^[0-9a-f]{64}$ ]]; then |
| 47 | + echo "FAIL: lint-mem-gate.py --hash sample.c sample printed no segment hash (got '$HASH')" >&2 |
| 48 | + exit 1 |
| 49 | +fi |
| 50 | + |
15 | 51 | cat > "$FIX/whitelist.txt" <<EOF |
16 | | -## $FIX/sample.c :: sample :: clang-analyzer-core.NullDereference |
17 | | -segment-sha256: PLACEHOLDER |
| 52 | +## sample.c :: sample :: clang-analyzer-core.NullDereference |
| 53 | +segment-sha256: $HASH |
18 | 54 | why: | |
19 | 55 | The test deliberately models a diagnostic that is suppressed by the fixture whitelist. |
20 | 56 | This text is long enough to exercise the gate's normal argument validation path. |
21 | 57 | tried: | |
22 | 58 | The fixture is intentionally minimal and only verifies diagnostic parsing. |
23 | 59 | EOF |
24 | 60 |
|
25 | | -HASH="$(LINT_MEM_WHITELIST="$FIX/whitelist.txt" python3 "$ROOT/scripts/lint-mem-gate.py" --hash "$FIX/sample.c" sample | awk '/^segment-sha256:/ {print $2}')" |
26 | | -python3 - "$FIX/whitelist.txt" "$HASH" <<'PY' |
27 | | -from pathlib import Path |
28 | | -import sys |
29 | | -
|
30 | | -path = Path(sys.argv[1]) |
31 | | -text = path.read_text(encoding="utf-8").replace("PLACEHOLDER", sys.argv[2]) |
32 | | -path.write_text(text, encoding="utf-8") |
33 | | -PY |
| 61 | +SUFFIX='[clang-analyzer-core.NullDereference,-warnings-as-errors]' |
34 | 62 |
|
35 | | -printf '%s\n' "$FIX/sample.c:2:12: warning: possible null dereference [clang-analyzer-core.NullDereference,-warnings-as-errors]" \ |
36 | | - | LINT_MEM_WHITELIST="$FIX/whitelist.txt" python3 "$ROOT/scripts/lint-mem-gate.py" 2> "$FIX/stderr" |
| 63 | +# Whitelisted: counted under the plain check name, then suppressed. |
| 64 | +rc=0 |
| 65 | +printf '%s\n' "sample.c:2:12: warning: possible null dereference $SUFFIX" \ |
| 66 | + | run_gate > /dev/null 2> "$FIX/whitelisted.err" || rc=$? |
| 67 | +if [ "$rc" -ne 0 ]; then |
| 68 | + fail "a whitelisted suffixed finding left the gate at exit $rc, expected 0" |
| 69 | + show "$FIX/whitelisted.err" |
| 70 | +fi |
| 71 | +if ! grep -q 'memory gate clean (1 argued false positive' "$FIX/whitelisted.err"; then |
| 72 | + fail "a whitelisted suffixed finding was not counted as 1 argued false positive" |
| 73 | + show "$FIX/whitelisted.err" |
| 74 | +fi |
37 | 75 |
|
38 | | -grep -q 'memory gate clean (1 argued false positive' "$FIX/stderr" |
| 76 | +if [ "$failures" -ne 0 ]; then |
| 77 | + echo "lint-mem-gate warning suffix contract: $failures assertion(s) failed" >&2 |
| 78 | + exit 1 |
| 79 | +fi |
39 | 80 | echo 'lint-mem-gate warning suffix contract passed' |
0 commit comments