[PATCH v3 04/12] test: Create common state directories for temporary files

[David Gibson <david@gibson.dropbear.id.au>]

[-- Attachment #1: Type: text/plain, Size: 2864 bytes --]

The test scripts create a bunch of temporary files to keep track of
internal state.  Some are made in /tmp with individual mktemp calls, some
go in the passt source directory, and some go in $LOGDIR.  This can
sometimes make it messy to clean up after failed test runs.

Start cleaning this up by creating a single "state" directory ($STATEBASE)
in /tmp for all the state or temporary files used by a single test run.
Clean it up automatically in cleanup() - except when DEBUG==1, because
those files can be useful for debugging test script failures.

We create subdirectories under $STATEBASE for each setup function, exposed
as $STATESETUP.  We also create subdirectories for each test script and
expose those to the scripts as __STATEDIR__.

Signed-off-by: David Gibson <david(a)gibson.dropbear.id.au>
---
 test/lib/setup | 2 ++
 test/lib/term  | 2 +-
 test/lib/test  | 4 ++++
 test/run       | 2 ++
 4 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/test/lib/setup b/test/lib/setup
index 957a9cc..b0420fb 100755
--- a/test/lib/setup
+++ b/test/lib/setup
@@ -394,6 +394,8 @@ teardown_demo_podman() {
 # $*:	Suffix list of setup_*() functions to be called
 setup() {
 	for arg do
+		STATESETUP="${STATEBASE}/${arg}"
+		mkdir -p "${STATESETUP}"
 		eval setup_${arg}
 	done
 }
diff --git a/test/lib/term b/test/lib/term
index ae99010..b2a45e4 100755
--- a/test/lib/term
+++ b/test/lib/term
@@ -639,7 +639,7 @@ pause_continue() {
 
 # run_term() - Start tmux session, running entry point, with recording if needed
 run_term() {
-	TMUX="tmux new-session -s passt_test -ePCAP=$PCAP -eDEBUG=$DEBUG"
+	TMUX="tmux new-session -s passt_test -eSTATEBASE=$STATEBASE -ePCAP=$PCAP -eDEBUG=$DEBUG"
 
 	if [ ${CI} -eq 1 ]; then
 		printf '\e[8;50;240t'
diff --git a/test/lib/test b/test/lib/test
index 0d06afd..3dbae0b 100755
--- a/test/lib/test
+++ b/test/lib/test
@@ -351,6 +351,10 @@ test_one() {
 	[ ${CI} -eq 1 ] && video_link "${1}"
 
 	TEST_ONE_subs="$(list_add_pair "" "__BASEPATH__" "${BASEPATH}")"
+	TEST_ONE_subs="$(list_add_pair "${TEST_ONE_subs}" "__STATESETUP__" "${STATESETUP}")"
+	STATEDIR="${STATEBASE}/${1}"
+	mkdir -p "${STATEDIR}"
+	TEST_ONE_subs="$(list_add_pair "${TEST_ONE_subs}" "__STATEDIR__" "${STATEDIR}")"
 	TEST_ONE_nok=-1
 	TEST_ONE_perf_nok=0
 	TEST_ONE_skip=0
diff --git a/test/run b/test/run
index 9b0227b..58d9b49 100755
--- a/test/run
+++ b/test/run
@@ -48,6 +48,7 @@ COMMIT="$(git log --oneline --no-decorate -1)"
 
 # cleanup() - Remove temporary files
 cleanup() {
+	[ ${DEBUG} -eq 1 ] || rm -rf "${STATEBASE}"
 	rm -f /tmp/.passt_test_log_pipe
 }
 
@@ -176,6 +177,7 @@ else
 	rm -rf "${LOGDIR}"
 	mkdir -p "${LOGDIR}"
 	:> "${LOGFILE}"
+	STATEBASE="$(mktemp -d --tmpdir passt-tests-XXXXXX)"
 	trap "cleanup" EXIT
 	run_term
 fi
-- 
@@ -48,6 +48,7 @@ COMMIT="$(git log --oneline --no-decorate -1)"
 
 # cleanup() - Remove temporary files
 cleanup() {
+	[ ${DEBUG} -eq 1 ] || rm -rf "${STATEBASE}"
 	rm -f /tmp/.passt_test_log_pipe
 }
 
@@ -176,6 +177,7 @@ else
 	rm -rf "${LOGDIR}"
 	mkdir -p "${LOGDIR}"
 	:> "${LOGFILE}"
+	STATEBASE="$(mktemp -d --tmpdir passt-tests-XXXXXX)"
 	trap "cleanup" EXIT
 	run_term
 fi
-- 
2.37.3