Tests: Add Distiller test variant

terryburton · terryburton · commit 1c8fdceee480 · 2026-07-07T19:27:18.000+01:00
Run the test suite against Adobe Acrobat Distiller. run.ps1 executes each test file in its own Distiller invocation and classifies its log; fontalias.ps maps the base-14 font names to the host equivalents; assemble-distiller.sh builds a portable Distiller tree from a licensed, checksum-verified Acrobat archive the user supplies; remote.sh provisions a Windows host and drives the run. No Adobe binaries are included.
diff --git a/tests/distiller_tests/README.md b/tests/distiller_tests/README.md
@@ -0,0 +1,61 @@
+# Distiller test variant
+
+Run the BWIPP test suite against Adobe Acrobat Distiller.
+
+## Requirements
+
+- `acrodist.exe` from an Acrobat install, or a portable tree built by
+  `assemble-distiller.sh` below. Not included here; supply your own licensed
+  copy.
+- `build/monolithic/barcode.ps` (`make monolithic`).
+- Windows with PowerShell.
+
+## Build a portable Distiller
+
+`assemble-distiller.sh` builds a self-contained Distiller tree from an Acrobat
+archive you are licensed to use. Requires `7z`, `unshield`, `sha256sum`.
+
+One archive known to work is the Internet Archive item `adobe-acrobat-5.0.1.7z`
+(148,758,180 bytes, example SHA-256
+`446c06ae42c4d71d0298188ad2587178708b58a0e04545efb4035078ec1b2477`; override
+`EXPECT_SHA256` for a different archive):
+
+```sh
+curl -fLo 'Adobe Acrobat 5.0.1.7z' \
+  https://archive.org/download/adobe-acrobat-5.0.1.7z/Adobe%20Acrobat%205.0.1.7z
+tests/distiller_tests/assemble-distiller.sh 'Adobe Acrobat 5.0.1.7z' ./out
+# -> ./out/Distiller/
+```
+
+## Run
+
+`barcode.ps` must be built where the toolchain is (Ghostscript, Perl, make) —
+typically not the Windows host — and supplied to the runner.
+
+From a POSIX shell, which builds it and pushes it with the harness, provisions
+the host from `DIST_SRC`, runs, and relays the exit code (the host must be
+reachable over SSH with PowerShell as its default shell):
+
+```sh
+make -j "$(nproc)" monolithic
+HOST=user@winhost DIST_SRC=./out/Distiller tests/distiller_tests/remote.sh
+```
+
+Or directly on the Windows host, once a built `barcode.ps` has been copied over:
+
+```powershell
+pwsh tests/distiller_tests/run.ps1 `
+  -Distiller C:\path\to\Distiller\acrodist.exe `
+  -Monolithic C:\path\to\barcode.ps
+```
+
+| `run.ps1` parameter | Default          | Purpose                          |
+|---------------------|------------------|----------------------------------|
+| `-Distiller`        | `$env:ACRODIST`  | path to `acrodist.exe`            |
+| `-Monolithic`       | repo build path  | built `barcode.ps`                |
+| `-Timeout`          | `900`            | per-file timeout in seconds       |
+| `-Skip`             | *(empty)*        | test names to skip                |
+| `-Filter`           | `*`              | restrict to matching test names   |
+
+Prints `PASS`/`FAIL`/`SKIP` per file with a summary, and exits non-zero on
+failure.
diff --git a/tests/distiller_tests/assemble-distiller.sh b/tests/distiller_tests/assemble-distiller.sh
@@ -0,0 +1,96 @@
+#!/bin/bash
+
+# Barcode Writer in Pure PostScript
+# https://bwipp.terryburton.co.uk
+#
+# Copyright (c) 2004-2026 Terry Burton
+#
+#
+# Build a portable Adobe Distiller tree from an Acrobat archive you are
+# licensed to use, for use with run.ps1. Verifies the archive, extracts its
+# InstallShield cabinet, and assembles <output-dir>/Distiller/. Nothing is
+# downloaded.
+#
+#   assemble-distiller.sh <Adobe Acrobat 5.0.1.7z> <output-dir>
+#
+# One archive known to work is the Internet Archive item 'adobe-acrobat-5.0.1.7z'
+# (https://archive.org/details/adobe-acrobat-5.0.1.7z). EXPECT_SHA256 below is
+# that archive's checksum; override it for a different archive.
+#
+# Requires: 7z (or 7za), unshield, sha256sum.
+
+set -euo pipefail
+
+ARCHIVE=${1:?usage: assemble-distiller.sh <Adobe Acrobat 5.0.1.7z> <output-dir>}
+OUT=${2:?usage: assemble-distiller.sh <Adobe Acrobat 5.0.1.7z> <output-dir>}
+
+# Example SHA-256 for the archive named in the header; override to verify a
+# different one.
+EXPECT_SHA256=${EXPECT_SHA256:-446c06ae42c4d71d0298188ad2587178708b58a0e04545efb4035078ec1b2477}
+
+sevenzip=$(command -v 7z || command -v 7za || true)
+[ -n "$sevenzip" ] || { echo "error: 7z/7za not found (apt install p7zip-full)" >&2; exit 1; }
+command -v unshield   >/dev/null 2>&1 || { echo "error: unshield not found (apt install unshield)" >&2; exit 1; }
+command -v sha256sum  >/dev/null 2>&1 || { echo "error: sha256sum not found" >&2; exit 1; }
+[ -f "$ARCHIVE" ] || { echo "error: no such archive: $ARCHIVE" >&2; exit 1; }
+
+echo "Verifying $ARCHIVE ..."
+got=$(sha256sum "$ARCHIVE" | cut -d' ' -f1)
+if [ "$got" != "$EXPECT_SHA256" ]; then
+	echo "error: checksum mismatch; refusing to proceed" >&2
+	echo "  expected $EXPECT_SHA256" >&2
+	echo "  got      $got" >&2
+	exit 1
+fi
+
+TMP=$(mktemp -d)
+trap 'rm -rf "$TMP"' EXIT
+
+echo "Extracting installer cabinet ..."
+# The InstallShield cabinet (data1.cab + data1.hdr) lives under BS-ACRO5/.
+"$sevenzip" x -y -o"$TMP" "$ARCHIVE" -r data1.cab data1.hdr >/dev/null
+CAB=$(find "$TMP" -name data1.cab | head -1)
+[ -n "$CAB" ] && [ -f "$(dirname "$CAB")/data1.hdr" ] || {
+	echo "error: data1.cab / data1.hdr not found in archive" >&2; exit 1; }
+
+echo "Assembling Distiller tree ..."
+for g in "Distiller Program Files" "Distiller Win NT System files" \
+         "Distiller Settings English" "Fonts" "PSDisk"; do
+	unshield -g "$g" -d "$TMP/$g" x "$CAB" >/dev/null || {
+		echo "error: could not extract group '$g' (unexpected cabinet contents)" >&2; exit 1; }
+done
+
+D="$OUT/Distiller"
+rm -rf "$D"
+mkdir -p "$D/Font" "$D/Data"
+
+# acrodist.exe + DLLs + Data/ (distinit.ps, DISTSADB.DOS, ...); locate by the
+# binary so we are robust to how unshield names the destination directory.
+pf=$(find "$TMP/Distiller Program Files" -name acrodist.exe -printf '%h\n' | head -1)
+[ -n "$pf" ] || { echo "error: acrodist.exe not present in cabinet" >&2; exit 1; }
+cp -a "$pf/." "$D/"
+
+find "$TMP/Distiller Win NT System files" -name 'PdfPorts.dll' -exec cp {} "$D/" \;
+find "$TMP/Distiller Settings English" -type d -name Settings -exec cp -a {} "$D/" \;
+find "$TMP/Distiller Settings English" -type d -name Startup  -exec cp -a {} "$D/" \;
+find "$TMP/Fonts" -type f -iname '*.pfb' -exec cp {} "$D/Font/" \;
+
+# psdisk resource tree -> Data/psdisk so distinit's relative GenericResourceDir
+# (data/psdisk/Resource/) resolves; Windows resolves Data/ case-insensitively.
+psd=$(find "$TMP/PSDisk" -type d -name psdisk | head -1)
+[ -n "$psd" ] || { echo "error: psdisk resource tree not present in cabinet" >&2; exit 1; }
+cp -a "$psd" "$D/Data/"
+
+# Drop the external CMYK profile the job options reference, so Distiller needs
+# no colour profile installed on the host (which would require elevation).
+for jo in "$D"/Settings/*.joboptions; do
+	sed -i -e 's#/CalCMYKProfile (.*)#/CalCMYKProfile ()#' \
+	       -e 's#/ColorConversionStrategy /[A-Za-z]*#/ColorConversionStrategy /LeaveColorUnchanged#' "$jo"
+done
+
+[ -f "$D/acrodist.exe" ] || { echo "error: assembly incomplete (no acrodist.exe)" >&2; exit 1; }
+
+echo "Assembled portable Distiller at: $D"
+echo "  dlls=$(ls "$D"/*.dll 2>/dev/null | wc -l) fonts=$(ls "$D/Font" 2>/dev/null | wc -l) psdisk=$([ -d "$D/Data/psdisk/Resource" ] && echo yes || echo no)"
+echo
+echo "Next: copy $D onto a Windows host, or let remote.sh provision it."
diff --git a/tests/distiller_tests/fontalias.ps b/tests/distiller_tests/fontalias.ps
diff --git a/tests/distiller_tests/remote.sh b/tests/distiller_tests/remote.sh
@@ -0,0 +1,67 @@
+#!/bin/bash
+
+# Barcode Writer in Pure PostScript
+# https://bwipp.terryburton.co.uk
+#
+# Copyright (c) 2004-2026 Terry Burton
+#
+#
+# Run the Distiller test suite on a remote Windows host from a POSIX shell.
+# Builds the monolithic locally, pushes it with the harness and test files,
+# provisions Distiller when DIST_SRC is given, then invokes run.ps1 remotely
+# and relays its exit code. The host must be reachable over SSH with
+# PowerShell as the default shell.
+#
+#   HOST       user@host                        (required)
+#   ACRODIST   remote path to acrodist.exe       (default: $REMOTE_DIR/Distiller/acrodist.exe)
+#   DIST_SRC   local assembled Distiller dir     (optional; provisions the host when set)
+#   REMOTE_DIR remote staging dir                (default: C:/distiller-suite)
+#   FORCE      re-push Distiller even if present  (default: unset)
+#
+# Extra arguments are forwarded to run.ps1 (e.g. -Filter ean13 -Timeout 120).
+#
+#   HOST=tez@host DIST_SRC=./out/Distiller tests/distiller_tests/remote.sh -Filter ean13
+
+set -euo pipefail
+
+HOST=${HOST:?set HOST=user@host}
+REMOTE_DIR=${REMOTE_DIR:-C:/distiller-suite}
+ACRODIST=${ACRODIST:-$REMOTE_DIR/Distiller/acrodist.exe}
+DIST_SRC=${DIST_SRC:-}
+FORCE=${FORCE:-}
+
+HERE=$(cd "$(dirname "$0")" && pwd)
+ROOT=$(cd "$HERE/../.." && pwd)
+MONO="$ROOT/build/monolithic/barcode.ps"
+PSDIR="$ROOT/tests/ps_tests"
+
+[ -f "$MONO" ] || { echo "error: missing $MONO (run: make monolithic)" >&2; exit 1; }
+
+# Reachability: skip cleanly rather than fail the caller if the host is down.
+if ! ssh -o BatchMode=yes -o ConnectTimeout=10 "$HOST" "exit" >/dev/null 2>&1; then
+	echo "SKIPPED $HOST not reachable over SSH"
+	exit 0
+fi
+
+psh() { ssh -o BatchMode=yes "$HOST" "powershell -NoProfile -ExecutionPolicy Bypass -Command $1"; }
+
+psh "New-Item -ItemType Directory -Force -Path '$REMOTE_DIR/tests/distiller_tests','$REMOTE_DIR/tests/ps_tests' | Out-Null" >/dev/null
+
+# Provision a portable Distiller when a source is supplied and it is absent
+# (or FORCE is set).
+if [ -n "$DIST_SRC" ]; then
+	[ -f "$DIST_SRC/acrodist.exe" ] || { echo "error: $DIST_SRC has no acrodist.exe" >&2; exit 1; }
+	present=$(psh "Test-Path '$ACRODIST'" | tr -d '\r')
+	if [ "$present" != "True" ] || [ -n "$FORCE" ]; then
+		echo "Provisioning Distiller -> $REMOTE_DIR/Distiller"
+		scp -q -o BatchMode=yes -r "$DIST_SRC" "$HOST:$REMOTE_DIR/"
+	fi
+fi
+
+# Push harness, tests and the freshly built monolithic.
+scp -q -o BatchMode=yes "$HERE/run.ps1" "$HERE/fontalias.ps" "$HOST:$REMOTE_DIR/tests/distiller_tests/"
+scp -q -o BatchMode=yes "$PSDIR/test_utils.ps" "$PSDIR"/*.ps.test "$HOST:$REMOTE_DIR/tests/ps_tests/"
+scp -q -o BatchMode=yes "$MONO" "$HOST:$REMOTE_DIR/barcode.ps"
+
+# Invoke and relay stdout + exit code.
+ssh -o BatchMode=yes "$HOST" "powershell -NoProfile -ExecutionPolicy Bypass -File '$REMOTE_DIR/tests/distiller_tests/run.ps1' -Distiller '$ACRODIST' -Monolithic '$REMOTE_DIR/barcode.ps' $*"
diff --git a/tests/distiller_tests/run.ps1 b/tests/distiller_tests/run.ps1
@@ -0,0 +1,109 @@
+# Barcode Writer in Pure PostScript
+# https://bwipp.terryburton.co.uk
+#
+# Copyright (c) 2004-2026 Terry Burton
+#
+#
+# Run the PostScript test suite against Adobe Acrobat Distiller. Each test
+# file runs in its own Distiller invocation since a test failure quits the
+# interpreter. Requires build/monolithic/barcode.ps (make monolithic) and a
+# Distiller install (see README.md).
+#
+#   -Distiller <path>   acrodist.exe (default: $env:ACRODIST)
+#   -Monolithic <path>  built barcode.ps (default: build/monolithic/barcode.ps)
+#   -Timeout <sec>      per-file timeout in seconds (default: 900)
+#   -Skip <names>       space-separated test names to skip
+#   -Filter <glob>      restrict to matching test names (default: *)
+
+param(
+    [string]$Distiller = $env:ACRODIST,
+    [string]$Monolithic = "",
+    [int]$Timeout = 900,
+    [string]$Skip = "",
+    [string]$Filter = "*"
+)
+
+$ErrorActionPreference = "Continue"
+
+$test = $PSScriptRoot
+$root = (Resolve-Path (Join-Path $test "..\..")).Path
+if (-not $Monolithic) { $Monolithic = Join-Path $root "build\monolithic\barcode.ps" }
+$testsdir   = Join-Path $root "tests\ps_tests"
+$testutils  = Join-Path $testsdir "test_utils.ps"
+$fontalias  = Join-Path $test "fontalias.ps"
+
+# Treat a missing or bogus path as "interpreter not available" and skip.
+if (-not $Distiller -or -not (Test-Path $Distiller)) {
+    Write-Output "SKIPPED distiller not available"
+    exit 0
+}
+if (-not (Test-Path $Monolithic)) {
+    Write-Output "FAIL missing $Monolithic (run make first)"
+    exit 1
+}
+
+$distdir = Split-Path $Distiller
+$version = (Get-Item $Distiller).VersionInfo.FileVersion
+$skipset = @($Skip -split '\s+' | Where-Object { $_ })
+
+$work = Join-Path $env:TEMP ("distiller_tests_" + [guid]::NewGuid().ToString("N"))
+New-Item -ItemType Directory -Force -Path $work | Out-Null
+
+$faF = $fontalias  -replace '\\','/'
+$tuF = $testutils  -replace '\\','/'
+$moF = $Monolithic -replace '\\','/'
+
+$files = Get-ChildItem (Join-Path $testsdir "$Filter.ps.test") | Sort-Object Name
+
+Write-Output "Running tests/distiller_tests with Acrobat Distiller $version"
+Write-Output "$($files.Count) test files"
+
+$pass = 0; $skipped = 0; $failed = 0
+try {
+    foreach ($f in $files) {
+        $name = $f.Name -replace '\.ps\.test$',''
+        if ($skipset -contains $name) { Write-Output "SKIP $name"; $skipped++; continue }
+
+        $drv = Join-Path $work "$name.ps"
+        $log = Join-Path $work "$name.log"
+        $tfF = $f.FullName -replace '\\','/'
+        # Each file runs in its own instance: fontalias supplies the base-14
+        # font names, then the shared test utilities, library and test file.
+        $driver = "%!PS-Adobe-3.0`n" +
+                  "($faF) run`n($tuF) run`n($moF) run`n($tfF) run`n" +
+                  "(FILE-PASSED\n) print flush`n"
+        Set-Content -Path $drv -Value $driver -Encoding ASCII
+
+        $sw = [Diagnostics.Stopwatch]::StartNew()
+        $p = Start-Process -FilePath $Distiller -ArgumentList "/N","/Q",$drv `
+                 -PassThru -WorkingDirectory $distdir -WindowStyle Hidden
+        $ok = $p.WaitForExit($Timeout * 1000)
+        $sw.Stop()
+        $secs = "{0:0.00}" -f $sw.Elapsed.TotalSeconds
+
+        if (-not $ok) {
+            try { $p.Kill() } catch {}
+            Write-Output "FAIL $name (${secs}s)"
+            Write-Output "  timeout after ${Timeout}s"
+            $failed++
+            continue
+        }
+
+        $t = if (Test-Path $log) { Get-Content $log -Raw } else { "" }
+        if ($t -match "FILE-PASSED" -and
+            $t -notmatch "testError|stackImbalance|dict leak|global VM leak|%%\[ Error") {
+            Write-Output "PASS $name (${secs}s)"
+            $pass++
+        } else {
+            Write-Output "FAIL $name (${secs}s)"
+            ($t -replace "`r","" -split "`n" | Select-Object -Last 40) |
+                ForEach-Object { Write-Output $_ }
+            $failed++
+        }
+    }
+} finally {
+    Remove-Item $work -Recurse -Force -EA SilentlyContinue
+}
+
+Write-Output "distiller tests: $pass passed, $skipped skipped, $failed failed"
+exit ([int]($failed -ne 0))
