mirror of
https://github.com/Klipper4FlashForge/firmware.git
synced 2026-10-23 13:52:16 -05:00
Oleksandr ShyshatskyiandClaude Opus 5
71cea577c5
test-printer-db.py is gone entirely. It started as a re-implementation of PrinterDetector's scoring formula and was later narrowed to invariants that do not model anyone's arithmetic; neither version earned the place it took up. The Makefile target, the suite entry and the docs note go with it. test-env.sh was a file whose whole job was to load two other files. Its contents move into sim-image.sh, which every replica launcher already sources or is one exec away from, so the config and the docker plumbing now arrive together instead of as two sources the caller had to remember in order. sim-install.sh and sim-roundtrip.sh source sim-image.sh directly now, which also means a missing docker is reported before a package is staged rather than after. The environment still wins over both config files -- verified in both directions, an explicit PRINTER_IMAGE beats test.env and an unset one falls through to it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
94 lines
3.9 KiB
Bash
94 lines
3.9 KiB
Bash
#!/usr/bin/env bash
|
|
# Host-side launcher for the printer replica.
|
|
#
|
|
# test/printer-exec.sh <case-script> [name=package.tgz ...]
|
|
#
|
|
# The case script is executed by the printer's own busybox inside a chroot of
|
|
# the real extracted rootfs.squashfs, with MIPS binaries running under
|
|
# qemu-user. Named packages appear on the simulated USB stick as /mnt/<name>.
|
|
#
|
|
# BASE_PKG=<stock .tgz> installs stock firmware first, so /usr/prog holds the
|
|
# genuine klipper tree, unTar, app_startup.sh and firmwareExe rather than
|
|
# hand-written fakes.
|
|
#
|
|
# USB_STICK=1 puts the packages on a real FAT filesystem exposed as /dev/sda1
|
|
# instead of dropping them into /mnt, so the case script can let the printer's
|
|
# own app_startup.sh discover and mount them. Required by case-install.sh.
|
|
#
|
|
# PROG_DUMP=<tar or dir> supplies a real /usr/prog taken off a printer
|
|
# (`tar -cf /mnt/prog.tar /usr/prog` over ssh). With one, the replica has no
|
|
# invented files left at all.
|
|
set -uo pipefail
|
|
ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
|
CASE="${1:?usage: printer-exec.sh <case-script> [name=pkg.tgz ...]}"; shift
|
|
|
|
# The config (config.env, test.env) and the docker plumbing (skip policy,
|
|
# image choice, local sim-image build), shared with the other replica
|
|
# launchers. Loading the config used to be the caller's job, which meant the
|
|
# direct invocation this file documents never saw PRINTER_IMAGE and rebuilt
|
|
# the local replica image every time. Sourcing this twice is harmless: the
|
|
# environment wins over both files, and the first pass exported them.
|
|
# shellcheck disable=SC1091
|
|
. "$ROOT/test/sim-image.sh"
|
|
|
|
if [ "$PREBUILT" = 0 ]; then
|
|
# Say why this is about to be slow. Unpacking the factory image is ~22s
|
|
# and installing the stock baseline is ~37s, on EVERY case; the published
|
|
# image has both done already and starts in under a second.
|
|
echo " printer-sim: PRINTER_IMAGE is not set, so the replica is being built" >&2
|
|
echo " locally -- about a minute of setup per test case. Set" >&2
|
|
echo " PRINTER_IMAGE=monstrofil/creator5-printer:latest in" >&2
|
|
echo " test.env to skip it." >&2
|
|
fi
|
|
|
|
# Stage every input inside the repo: the docker daemon resolves bind-mount
|
|
# paths on the host, and the repo is the one directory guaranteed to exist
|
|
# there under the same name.
|
|
# Per-process, so two suites running at once cannot delete each other's
|
|
# staged packages half way through a run.
|
|
STAGE="$ROOT/work/.sim-$$"
|
|
rm -rf "$STAGE"; mkdir -p "$STAGE/pkgs"
|
|
trap 'rm -rf "$STAGE"' EXIT # the staged packages are ~80MB each
|
|
cp "$CASE" "$STAGE/case.sh"
|
|
|
|
PKGS=""
|
|
for spec in "$@"; do
|
|
name="${spec%%=*}"; path="${spec#*=}"
|
|
cp "$path" "$STAGE/pkgs/$name"
|
|
PKGS="$PKGS $name=/pkgs/$name"
|
|
done
|
|
|
|
BASE_ARG=""
|
|
if [ -n "${BASE_PKG:-}" ]; then
|
|
cp "$BASE_PKG" "$STAGE/pkgs/base.tgz"
|
|
BASE_ARG="/pkgs/base.tgz"
|
|
fi
|
|
|
|
DUMP_MOUNT=""
|
|
DUMP_ARG=""
|
|
if [ "$PREBUILT" = 0 ] && [ -n "${PROG_DUMP:-}" ] && [ -e "$PROG_DUMP" ]; then
|
|
DUMP_ABS="$(cd "$(dirname "$PROG_DUMP")" && pwd)/$(basename "$PROG_DUMP")"
|
|
DUMP_MOUNT="-v $DUMP_ABS:/progdump:ro"
|
|
DUMP_ARG="/progdump"
|
|
fi
|
|
|
|
# --privileged is needed for exactly two things: registering the binfmt handler
|
|
# for the printer's MIPS binaries, and building the mount layout that gives the
|
|
# replica a read-only root with writable prog/data partitions.
|
|
ROOTFS_MOUNT="-v $ROOT/work/rootfs:/rootfs:ro"
|
|
[ "$PREBUILT" = 1 ] && ROOTFS_MOUNT="" # the image carries its own firmware
|
|
|
|
# shellcheck disable=SC2086
|
|
$DOCKER run --rm -i --privileged \
|
|
$ROOTFS_MOUNT \
|
|
-v "$STAGE/pkgs:/pkgs:ro" \
|
|
-v "$STAGE/case.sh:/case.sh:ro" \
|
|
-v "$ROOT/payload:/payload:ro" \
|
|
-e "FF_KEY=${FF_KEY:-FFP0331&*%root}" \
|
|
-e "BASE_PKG=$BASE_ARG" \
|
|
-e "PKGS=$PKGS" \
|
|
-e "PROG_DUMP=$DUMP_ARG" $DUMP_MOUNT \
|
|
-e "PROG_MB=${PROG_MB:-}" -e "DATA_MB=${DATA_MB:-}" -e "SIM_VERBOSE=${SIM_VERBOSE:-0}" \
|
|
-e "USB_STICK=${USB_STICK:-0}" \
|
|
"$IMAGE" /case.sh
|