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: linux-xfs@vger.kernel.org, fstests@vger.kernel.org, guan@eryu.me,
	amir73il@gmail.com, ebiggers@kernel.org
Subject: [PATCH 13/13] misc: update documentation to reflect auto-generated group files
Date: Tue, 08 Jun 2021 10:20:33 -0700	[thread overview]
Message-ID: <162317283324.653489.9381968524443830077.stgit@locust> (raw)
In-Reply-To: <162317276202.653489.13006238543620278716.stgit@locust>

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

Update the documentation to outline the new requirements for test files
so that we can generate group files during build.

Signed-off-by: Darrick J. Wong <djwong@kernel.org>
---
 README |   19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)


diff --git a/README b/README
index 048491a6..ab298ca9 100644
--- a/README
+++ b/README
@@ -140,7 +140,8 @@ Running tests:
     - ./check '*/001' '*/002' '*/003'
     - ./check '*/06?'
     - Groups of tests maybe ran by: ./check -g [group(s)]
-      See the 'group' file for details on groups
+      See the tests/*/group.list files after building xfstests to learn about
+      each test's group memberships.
     - If you want to run all tests regardless of what group they are in
       (including dangerous tests), use the "all" group: ./check -g all
     - To randomize test order: ./check -r [test(s)]
@@ -174,8 +175,8 @@ Test script environment:
 
     When developing a new test script keep the following things in
     mind.  All of the environment variables and shell procedures are
-    available to the script once the "common/rc" file has been
-    sourced.
+    available to the script once the "common/preamble" file has been
+    sourced and the "_begin_fstest" function has been called.
 
      1. The tests are run from an arbitrary directory.  If you want to
 	do operations on an XFS filesystem (good idea, eh?), then do
@@ -249,6 +250,18 @@ Test script environment:
 	  in the ./new script. It can contain only alphanumeric characters
 	  and dash. Note the "NNN-" part is added automatically.
 
+     6. Test group membership: Each test can be associated with any number
+	of groups for convenient selection of subsets of tests.  Test names
+	can be any sequence of non-whitespace characters.  Test authors
+	associate a test with groups by passing the names of those groups as
+	arguments to the _begin_fstest function:
+
+	_begin_fstest auto quick subvol snapshot
+
+	The build process scans test files for _begin_fstest invocations and
+	compiles the group list from that information.  In other words, test
+	files must call _begin_fstest or they will not be run.
+
 Verified output:
 
     Each test script has a name, e.g. 007, and an associated


  parent reply	other threads:[~2021-06-08 17:20 UTC|newest]

Thread overview: 55+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 01/13] fstests: fix group check in new script Darrick J. Wong
2021-06-10  8:43   ` Chandan Babu R
2021-06-11 21:54     ` Allison Henderson
2021-06-08 17:19 ` [PATCH 02/13] misc: move exit status into trap handler Darrick J. Wong
2021-06-10  8:43   ` Chandan Babu R
2021-06-11 21:55   ` Allison Henderson
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
2021-06-08 17:19 ` [PATCH 04/13] fstests: add tool migrate group membership data to test files Darrick J. Wong
2021-06-10  8:44   ` Chandan Babu R
2021-06-11 21:55   ` Allison Henderson
2021-06-08 17:19 ` [PATCH 05/13] fstests: move test group info " Darrick J. Wong
2021-06-11 21:55   ` Allison Henderson
2021-06-11 23:29   ` Eric Biggers
2021-06-12  0:17     ` Eric Biggers
2021-06-12  0:34       ` Darrick J. Wong
2021-06-08 17:19 ` [PATCH 06/13] fstests: clean up open-coded golden output Darrick J. Wong
2021-06-10  8:57   ` Chandan Babu R
2021-06-11 21:55   ` Allison Henderson
2021-06-08 17:20 ` [PATCH 07/13] fstests: automatically generate group files Darrick J. Wong
2021-06-11  5:39   ` Chandan Babu R
2021-06-11 23:37   ` [PATCH v1.1 " Darrick J. Wong
2021-06-14  5:38     ` Allison Henderson
2021-06-08 17:20 ` [PATCH 08/13] fstests: convert nextid to use automatic group generation Darrick J. Wong
2021-06-11  6:31   ` Chandan Babu R
2021-06-11 23:46   ` Eric Biggers
2021-06-12  0:40     ` Darrick J. Wong
2021-06-14  5:38   ` Allison Henderson
2021-06-08 17:20 ` [PATCH 09/13] fstests: adapt the new test script to our new group tagging scheme Darrick J. Wong
2021-06-11  6:55   ` Chandan Babu R
2021-06-14  5:38   ` Allison Henderson
2021-06-08 17:20 ` [PATCH 10/13] check: use generated group files Darrick J. Wong
2021-06-11  7:49   ` Chandan Babu R
2021-06-14 19:39   ` Allison Henderson
2021-06-08 17:20 ` [PATCH 11/13] fstests: remove " Darrick J. Wong
2021-06-11  7:53   ` Chandan Babu R
2021-06-11 23:24   ` Eric Biggers
2021-06-11 23:29     ` Darrick J. Wong
2021-06-11 23:51       ` Eric Biggers
2021-06-14 19:39   ` Allison Henderson
2021-06-08 17:20 ` [PATCH 12/13] fstests: remove test group management code Darrick J. Wong
2021-06-11  8:19   ` Chandan Babu R
2021-06-14 19:39   ` Allison Henderson
2021-06-08 17:20 ` Darrick J. Wong [this message]
2021-06-11  8:23   ` [PATCH 13/13] misc: update documentation to reflect auto-generated group files Chandan Babu R
2021-06-14 19:39   ` Allison Henderson
2021-06-14 20:49     ` Darrick J. Wong
2021-06-14 20:58 [PATCHSET v2 00/13] fstests: move test group lists into test files Darrick J. Wong
2021-06-14 21:00 ` [PATCH 13/13] misc: update documentation to reflect auto-generated group files Darrick J. Wong
2021-06-16 21:00   ` Eric Biggers
2021-06-17  0:11     ` Darrick J. Wong
2021-06-21 23:10 [PATCHSET v3 00/13] fstests: move test group lists into test files Darrick J. Wong
2021-06-21 23:11 ` [PATCH 13/13] misc: update documentation to reflect auto-generated group files 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=162317283324.653489.9381968524443830077.stgit@locust \
    --to=djwong@kernel.org \
    --cc=amir73il@gmail.com \
    --cc=ebiggers@kernel.org \
    --cc=fstests@vger.kernel.org \
    --cc=guan@eryu.me \
    --cc=guaneryu@gmail.com \
    --cc=linux-xfs@vger.kernel.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.