| Message ID | 162370435585.3800603.509157515145342966.stgit@locust (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | fstests: move test group lists into test files | expand |
On Mon, Jun 14, 2021 at 01:59:15PM -0700, Darrick J. Wong wrote: > 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> Nice! Reviewed-by: Christoph Hellwig <hch@lst.de>
On Mon, Jun 14, 2021 at 01:59:15PM -0700, Darrick J. Wong wrote: > 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> Looks good: Reviewed-by: Eric Biggers <ebiggers@google.com> A couple nits below: > +# Standard cleanup function. Individual tests should override this. > +_cleanup() > +{ > + cd / > + rm -r -f $tmp.* > +} It should say "can override this", not "should override this". > +# Initialize the global seq, seqres, here, tmp, and status variables to their > +# defaults. Group memberships are the only arguments to this helper. > +_begin_fstest() > +{ This function does more than what the comment says. It should say something more along the lines of "Prepare for executing a fstest by initializing some global variables, registering a default cleanup function, importing helper functions, and removing $seqres.full. This must be passed the list of groups to which the test belongs." - Eric
On Wed, Jun 16, 2021 at 01:47:32PM -0700, Eric Biggers wrote: > On Mon, Jun 14, 2021 at 01:59:15PM -0700, Darrick J. Wong wrote: > > 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> > > Looks good: > > Reviewed-by: Eric Biggers <ebiggers@google.com> > > A couple nits below: > > > +# Standard cleanup function. Individual tests should override this. > > +_cleanup() > > +{ > > + cd / > > + rm -r -f $tmp.* > > +} > > It should say "can override this", not "should override this". Fixed. > > +# Initialize the global seq, seqres, here, tmp, and status variables to their > > +# defaults. Group memberships are the only arguments to this helper. > > +_begin_fstest() > > +{ > > This function does more than what the comment says. It should say something > more along the lines of "Prepare for executing a fstest by initializing some > global variables, registering a default cleanup function, importing helper > functions, and removing $seqres.full. This must be passed the list of groups to > which the test belongs." Ok, I'll change that. # Prepare to run a fstest by initializing the global seq, seqres, here, # tmp, and status variables to their defaults, importing 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. --D > > - Eric
diff --git a/common/preamble b/common/preamble new file mode 100644 index 00000000..eafce487 --- /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 -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 $* +} +# 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..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