All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Darrick J. Wong" <djwong@kernel.org>
To: djwong@kernel.org, guaneryu@gmail.com
Cc: Chandan Babu R <chandanrlinux@gmail.com>,
	Allison Henderson <allison.henderson@oracle.com>,
	Christoph Hellwig <hch@lst.de>,
	Eric Biggers <ebiggers@google.com>,
	linux-xfs@vger.kernel.org, fstests@vger.kernel.org, guan@eryu.me,
	amir73il@gmail.com, ebiggers@kernel.org
Subject: [PATCH 03/13] fstests: refactor test boilerplate code
Date: Mon, 21 Jun 2021 16:10:23 -0700	[thread overview]
Message-ID: <162431702312.4090790.12118119463621535575.stgit@locust> (raw)
In-Reply-To: <162431700639.4090790.11684371602638166127.stgit@locust>

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>
Reviewed-by: Chandan Babu R <chandanrlinux@gmail.com>
Reviewed-by: Allison Henderson <allison.henderson@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-by: Eric Biggers <ebiggers@google.com>
---
 common/preamble |   55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 new             |   33 ++++++++++++---------------------
 2 files changed, 67 insertions(+), 21 deletions(-)
 create mode 100644 common/preamble


diff --git a/common/preamble b/common/preamble
new file mode 100644
index 00000000..fba766de
--- /dev/null
+++ b/common/preamble
@@ -0,0 +1,55 @@
+#!/bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2021 Oracle.  All Rights Reserved.
+
+# Boilerplate fstests functionality
+
+# Standard cleanup function.  Individual tests can override this.
+_cleanup()
+{
+	cd /
+	rm -r -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 $*
+}
+
+# Prepare to run a fstest by initializing the required global variables to
+# their defaults, sourcing common functions, registering a cleanup function,
+# and removing the $seqres.full file.
+#
+# The list of group memberships for this test (e.g. auto quick rw) must be
+# passed as arguments to this helper.  It is not necessary to name this test
+# explicitly as a member of the 'all' group.
+_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..531fd123 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 -r -f \$tmp.*
+# }
+
+# Import common functions.
+# . ./common/filter
 
 # real QA test starts here
 


  parent reply	other threads:[~2021-06-21 23:10 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-21 23:10 [PATCHSET v3 00/13] fstests: move test group lists into test files Darrick J. Wong
2021-06-21 23:10 ` [PATCH 01/13] fstests: fix group check in new script Darrick J. Wong
2021-06-21 23:10 ` [PATCH 02/13] misc: move exit status into trap handler Darrick J. Wong
2021-06-21 23:10 ` Darrick J. Wong [this message]
2021-06-21 23:10 ` [PATCH 04/13] fstests: add tool migrate group membership data to test files Darrick J. Wong
2021-06-21 23:10 ` [PATCH 05/13] fstests: clean up open-coded golden output Darrick J. Wong
2021-06-21 23:10 ` [PATCH 06/13] fstests: move test group info to test files Darrick J. Wong
2021-06-21 23:10 ` [PATCH 07/13] fstests: automatically generate group files Darrick J. Wong
2021-06-21 23:10 ` [PATCH 08/13] fstests: convert nextid to use automatic group generation Darrick J. Wong
2021-06-21 23:10 ` [PATCH 09/13] fstests: adapt the new test script to our new group tagging scheme Darrick J. Wong
2021-06-21 23:11 ` [PATCH 10/13] check: use generated group files Darrick J. Wong
2021-06-21 23:11 ` [PATCH 11/13] fstests: remove " Darrick J. Wong
2021-06-21 23:11 ` [PATCH 12/13] fstests: remove test group management code Darrick J. Wong
2021-06-21 23:11 ` [PATCH 13/13] misc: update documentation to reflect auto-generated group files Darrick J. Wong
  -- strict thread matches above, loose matches on Subject: below --
2021-06-14 20:58 [PATCHSET v2 00/13] fstests: move test group lists into test files Darrick J. Wong
2021-06-14 20:59 ` [PATCH 03/13] fstests: refactor test boilerplate code Darrick J. Wong
2021-06-16  5:42   ` Christoph Hellwig
2021-06-16 20:47   ` Eric Biggers
2021-06-17  0:02     ` Darrick J. Wong
2021-06-08 17:19 [PATCHSET v1 00/13] fstests: move test group lists into test files Darrick J. Wong
2021-06-08 17:19 ` [PATCH 03/13] fstests: refactor test boilerplate code Darrick J. Wong
2021-06-10  8:44   ` Chandan Babu R
2021-06-11 21:55   ` Allison Henderson
2021-06-12  0:08   ` Eric Biggers
2021-06-12  0:34     ` Darrick J. Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=162431702312.4090790.12118119463621535575.stgit@locust \
    --to=djwong@kernel.org \
    --cc=allison.henderson@oracle.com \
    --cc=amir73il@gmail.com \
    --cc=chandanrlinux@gmail.com \
    --cc=ebiggers@google.com \
    --cc=ebiggers@kernel.org \
    --cc=fstests@vger.kernel.org \
    --cc=guan@eryu.me \
    --cc=guaneryu@gmail.com \
    --cc=hch@lst.de \
    --cc=linux-xfs@vger.kernel.org \
    --subject='Re: [PATCH 03/13] fstests: refactor test boilerplate code' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.