[PATCH 03/13] fstests: refactor test boilerplate code

Darrick J. Wong
2021-06-08T17:19:42Z

From: Darrick J. Wong <djwong@kernel.org>

Create two new helper functions to deal with boilerplate test code:

A helper function to set the seq and seqnum variables. We will expand
on this in the next patch so that fstests can autogenerate group files
from now on.

A helper function to register cleanup code that will run if the test
exits or trips over a standard range of signals.

Signed-off-by: Darrick J. Wong <djwong@kernel.org>
---
common/preamble | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
new | 33 ++++++++++++---------------------
2 files changed, 61 insertions(+), 21 deletions(-)
create mode 100644 common/preamble

diff --git a/common/preamble b/common/preamble
new file mode 100644
index 00000000..63f66957
--- /dev/null
+++ b/common/preamble
@@ -0,0 +1,49 @@
+#!/bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2021 Oracle. All Rights Reserved.
+
+# Boilerplate fstests functionality
+
+# Standard cleanup function. Individual tests should override this.
+_cleanup()
+{
+ cd /
+ rm -f $tmp.*
+}
+
+# Install the supplied cleanup code as a signal handler for HUP, INT, QUIT,
+# TERM, or when the test exits. Extra signals can be specified as subsequent
+# parameters.
+_register_cleanup()
+{
+ local cleanup="$1"
+ shift
+
+ test -n "$cleanup" && cleanup="${cleanup}; "
+ trap "${cleanup}exit \$status" EXIT HUP INT QUIT TERM $*
+}
+# Initialize the global seq, seqres, here, tmp, and status variables to their
+# defaults. Group memberships are the only arguments to this helper.
+_begin_fstest()
+{
+ if [ -n "$seq" ]; then
+ echo "_begin_fstest can only be called once!"
+ exit 1
+ fi
+
+ seq=`basename $0`
+ seqres=$RESULT_DIR/$seq
+ echo "QA output created by $seq"
+
+ here=`pwd`
+ tmp=/tmp/$$
+ status=1 # failure is the default!
+
+ _register_cleanup _cleanup
+
+ . ./common/rc
+
+ # remove previous $seqres.full before test
+ rm -f $seqres.full
+
+}
diff --git a/new b/new
index 357983d9..16e7c782 100755
--- a/new
+++ b/new
@@ -153,27 +153,18 @@ cat <<End-of-File >$tdir/$id
#
# what am I here for?
#
-seq=\`basename \$0\`
-seqres=\$RESULT_DIR/\$seq
-echo "QA output created by \$seq"
-
-here=\`pwd\`
-tmp=/tmp/\$\$
-status=1 # failure is the default!
-trap "_cleanup; exit \\\$status" 0 1 2 3 15
-
-_cleanup()
-{
- cd /
- rm -f \$tmp.*
-}
-
-# get standard environment, filters and checks
-. ./common/rc
-. ./common/filter
-
-# remove previous \$seqres.full before test
-rm -f \$seqres.full
+. ./common/preamble
+_begin_fstest group list here
+
+# Override the default cleanup function.
+# _cleanup()
+# {
+# cd /
+# rm -f \$tmp.*
+# }
+
+# Import common functions.
+# . ./common/filter

# real QA test starts here