Various bug fixes to assembler, added more data pointers.

2026-08-13 23:41:22 -04:00
parent b50210d127
commit c2440ae5fa
38 changed files with 1028 additions and 236 deletions
@@ -0,0 +1,193 @@
+#!/usr/bin/env bash
+# run.sh
+# Test runner for the SplitBit Emulator and Assembler.
+# Written by Anachronaut
+#
+# Assembles and runs every program listed in Tests/manifest and compares the
+# output against the recorded results in Tests/expected.
+#
+#   ./Tests/run.sh            Run the suite.
+#   ./Tests/run.sh --bless    Record current output as the expected results.
+#   ./Tests/run.sh <name>...  Run only the named tests.
+#
+# Programs are built inside Tests/build so that running the suite never touches
+# the binaries in Programs/.
+
+set -u
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+TESTS="$ROOT/Tests"
+BUILD="$TESTS/build"
+EXPECTED="$TESTS/expected"
+INPUT="$TESTS/input"
+MANIFEST="$TESTS/manifest"
+
+ASSEMBLER="$ROOT/Assembler"
+EMULATOR="$ROOT/SplitBit"
+
+RUN_TIMEOUT=10
+
+BLESS=0
+ONLY=()
+
+for arg in "$@"; do
+    case "$arg" in
+        --bless) BLESS=1 ;;
+        -h|--help)
+            sed -n '3,14p' "${BASH_SOURCE[0]}" | sed 's/^# \{0,1\}//'
+            exit 0
+            ;;
+        -*) echo "run.sh: unknown option $arg" >&2; exit 2 ;;
+        *) ONLY+=("$arg") ;;
+    esac
+done
+
+for tool in "$ASSEMBLER" "$EMULATOR"; do
+    if [ ! -x "$tool" ]; then
+        echo "run.sh: $tool is missing. Run 'make' first." >&2
+        exit 2
+    fi
+done
+
+rm -rf "$BUILD"
+mkdir -p "$BUILD" "$EXPECTED"
+cp -r "$ROOT/Programs/." "$BUILD/"
+find "$BUILD" -name '*.bin' -delete
+
+PASS=0
+FAIL=0
+BLESSED=0
+FAILED_NAMES=()
+
+wanted() {
+    [ ${#ONLY[@]} -eq 0 ] && return 0
+    local n
+    for n in "${ONLY[@]}"; do [ "$n" = "$1" ] && return 0; done
+    return 1
+}
+
+report() {
+    # report <status> <name> <detail>
+    printf '  [%-4s] %-20s %s\n' "$1" "$2" "$3"
+}
+
+trim() {
+    local v="$1"
+    v="${v#"${v%%[![:space:]]*}"}"
+    v="${v%"${v##*[![:space:]]}"}"
+    printf '%s' "$v"
+}
+
+check() {
+    # check <name> <actual-file>
+    local name="$1" actual="$2" golden="$EXPECTED/$1.out"
+    if [ "$BLESS" -eq 1 ]; then
+        cp "$actual" "$golden"
+        BLESSED=$((BLESSED + 1))
+        report "rec" "$name" "$(wc -c < "$golden" | tr -d ' ') bytes recorded"
+        return 0
+    fi
+    if [ ! -f "$golden" ]; then
+        FAIL=$((FAIL + 1)); FAILED_NAMES+=("$name")
+        report "FAIL" "$name" "no recorded output; run with --bless"
+        return 1
+    fi
+    if cmp -s "$actual" "$golden"; then
+        PASS=$((PASS + 1))
+        report "ok" "$name" ""
+        return 0
+    fi
+    FAIL=$((FAIL + 1)); FAILED_NAMES+=("$name")
+    report "FAIL" "$name" "output differs"
+    diff -u "$golden" "$actual" 2>/dev/null | head -20 | sed 's/^/         /'
+    return 1
+}
+
+assemble() {
+    # assemble <source> <assemble-from>; echoes the built binary path on success
+    local src="$1" dir="$2"
+    local wd="$BUILD/$dir" rel bin
+    rel="$(realpath --relative-to="$wd" "$BUILD/$src")"
+    bin="$wd/$(basename "${src%.asm}").bin"
+    if ( cd "$wd" && "$ASSEMBLER" "$rel" ) >"$BUILD/.assemble.log" 2>&1; then
+        echo "$bin"
+        return 0
+    fi
+    return 1
+}
+
+while IFS='|' read -r name src dir mode stdin limit; do
+    name="$(trim "$name")"
+    [ -z "$name" ] && continue
+    case "$name" in \#*) continue ;; esac
+    src="$(trim "$src")"; dir="$(trim "$dir")"
+    mode="$(trim "$mode")"; stdin="$(trim "$stdin")"
+    limit="$(trim "$limit")"
+
+    wanted "$name" || continue
+
+    if [ "$mode" = "xfail" ]; then
+        if assemble "$src" "$dir" >/dev/null; then
+            FAIL=$((FAIL + 1)); FAILED_NAMES+=("$name")
+            report "FAIL" "$name" "expected assembly to fail, but it succeeded"
+        else
+            PASS=$((PASS + 1))
+            report "ok" "$name" "fails as recorded: $(head -1 "$BUILD/.assemble.log" | tr -d '\033' | sed 's/\[[0-9;]*m//g')"
+        fi
+        continue
+    fi
+
+    if ! BIN="$(assemble "$src" "$dir")"; then
+        FAIL=$((FAIL + 1)); FAILED_NAMES+=("$name")
+        report "FAIL" "$name" "assembly failed"
+        head -3 "$BUILD/.assemble.log" | tr -d '\033' | sed 's/\[[0-9;]*m//g' | sed 's/^/         /'
+        continue
+    fi
+
+    if [ "$mode" = "assemble" ]; then
+        PASS=$((PASS + 1))
+        report "ok" "$name" "assembles"
+        continue
+    fi
+
+    if [ "$stdin" != "-" ] && [ ! -f "$INPUT/$stdin" ]; then
+        FAIL=$((FAIL + 1)); FAILED_NAMES+=("$name")
+        report "FAIL" "$name" "missing input fixture $stdin"
+        continue
+    fi
+    IN=/dev/null
+    [ "$stdin" != "-" ] && IN="$INPUT/$stdin"
+
+    OUT="$BUILD/.out"
+    case "$mode" in
+        run)
+            # --fast because there is nothing to learn from waiting out the emulated
+            # clock, and --cycles for programs that never halt on their own, which
+            # bounds them by cycle count rather than by wall clock.
+            EMUARGS=(--fast)
+            [ "$limit" != "-" ] && EMUARGS+=(--cycles "$limit")
+            if ! timeout "$RUN_TIMEOUT" "$EMULATOR" "${EMUARGS[@]}" "$BIN" <"$IN" >"$OUT" 2>&1; then
+                FAIL=$((FAIL + 1)); FAILED_NAMES+=("$name")
+                report "FAIL" "$name" "did not finish within ${RUN_TIMEOUT}s"
+                continue
+            fi
+            check "$name" "$OUT"
+            ;;
+        *)
+            FAIL=$((FAIL + 1)); FAILED_NAMES+=("$name")
+            report "FAIL" "$name" "unknown mode '$mode' in manifest"
+            ;;
+    esac
+done < "$MANIFEST"
+
+echo
+if [ "$BLESS" -eq 1 ]; then
+    echo "Recorded $BLESSED expected results into Tests/expected."
+    exit 0
+fi
+if [ "$FAIL" -eq 0 ]; then
+    echo "All $PASS tests passed."
+    exit 0
+fi
+echo "$PASS passed, $FAIL failed: ${FAILED_NAMES[*]}"
+exit 1