openafs/tests
Andrew Deason 71acc392a3 tests: Generalize temp dir management
Currently, afstest_BuildTestConfig calls afstest_mkdtemp (our thin
wrapper around mkdtemp) to create its temporary config dir. We may
want to make new tests, though, that create a temp dir for other
purposes. To make that easier, move a little more code into
afstest_mkdtemp, so the caller doesn't need to construct the template.

To allow callers to clean up such temporary dirs, change
afstest_UnlinkTestConfig into a more general function,
afstest_rmdtemp. Allow this new function to remove all files in a dir,
not just files one-level-deep. To avoid needing to write our own
traversal and removal logic, just run 'rm -rf' via a new function,
afstest_systemlp().

Move these temp dir-related functions from config.c into files.c,
since they are no longer specific to config dirs.

Change-Id: I16750a2f30e98c9ca2e14dfb7d3fc9bc5d456e8d
Reviewed-on: https://gerrit.openafs.org/14632
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
2021-08-13 17:50:23 -04:00
..
auth tests: Generalize temp dir management 2021-08-13 17:50:23 -04:00
bozo tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
bucoord tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
cmd tests: Introduce afstest_*_path() 2021-08-12 10:34:03 -04:00
common tests: Generalize temp dir management 2021-08-13 17:50:23 -04:00
kauth tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
opr tests: Introduce libafstest_common 2021-08-07 20:38:05 -04:00
ptserver tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
rx tests: Introduce libafstest_common 2021-08-07 20:38:05 -04:00
tap tests: Introduce libafstest_common 2021-08-07 20:38:05 -04:00
tests-lib/perl5 tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
util tests: Introduce libafstest_common 2021-08-07 20:38:05 -04:00
venus tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
volser tests: Generalize temp dir management 2021-08-13 17:50:23 -04:00
.gitignore tests: Add core to .gitignore in tests 2020-03-20 15:56:12 -04:00
libwrap tests: use exec to call libwrap'd executables 2016-12-16 16:25:58 -05:00
Makefile.in tests: Avoid verbose output for 'make check V=0' 2021-06-11 15:16:31 -04:00
README correct whitespace errors in readme files 2013-01-07 07:40:46 -08:00
TESTS tests: Modernize writekeyfile.c 2020-06-19 11:48:57 -04:00

This directory contains a test harness and the beginnings of what is
intended to become the primary OpenAFS test suite.  The tests in this
directory are run when "make check" is run at the top level of the OpenAFS
tree.

runtests is the test harness, and TESTS is the list of tests that it
will run.  If you add a new test, add it to TESTS as well.  All tests must
be executables (possibly shell scripts or Perl scripts) that end in either
".t" or "-t", but should be listed in TESTS without that suffix.

Tests should be organized into subdirectories, and where it makes sense to
do so, those subdirectories should match the subdirectory names under src
in the AFS source tree.  In other words, tests for src/util/* should go in
a directory named util, tests for the libkopenafs library should go in a
directory named kopenafs, and so forth.  To integrate with the build
system, each subdirectory will need to have its own Makefile.in and be
added to the list of generated Makefiles in configure.in at the top
level.   The Makefile.in in this directory will also need to be modified
to recurse into any new directories.  See util/Makefile.in for an example
of how to write a Makefile.in for a new test directory.

The files comprising the test harness are sourced from the C TAP Harness
distribution using the src/external mechanism. The upstream site for that
distribution is at:

    http://www.eyrie.org/~eagle/software/c-tap-harness/

but feel free to propose modifications directly through OpenAFS Gerrit.
Russ Allbery will take care of merging modifications upstream.  However,
OpenAFS-specific modifications should not be made to those files.  To add
additional OpenAFS-specific code to the TAP library, add additional *.c
and *.h (or *.sh) files to the tests/tap directory rather than modifying files
in src/external.

More information can be found in the HOWTO contained in
src/external/c-tap-harness/HOWTO