AtlatestRepositorysigil-doc

sigil-doc / tree / testgate-d6.sh

1#!/usr/bin/env bash
2set -euo pipefail
3
4repo_dir="$(cd "$(dirname "$0")/.." && pwd)"
5cd "$repo_dir"
6sigil="${SIGIL_D1_COMPILER:-$repo_dir/../task-sigil-language-readers/build/dev/bin/sigil}"
7redirects="${SIGIL_D1_REDIRECTS:-$repo_dir/dev-redirects.sgl}"
8sigil_sxml_root="${SIGIL_SXML_ROOT:-$repo_dir/../sigil-sxml}"
9typst_bin="${TYPST_BIN:-typst}"
10pdfinfo_bin="${PDFINFO_BIN:-pdfinfo}"
11pdftotext_bin="${PDFTOTEXT_BIN:-pdftotext}"
12pdftoppm_bin="${PDFTOPPM_BIN:-pdftoppm}"
13qpdf_bin="${QPDF_BIN:-qpdf}"
14convert_bin="${CONVERT_BIN:-convert}"
15sha256sum_bin="${SHA256SUM_BIN:-sha256sum}"
16mkdir -p "$repo_dir/build"
17gate_dir="$(mktemp -d "$repo_dir/build/d6-gate.XXXXXX")"
18export XDG_CACHE_HOME="$gate_dir/cache"
19export SIGIL_REDIRECTS="$redirects"
20export SIGIL_D1_COMPILER="$sigil"
21export SIGIL_BYTECODE_BASE="${SIGIL_BYTECODE_BASE:-$(test/build-d3-bytecode-base.sh)}"
22export SOURCE_DATE_EPOCH=0
24for tool in "$typst_bin" "$pdfinfo_bin" "$pdftotext_bin" "$pdftoppm_bin" \
25 "$qpdf_bin" "$convert_bin" "$sha256sum_bin"; do
26 command -v "$tool" >/dev/null
27done
28"$typst_bin" --version | tee "$gate_dir/toolchain.txt"
29"$pdfinfo_bin" -v 2>&1 | head -1 | tee -a "$gate_dir/toolchain.txt"
30"$qpdf_bin" --version | head -1 | tee -a "$gate_dir/toolchain.txt"
31echo D6_GATE_01_PINNED_EXISTING_TOOLCHAIN
33"$sigil" -L "$sigil_sxml_root/src" -L src test test/test-print.sgl --report \
34 | tee "$gate_dir/print-tests.txt"
35rg -q '5 passed' "$gate_dir/print-tests.txt"
36echo D6_GATE_02_NEUTRAL_ADAPTER_PASSIVITY_HIGHLIGHTING_5_5
38generate_book() {
39 local stem="$1"
40 "$sigil" -L src -L book tools/build-practical-sigil-print.sgl "$gate_dir/$stem.typ"
41 "$typst_bin" compile --root "$repo_dir" --creation-timestamp 0 --pdf-standard a-2b \
42 --jobs 1 "$gate_dir/$stem.typ" "$gate_dir/$stem.pdf"
44generate_book practical-a
45generate_book practical-b
46cmp "$gate_dir/practical-a.typ" "$gate_dir/practical-b.typ"
47cmp "$gate_dir/practical-a.pdf" "$gate_dir/practical-b.pdf"
48"$sha256sum_bin" "$gate_dir/practical-a.typ" "$gate_dir/practical-b.typ" \
49 "$gate_dir/practical-a.pdf" "$gate_dir/practical-b.pdf" | tee "$gate_dir/reproducible-hashes.txt"
50echo D6_GATE_03_REPRODUCIBLE_SOURCE_AND_PDF_BYTES
52"$sigil" -L src test/build-d6-change-control.sgl "$gate_dir/changed.typ"
53"$typst_bin" compile --root "$repo_dir" --creation-timestamp 0 --pdf-standard a-2b \
54 --jobs 1 "$gate_dir/changed.typ" "$gate_dir/changed.pdf"
55# Change-control assertions must be `if cmp; then fail`, never a bare `! cmp`
56# -- bash exempts `!`-inverted commands from `set -e`, so the bare form could
57# never fail: a build that IGNORED its input would have passed (inert 2026-08-24).
58if cmp -s "$gate_dir/practical-a.typ" "$gate_dir/changed.typ"; then
59 echo 'D6 change control: changed input produced an IDENTICAL .typ' >&2
60 exit 1
61fi
62if cmp -s "$gate_dir/practical-a.pdf" "$gate_dir/changed.pdf"; then
63 echo 'D6 change control: changed input produced an IDENTICAL .pdf' >&2
64 exit 1
65fi
66"$pdftotext_bin" "$gate_dir/changed.pdf" "$gate_dir/changed.txt"
67rg -q 'D6 changed-content witness 7391' "$gate_dir/changed.txt"
68echo D6_GATE_03B_CONTENT_CHANGE_INVALIDATES_SOURCE_AND_PDF
70"$pdfinfo_bin" "$gate_dir/practical-a.pdf" >"$gate_dir/pdfinfo.txt"
71"$qpdf_bin" --check "$gate_dir/practical-a.pdf" >"$gate_dir/qpdf-check.txt" 2>&1
72"$qpdf_bin" --json-key=outlines --json "$gate_dir/practical-a.pdf" >"$gate_dir/outlines.json"
73"$pdftotext_bin" -layout "$gate_dir/practical-a.pdf" "$gate_dir/practical.txt"
74rg -q '^Title:[[:space:]]+Practical Sigil$' "$gate_dir/pdfinfo.txt"
75rg -q '^Author:[[:space:]]+David Wilson$' "$gate_dir/pdfinfo.txt"
76rg -q '^Tagged:[[:space:]]+yes$' "$gate_dir/pdfinfo.txt"
77rg -q '^JavaScript:[[:space:]]+no$' "$gate_dir/pdfinfo.txt"
78rg -q 'A Useful First Script' "$gate_dir/outlines.json"
79rg -q 'Change the Question' "$gate_dir/outlines.json"
80rg -q 'Begin with a Question' "$gate_dir/outlines.json"
81rg -q 'A Useful First Script \(page 3\)' "$gate_dir/practical.txt"
82rg -q '\(string-starts-with\? line' "$gate_dir/practical.txt"
83rg -q 'Exercise: Craft a helpful failure' "$gate_dir/practical.txt"
84rg -q '^[[:space:]]*4[[:space:]]*$' "$gate_dir/practical.txt"
85echo D6_GATE_04_METADATA_BOOKMARKS_XREFS_PAGES_SEARCHABLE_TEXT
87error_xdg="$gate_dir/error-cache"
88for id in stdout expected-error; do
89 XDG_CACHE_HOME="$error_xdg" SIGIL_BIN="$sigil" \
90 "$sigil" -L src -L test tools/sigil-doc-verify.sgl test/fixtures/d3-examples.sgd \
91 --example "$id" | tee "$gate_dir/$id-verification.txt"
92done
93rg -q 'stdout: verified' "$gate_dir/stdout-verification.txt"
94rg -q 'expected-error: verified' "$gate_dir/expected-error-verification.txt"
95D6_VERIFY_CACHE="$error_xdg/sigil-doc/verify-v1" \
96"$sigil" -L src -L test test/build-d6-pressure.sgl "$gate_dir/pressure.typ"
97test -s "$gate_dir/pressure.typ"
98"$typst_bin" compile --root "$repo_dir" --creation-timestamp 0 --pdf-standard a-2b \
99 --jobs 1 "$gate_dir/pressure.typ" "$gate_dir/pressure.pdf"
100"$pdftotext_bin" -layout "$gate_dir/pressure.pdf" "$gate_dir/pressure.txt"
101rg -q 'Example: stdout' "$gate_dir/pressure.txt"
102rg -q '^Verified$' "$gate_dir/pressure.txt"
103rg -q 'Clean project verified: d3-project' "$gate_dir/pressure.txt"
104rg -q 'project-ok' "$gate_dir/pressure.txt"
105rg -q 'error: expected boom' "$gate_dir/pressure.txt"
106echo D6_GATE_05_EXACT_SPEC_TRUSTED_RESULTS_AND_AUTHENTICATED_ERROR
108"$sigil" -L src test/build-d6-passivity.sgl "$gate_dir/passivity.typ"
109"$typst_bin" compile --root "$repo_dir" --creation-timestamp 0 --pdf-standard a-2b \
110 --jobs 1 "$gate_dir/passivity.typ" "$gate_dir/passivity.pdf"
111test ! -e "$repo_dir/build/d6/owned"
112"$pdftotext_bin" "$gate_dir/passivity.pdf" "$gate_dir/passivity.txt"
113rg -q '#import "https://example.invalid/evil.typ"' "$gate_dir/passivity.txt"
114rg -q '#read\("/etc/passwd"\)' "$gate_dir/passivity.txt"
115rg -q '#write\("build/d6/owned"' "$gate_dir/passivity.txt"
116echo D6_GATE_06_NO_NETWORK_SCRIPT_OR_SUBJECT_EXECUTION
118"$sigil" -L src test/build-d6-longline.sgl "$gate_dir/longline.typ"
119"$typst_bin" compile --root "$repo_dir" --creation-timestamp 0 --pdf-standard a-2b \
120 --jobs 1 "$gate_dir/longline.typ" "$gate_dir/longline.pdf"
121"$pdftotext_bin" -layout "$gate_dir/longline.pdf" "$gate_dir/longline.txt"
122"$pdftotext_bin" -bbox "$gate_dir/longline.pdf" "$gate_dir/longline-bbox.html"
123rg -q "$(printf 'x%.0s' {1..88})" "$gate_dir/longline.txt"
124awk '/<word / {
125 line=$0; sub(/^.*xMin="/, "", line); split(line,a,"\""); xmin=a[1]+0
126 line=$0; sub(/^.*xMax="/, "", line); split(line,a,"\""); xmax=a[1]+0
127 line=$0; sub(/^.*yMin="/, "", line); split(line,a,"\""); ymin=a[1]+0
128 line=$0; sub(/^.*yMax="/, "", line); split(line,a,"\""); ymax=a[1]+0
129 if (xmin < 0 || xmax > 612 || ymin < 0 || ymax > 792) bad=1
130} END { exit bad }' "$gate_dir/longline-bbox.html"
131"$pdftoppm_bin" -f 3 -l 3 -singlefile -png -r 120 "$gate_dir/longline.pdf" "$gate_dir/longline-code-page"
132"$pdftoppm_bin" -png -r 100 "$gate_dir/practical-a.pdf" "$gate_dir/practical-page"
133test -s "$gate_dir/longline-code-page.png"
134test -s "$gate_dir/practical-page-3.png"
135test -s "$gate_dir/practical-page-4.png"
136echo D6_GATE_07_OVERLONG_CODE_WRAPPED_BBOX_AND_RASTERS
138"$sigil" -L src test/build-d6-highlight.sgl "$gate_dir/highlight.typ"
139"$typst_bin" compile --root "$repo_dir" --creation-timestamp 0 --pdf-standard a-2b \
140 --jobs 1 "$gate_dir/highlight.typ" "$gate_dir/highlight.pdf"
141"$pdftotext_bin" -layout "$gate_dir/highlight.pdf" "$gate_dir/highlight.txt"
142rg -q '; comment color witness' "$gate_dir/highlight.txt"
143rg -q 'define message "string color witness"' "$gate_dir/highlight.txt"
144rg -q 'if #t 7391 0' "$gate_dir/highlight.txt"
145"$pdftoppm_bin" -f 3 -l 3 -singlefile -png -r 160 "$gate_dir/highlight.pdf" "$gate_dir/highlight-page"
146"$convert_bin" "$gate_dir/highlight-page.png" -format %c histogram:info:- >"$gate_dir/highlight-histogram.txt"
147rg -qi '#6A737D' "$gate_dir/highlight-histogram.txt"
148rg -qi '#9C442E' "$gate_dir/highlight-histogram.txt"
149rg -qi '#6F42C1' "$gate_dir/highlight-histogram.txt"
150rg -qi '#1F6F8B' "$gate_dir/highlight-histogram.txt"
151echo D6_GATE_07B_OFFLINE_HIGHLIGHT_COPYABLE_AND_RASTER_COLORS
153# The print adapter owns neither Press routing nor any typesetter implementation.
154# Subject-existence pins: to `if rg`, a missing file (exit 2) reads as clean.
155test -f src/sigil/doc/print.sgl
156test -f src/sigil/doc/render/typst.sgl
157if rg -n -i 'press|site-nav|sitemap|robots\.txt|<html|write-pdf|line-break|font-shap|paginate' \
158 src/sigil/doc/print.sgl src/sigil/doc/render/typst.sgl; then
159 echo 'D6 boundary violation' >&2
160 exit 1
161fi
162echo D6_GATE_08_PRESS_AND_TYPESETTING_BOUNDARY
164bash test/gate-d0.sh >"$gate_dir/d0.txt"
165bash test/gate-d1.sh >"$gate_dir/d1.txt"
166bash test/gate-d2.sh >"$gate_dir/d2.txt"
167bash test/gate-d3.sh >"$gate_dir/d3.txt"
168bash test/gate-d4a.sh >"$gate_dir/d4a.txt"
169rg -q D0_GATE_GREEN "$gate_dir/d0.txt"
170rg -q D1_GATE_GREEN "$gate_dir/d1.txt"
171rg -q D2_REAL_LANGUAGE_GREEN "$gate_dir/d2.txt"
172rg -q D3_GATE_GREEN "$gate_dir/d3.txt"
173rg -q D4A_GATE_GREEN "$gate_dir/d4a.txt"
174echo D6_GATE_09_D0_D4_REGRESSIONS_GREEN
176printf 'D6_GATE_GREEN artifacts=%s\n' "$gate_dir"