forked from bchanot/claude
feat(a11y): standalone scanner on the shared engine (A11Y-CLEAR / A11Y-NO-NEW); guardrails drops the a11y domain
This commit is contained in:
1 parent
b4ef6ae359
commit
6e79d182e3
7 files changed
+213
-39
No files matched your search
Executable
+130
@@ -0,0 +1,130 @@
|
||||
#!/usr/bin/env bash
|
||||
# lib/tests/a11y-scan.test.sh — floor of the /a11y scanner catalogue.
|
||||
# The clean fixture must scan with zero FAIL and zero WARN. Each mutant breaks
|
||||
# one rule on a copy of it and must raise that rule at the expected severity
|
||||
# (positive control). The A11Y-CLEAR / A11Y-NO-NEW markers, the gates.sh
|
||||
# contract wiring and the rejection of guardrails rules are checked too; the
|
||||
# shared engine itself is proven in guardrails-scan.test.sh.
|
||||
# shellcheck disable=SC2016
|
||||
set -u
|
||||
ROOT="$(cd "$(dirname "$0")/../.." && pwd)"
|
||||
SCAN="$ROOT/skills/a11y/scripts/scan.py"
|
||||
GOOD="$ROOT/lib/tests/fixtures/a11y-good"
|
||||
WORK="$(mktemp -d)"; trap 'rm -rf "$WORK"' EXIT
|
||||
PASS=0; FAIL=0; LAST_OUT=""; LAST_RC=0
|
||||
|
||||
check() { # check <label> <got> <want>
|
||||
if [ "$2" = "$3" ]; then PASS=$((PASS+1)); echo " PASS $1"
|
||||
else FAIL=$((FAIL+1)); echo " FAIL $1 (got '$2', want '$3')"; fi
|
||||
}
|
||||
|
||||
scan() { python3 -B "$SCAN" "$@"; }
|
||||
|
||||
# edit <file> <sed-expr>: in-place edit without sed -i (BSD/GNU portable).
|
||||
edit() { sed "$2" "$1" > "$1.new" && mv "$1.new" "$1"; }
|
||||
|
||||
has() { # has <SEVERITY> <RULE>: the last scan raised it
|
||||
printf '%s\n' "$LAST_OUT" | grep -Eq "^ +$1 +$2 " && echo yes || echo no
|
||||
}
|
||||
|
||||
mutant() { # mutant <label> <SEVERITY> <RULE> <snippet run inside a copy>
|
||||
local label="$1" sev="$2" rule="$3" snippet="$4" dir
|
||||
dir="$WORK/$label"
|
||||
cp -R "$GOOD" "$dir" || { check "$label copy" failed ok; return; }
|
||||
if ! ( cd "$dir" && eval "$snippet" ) >/dev/null 2>&1; then
|
||||
check "$label setup" failed ok; return
|
||||
fi
|
||||
LAST_OUT=$(scan "$dir"); LAST_RC=$?
|
||||
check "$label raises $sev $rule" "$(has "$sev" "$rule")" yes
|
||||
}
|
||||
|
||||
benign() { # benign <label> <snippet>: a legitimate pattern raises nothing
|
||||
local label="$1" snippet="$2" dir="$WORK/$1" out
|
||||
cp -R "$GOOD" "$dir" || { check "$label copy" failed ok; return; }
|
||||
if ! ( cd "$dir" && eval "$snippet" ) >/dev/null 2>&1; then
|
||||
check "$label setup" failed ok; return
|
||||
fi
|
||||
out=$(scan "$dir")
|
||||
check "$label raises no FAIL or WARN" \
|
||||
"$(printf '%s\n' "$out" | grep -c ' 0 FAIL, 0 WARN')" 1
|
||||
}
|
||||
|
||||
TSX=src/components/ContactForm.tsx
|
||||
|
||||
echo "== clean fixture"
|
||||
out=$(scan "$GOOD"); rc=$?
|
||||
check "clean exit code" "$rc" 0
|
||||
check "clean has no FAIL or WARN" \
|
||||
"$(printf '%s\n' "$out" | grep -c ' 0 FAIL, 0 WARN')" 1
|
||||
check "report is titled a11y" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^a11y scan: ')" 1
|
||||
|
||||
echo "== rules"
|
||||
mutant img-alt FAIL A11Y-IMG-ALT "edit $TSX 's/ alt=\"Company logo\"//'"
|
||||
mutant field-label FAIL A11Y-FIELD-LABEL "edit $TSX '/<label htmlFor=\"email\">/d'"
|
||||
mutant click-keyboard FAIL A11Y-CLICK-NO-KEYBOARD "edit $TSX 's/ onKeyDown={go}//'"
|
||||
mutant tabindex-positive WARN A11Y-TABINDEX-POSITIVE \
|
||||
"edit $TSX 's/tabIndex={0}/tabIndex={2}/'"
|
||||
mutant focus-css-warn WARN A11Y-FOCUS-OUTLINE \
|
||||
"printf 'a:focus { outline: none; }\n' > src/styles.css"
|
||||
mutant focus-css-fail FAIL A11Y-FOCUS-OUTLINE \
|
||||
"printf 'a:focus { outline: none; }\n' > src/styles.css; edit $TSX 's/outline-none focus-visible:ring-2 focus-visible:ring-blue-500/x/'"
|
||||
mutant focus-tailwind FAIL A11Y-FOCUS-OUTLINE \
|
||||
"edit $TSX 's/outline-none focus-visible:ring-2 focus-visible:ring-blue-500/outline-none/'"
|
||||
|
||||
echo "== benign patterns stay silent"
|
||||
benign comment-with-img-tag \
|
||||
"printf '%s\n' '// the <img> below is decorative' >> $TSX"
|
||||
benign dialog-overlay-click \
|
||||
"printf '%s\n' '<div role=\"dialog\" aria-label=\"x\" onClick={go}>y</div>' >> $TSX"
|
||||
|
||||
echo "== check modes (contract oracle and re-pass baseline)"
|
||||
IMG="A11Y-IMG-ALT:$TSX"
|
||||
cp -R "$GOOD" "$WORK/cm"; edit "$WORK/cm/$TSX" 's/ alt="Company logo"//'
|
||||
out=$(scan "$WORK/cm" --assert-absent "$IMG"); rc=$?
|
||||
check "positive control: the oracle fails while the hit is there" "$rc" 1
|
||||
check "a failing oracle never prints the marker" \
|
||||
"$(printf '%s\n' "$out" | grep -c A11Y-CLEAR)" 0
|
||||
out=$(scan "$GOOD" --assert-absent "$IMG"); rc=$?
|
||||
check "the oracle passes once the hit is gone" "$rc" 0
|
||||
check "a passing oracle prints the marker" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^A11Y-CLEAR 1$')" 1
|
||||
scan "$GOOD" --assert-absent "HOST-NO-RATE-LIMIT:$TSX" >/dev/null 2>&1
|
||||
check "a guardrails rule is unknown here (exit 2)" "$?" 2
|
||||
scan "$WORK/cm" --json > "$WORK/cm-before.json"
|
||||
out=$(scan "$GOOD" --baseline "$WORK/cm-before.json"); rc=$?
|
||||
check "baseline lists the fixed hit" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^ FIXED A11Y-IMG-ALT ')" 1
|
||||
check "baseline with no new hit exits 0 with the marker" \
|
||||
"$rc:$(printf '%s\n' "$out" | grep -c '^A11Y-NO-NEW$')" "0:1"
|
||||
scan "$GOOD" --json > "$WORK/clean-before.json"
|
||||
out=$(scan "$WORK/cm" --baseline "$WORK/clean-before.json"); rc=$?
|
||||
check "baseline with a new hit exits 1 without the marker" \
|
||||
"$rc:$(printf '%s\n' "$out" | grep -c A11Y-NO-NEW)" "1:0"
|
||||
|
||||
# contract <dir> <file>: a fix contract whose oracle is the scanner itself
|
||||
contract() {
|
||||
cat > "$2" <<EOC
|
||||
# CONTRACT — a11y-oracle-test
|
||||
## ACCEPTANCE CRITERIA
|
||||
1. every image in the contact form has an alt
|
||||
CHECK: python3 -B '$SCAN' '$1' --assert-absent '$IMG'
|
||||
EXPECT: A11Y-CLEAR
|
||||
EVIDENCE: pending
|
||||
## FILE SCOPE
|
||||
$TSX
|
||||
EOC
|
||||
}
|
||||
contract "$WORK/cm" "$WORK/c-unfixed.md"
|
||||
bash "$ROOT/lib/gates.sh" run "$WORK/c-unfixed.md" >/dev/null 2>&1
|
||||
check "gates.sh: the oracle is UNMET before the fix" "$?" 2
|
||||
contract "$GOOD" "$WORK/c-fixed.md"
|
||||
bash "$ROOT/lib/gates.sh" run "$WORK/c-fixed.md" >/dev/null 2>&1
|
||||
check "gates.sh: the oracle is MET after the fix" "$?" 0
|
||||
|
||||
echo "== cli"
|
||||
scan --domain api "$GOOD" >/dev/null 2>&1; check "a guardrails domain exits 2" "$?" 2
|
||||
|
||||
echo "---"
|
||||
echo "passed: $PASS failed: $FAIL"
|
||||
[ "$FAIL" -eq 0 ]
|
||||
@@ -0,0 +1,31 @@
|
||||
export function ContactForm({ go }: { go: () => void }) {
|
||||
return (
|
||||
<form>
|
||||
<label htmlFor="email">Email</label>
|
||||
<input id="email" type="email" />
|
||||
<label>
|
||||
Message
|
||||
<textarea name="msg" />
|
||||
</label>
|
||||
<input type="hidden" name="token" value="x" />
|
||||
<img src="/logo.png" alt="Company logo" />
|
||||
<img src="/divider.png" alt="" />
|
||||
<button
|
||||
type="submit"
|
||||
className="btn outline-none focus-visible:ring-2 focus-visible:ring-blue-500"
|
||||
>
|
||||
Send
|
||||
</button>
|
||||
<div role="button" tabIndex={0} onClick={go} onKeyDown={go}>
|
||||
Open
|
||||
</div>
|
||||
<div role="presentation" onClick={go}>
|
||||
<div role="dialog" aria-modal="true" onClick={(e) => e.stopPropagation()}>
|
||||
Dialog
|
||||
</div>
|
||||
</div>
|
||||
<input type="file" className="hidden" />
|
||||
<div className="backdrop" onClick={go} />
|
||||
</form>
|
||||
);
|
||||
}
|
||||
Vendored
File renamed without changes.
@@ -59,6 +59,7 @@ out=$(scan "$GOOD"); rc=$?
|
||||
check "clean exit code" "$rc" 0
|
||||
check "clean has no FAIL or WARN" \
|
||||
"$(printf '%s\n' "$out" | grep -c ' 0 FAIL, 0 WARN')" 1
|
||||
check "a11y is not scanned" "$(printf '%s\n' "$out" | grep -c '^\[a11y\]')" 0
|
||||
|
||||
echo "== supabase"
|
||||
mutant rls-missing FAIL SB-RLS-MISSING \
|
||||
@@ -135,19 +136,6 @@ mutant no-rate-limit FAIL HOST-NO-RATE-LIMIT "rm src/middleware.ts"
|
||||
mutant origin-exposed WARN HOST-ORIGIN-EXPOSED \
|
||||
"printf 'app = \"x\"\n' > fly.toml; edit docs/DEPLOY.md 's/Cloudflare/an edge proxy/'"
|
||||
|
||||
echo "== a11y"
|
||||
mutant img-alt FAIL A11Y-IMG-ALT "edit $TSX 's/ alt=\"Company logo\"//'"
|
||||
mutant field-label FAIL A11Y-FIELD-LABEL "edit $TSX '/<label htmlFor=\"email\">/d'"
|
||||
mutant click-keyboard FAIL A11Y-CLICK-NO-KEYBOARD "edit $TSX 's/ onKeyDown={go}//'"
|
||||
mutant tabindex-positive WARN A11Y-TABINDEX-POSITIVE \
|
||||
"edit $TSX 's/tabIndex={0}/tabIndex={2}/'"
|
||||
mutant focus-css-warn WARN A11Y-FOCUS-OUTLINE \
|
||||
"printf 'a:focus { outline: none; }\n' > src/styles.css"
|
||||
mutant focus-css-fail FAIL A11Y-FOCUS-OUTLINE \
|
||||
"printf 'a:focus { outline: none; }\n' > src/styles.css; edit $TSX 's/outline-none focus-visible:ring-2 focus-visible:ring-blue-500/x/'"
|
||||
mutant focus-tailwind FAIL A11Y-FOCUS-OUTLINE \
|
||||
"edit $TSX 's/outline-none focus-visible:ring-2 focus-visible:ring-blue-500/outline-none/'"
|
||||
|
||||
echo "== messaging"
|
||||
mutant no-consent FAIL MSG-NO-CONSENT-RECORD \
|
||||
"for f in $SQL $NOTIFY $SMS; do edit \$f 's/consent_at/seen_at/g;s/consent_source/seen_src/g'; done"
|
||||
@@ -253,10 +241,6 @@ benign() { # benign <label> <snippet>: a legitimate pattern raises nothing
|
||||
check "$label raises no FAIL or WARN" \
|
||||
"$(printf '%s\n' "$out" | grep -c ' 0 FAIL, 0 WARN')" 1
|
||||
}
|
||||
benign comment-with-img-tag \
|
||||
"printf '%s\n' '// the <img> below is decorative' >> $TSX"
|
||||
benign dialog-overlay-click \
|
||||
"printf '%s\n' '<div role=\"dialog\" aria-label=\"x\" onClick={go}>y</div>' >> $TSX"
|
||||
benign helper-under-api \
|
||||
"mkdir -p src/pages/api/helpers; printf '%s\n' 'export const fmt = () => 1;' > src/pages/api/helpers/format.ts"
|
||||
benign mailer-test-file \
|
||||
@@ -394,37 +378,37 @@ check "a subscribers table makes the same senders fail" \
|
||||
"$(has FAIL MSG-NO-CONSENT-RECORD)" yes
|
||||
|
||||
echo "== check modes (contract oracle and re-pass baseline)"
|
||||
IMG="A11Y-IMG-ALT:$TSX"
|
||||
cp -R "$GOOD" "$WORK/cm"; edit "$WORK/cm/$TSX" 's/ alt="Company logo"//'
|
||||
out=$(scan "$WORK/cm" --assert-absent "$IMG"); rc=$?
|
||||
INJ="INJ-SQL-CONCAT:$API"
|
||||
cp -R "$GOOD" "$WORK/cm"; printf '%s\n' 'const q = `select id from notes where owner = ${owner}`;' >> "$WORK/cm/$API"
|
||||
out=$(scan "$WORK/cm" --assert-absent "$INJ"); rc=$?
|
||||
check "positive control: the oracle fails while the hit is there" "$rc" 1
|
||||
check "a failing oracle never prints the marker" \
|
||||
"$(printf '%s\n' "$out" | grep -c GUARDRAILS-CLEAR)" 0
|
||||
out=$(scan "$GOOD" --assert-absent "$IMG"); rc=$?
|
||||
out=$(scan "$GOOD" --assert-absent "$INJ"); rc=$?
|
||||
check "the oracle passes once the hit is gone" "$rc" 0
|
||||
check "a passing oracle prints the marker" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^GUARDRAILS-CLEAR 1$')" 1
|
||||
out=$(scan "$GOOD" --domain api --assert-absent "$IMG"); rc=$?
|
||||
out=$(scan "$GOOD" --domain api --assert-absent "$INJ"); rc=$?
|
||||
check "an unscanned domain proves nothing" "$rc" 1
|
||||
check "the control failure is named" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^ CONTROL ')" 1
|
||||
mkdir "$WORK/cm-empty"
|
||||
scan "$WORK/cm-empty" --assert-absent "$IMG" >/dev/null
|
||||
scan "$WORK/cm-empty" --assert-absent "$INJ" >/dev/null
|
||||
check "an empty tree proves nothing" "$?" 1
|
||||
scan "$GOOD" --assert-absent HOST-SPEND-CAP:. >/dev/null 2>&1
|
||||
check "a MANUAL rule cannot be asserted (exit 2)" "$?" 2
|
||||
scan "$GOOD" --assert-absent A11Y-IMG-ALT >/dev/null 2>&1
|
||||
scan "$GOOD" --assert-absent INJ-SQL-CONCAT >/dev/null 2>&1
|
||||
check "an item without a path is a usage error" "$?" 2
|
||||
scan "$WORK/cm" --json > "$WORK/cm-before.json"
|
||||
out=$(scan "$GOOD" --baseline "$WORK/cm-before.json"); rc=$?
|
||||
check "baseline lists the fixed hit" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^ FIXED A11Y-IMG-ALT ')" 1
|
||||
"$(printf '%s\n' "$out" | grep -c '^ FIXED INJ-SQL-CONCAT ')" 1
|
||||
check "baseline with no new hit exits 0 with the marker" \
|
||||
"$rc:$(printf '%s\n' "$out" | grep -c '^GUARDRAILS-NO-NEW$')" "0:1"
|
||||
scan "$GOOD" --json > "$WORK/clean-before.json"
|
||||
out=$(scan "$WORK/cm" --baseline "$WORK/clean-before.json"); rc=$?
|
||||
check "baseline lists a new hit" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^ NEW A11Y-IMG-ALT ')" 1
|
||||
"$(printf '%s\n' "$out" | grep -c '^ NEW INJ-SQL-CONCAT ')" 1
|
||||
check "baseline with a new hit exits 1 without the marker" \
|
||||
"$rc:$(printf '%s\n' "$out" | grep -c GUARDRAILS-NO-NEW)" "1:0"
|
||||
printf 'not json' > "$WORK/bad.json"
|
||||
@@ -436,12 +420,12 @@ contract() {
|
||||
cat > "$2" <<EOF
|
||||
# CONTRACT — guardrails-oracle-test
|
||||
## ACCEPTANCE CRITERIA
|
||||
1. every image in the contact form has an alt
|
||||
CHECK: python3 -B '$SCAN' '$1' --assert-absent '$IMG'
|
||||
1. no SQL built from input in the notes route
|
||||
CHECK: python3 -B '$SCAN' '$1' --assert-absent '$INJ'
|
||||
EXPECT: GUARDRAILS-CLEAR
|
||||
EVIDENCE: pending
|
||||
## FILE SCOPE
|
||||
$TSX
|
||||
$API
|
||||
EOF
|
||||
}
|
||||
contract "$WORK/cm" "$WORK/c-unfixed.md"
|
||||
@@ -456,17 +440,18 @@ check "gates.sh writes the evidence back" \
|
||||
echo "== cli"
|
||||
scan "$WORK/does-not-exist" >/dev/null 2>&1; check "bad path exits 2" "$?" 2
|
||||
scan --domain nope "$GOOD" >/dev/null 2>&1; check "bad domain exits 2" "$?" 2
|
||||
scan --domain a11y "$GOOD" >/dev/null 2>&1; check "a11y is no longer a guardrails domain (exit 2)" "$?" 2
|
||||
check "json is valid and counts FAIL" \
|
||||
"$(scan --json "$GOOD" | python3 -B -c 'import json,sys; print(json.load(sys.stdin)["summary"]["FAIL"])')" 0
|
||||
out=$(scan --domain a11y "$GOOD")
|
||||
check "domain filter keeps a11y" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^\[a11y\]')" 1
|
||||
out=$(scan --domain injection "$GOOD")
|
||||
check "domain filter keeps injection" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^\[injection\]')" 1
|
||||
check "domain filter drops supabase" \
|
||||
"$(printf '%s\n' "$out" | grep -c '^\[supabase\]')" 0
|
||||
cp -R "$GOOD" "$WORK/excl"
|
||||
edit "$WORK/excl/$TSX" 's/ alt="Company logo"//'
|
||||
printf '%s\n' 'const q = `select id from notes where owner = ${owner}`;' >> "$WORK/excl/$API"
|
||||
scan "$WORK/excl" >/dev/null 2>&1; check "mutated copy fails" "$?" 1
|
||||
scan --exclude src/components "$WORK/excl" >/dev/null 2>&1
|
||||
scan --exclude src/pages "$WORK/excl" >/dev/null 2>&1
|
||||
check "--exclude drops the finding" "$?" 0
|
||||
mkdir "$WORK/empty"
|
||||
out=$(scan "$WORK/empty")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
import re
|
||||
from collections import namedtuple
|
||||
|
||||
from .common import Rule, blank_markup_comments
|
||||
from checks.common import Rule, blank_markup_comments
|
||||
|
||||
DOMAIN = "a11y"
|
||||
MARKUP_EXTS = (".html", ".htm", ".jsx", ".tsx", ".vue", ".svelte", ".astro")
|
||||
@@ -0,0 +1,28 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Static accessibility scan: keyboard, visible focus, alt text, labels.
|
||||
|
||||
Runs the guardrails scan engine (skills/guardrails/scripts/scanner.py) on
|
||||
the a11y catalogue. Same options and exit codes; markers A11Y-CLEAR and
|
||||
A11Y-NO-NEW.
|
||||
"""
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
ENGINE = Path(__file__).resolve().parents[2] / "guardrails" / "scripts"
|
||||
if not ENGINE.is_dir():
|
||||
print(f"usage error: scan engine missing at {ENGINE} "
|
||||
"(the guardrails skill must be installed)", file=sys.stderr)
|
||||
sys.exit(2)
|
||||
sys.path.insert(0, str(ENGINE))
|
||||
|
||||
import scanner # noqa: E402
|
||||
import a11y_checks # noqa: E402
|
||||
|
||||
CATALOGUE = scanner.Catalogue(
|
||||
name="a11y",
|
||||
domains={"a11y": a11y_checks},
|
||||
rule_domains={"A11Y": "a11y"},
|
||||
)
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(scanner.main(sys.argv[1:], CATALOGUE))
|
||||
@@ -1,5 +1,6 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Static guardrails scan: the guardrails catalogue on the shared engine.
|
||||
"""Static guardrails scan: API, hosting, Supabase, messaging, functions,
|
||||
injection, exposure.
|
||||
|
||||
See scanner.py for the modes and exit codes.
|
||||
"""
|
||||
@@ -7,7 +8,7 @@ import sys
|
||||
|
||||
import scanner
|
||||
from checks import (
|
||||
a11y, apis, exposure, functions, hosting, injection, messaging, supabase,
|
||||
apis, exposure, functions, hosting, injection, messaging, supabase,
|
||||
)
|
||||
|
||||
CATALOGUE = scanner.Catalogue(
|
||||
@@ -15,7 +16,6 @@ CATALOGUE = scanner.Catalogue(
|
||||
domains={
|
||||
"api": apis,
|
||||
"hosting": hosting,
|
||||
"a11y": a11y,
|
||||
"supabase": supabase,
|
||||
"messaging": messaging,
|
||||
"functions": functions,
|
||||
@@ -23,7 +23,7 @@ CATALOGUE = scanner.Catalogue(
|
||||
"exposure": exposure,
|
||||
},
|
||||
rule_domains={
|
||||
"API": "api", "HOST": "hosting", "A11Y": "a11y", "SB": "supabase",
|
||||
"API": "api", "HOST": "hosting", "SB": "supabase",
|
||||
"MSG": "messaging", "FN": "functions",
|
||||
"INJ": "injection", "EXP": "exposure",
|
||||
},
|
||||
|
||||
Reference in new issue
Block a user