tests: helpers: provide a "sane" run helper

The runc wrapper we have had for a long time is useful for debugging
errors (because bats's built-in "run" doesn't provide the output of the
program in case of an error). However, it might be necessary to run
other programs in a similar wrapper.

In addition, it might be needed to add timeouts or use the bats_pipe
feature (bats v1.10.0) with similar wrapping. Adding support for this in
the sane_run wrapper makes it a little easier to use these things when
writing tests.

This is somewhat adapted from umoci's sane_run helper.

Signed-off-by: Aleksa Sarai <[email protected]>

Author: cyphar

Makefile

@@ -164,6 +164,7 @@ localunittest: all
 integration: runcimage
 	$(CONTAINER_ENGINE) run $(CONTAINER_ENGINE_RUN_FLAGS) \
 		-t --privileged --rm \
+		-v /boot:/boot:ro \
 		-v /lib/modules:/lib/modules:ro \
 		-v $(CURDIR):/go/src/$(PROJECT) \
 		$(RUNC_IMAGE) make localintegration TESTPATH="$(TESTPATH)"

tests/integration/helpers.bash

@@ -39,18 +39,54 @@ ARCH=$(uname -m)
 # Seccomp agent socket.
 SECCCOMP_AGENT_SOCKET="$BATS_TMPDIR/seccomp-agent.sock"
 
-# Wrapper for runc.
-function runc() {
-	run __runc "$@"
+function sane_run() { # --pipe --timeout=<timeout>
+	local getopt
+	getopt="$(getopt -o + --long pipe,timeout: -- "$@")"
+	eval set -- "$getopt"
+
+	pipe=
+	timeout=
+	while true; do
+		case "$1" in
+		--pipe)
+			pipe=1
+			shift
+			;;
+		--timeout)
+			timeout="$2"
+			shift 2
+			;;
+		--)
+			shift
+			break
+			;;
+		*)
+			fail "unknown argument $1 ${2:-} to sane_run"
+			;;
+		esac
+	done
+	cmd_prefix=()
+	[ -n "$pipe" ] && cmd_prefix+=("bats_pipe")
+	[ -n "$timeout" ] && cmd_prefix+=("timeout" "--foreground" "--signal=KILL" "$timeout")
+
+	local cmd="$1"
+	shift
+
+	run "${cmd_prefix[@]}" "$cmd" "$@"
 
 	# Some debug information to make life easier. bats will only print it if the
 	# test failed, in which case the output is useful.
 	# shellcheck disable=SC2154
-	echo "$(basename "$RUNC") $* (status=$status):" >&2
+	echo "$cmd $* (status=$status):" >&2
 	# shellcheck disable=SC2154
 	echo "$output" >&2
 }
 
+# Wrapper for runc.
+function runc() {
+	sane_run __runc "$@"
+}
+
 # Raw wrapper for runc.
 function __runc() {
 	"$RUNC" ${RUNC_USE_SYSTEMD+--systemd-cgroup} \