openafs/tests
Michael Meffie 9dd6fa97b6 tests: Add make shell target
Add a makefile target to start an interactive subshell with the
environment required to run tests directly from the command line.  Tests
can also be run from a debugger or from the "runtests" front-end test
runner.

Example usage:

    $ make shell
    ...
    Starting a shell to run tests. Run 'exit' when done.

    # Set the subshell prompt (optional).
    $ PS1="(tests) $PS1"

    # Run tests directly or with a debugger.
    (tests) $ rx/perf-t
    ...
    (tests) $ file rx/perf-t
    rx/perf-t: Perl script text executable
    (tests) $ perl -d rx/perf-t
    ...

    # End the subshell.
    (tests) $ exit
    $

The shell started will be the one discovered by configure, which may not
be the preferred shell for interactive use. To specify a different
shell, define SHELL when running make:

    $ make shell SHELL=/path/to/my/shell

If you use this feature often, you may want to update your shell profile
to automatically set the PS1 when running the test subshell.  For
example, you can append this to your bashrc file:

    # OpenAFS unit test subshell.
    if [[ $MAKECHECK -eq 1 ]]; then
        PS1="(tests) $PS1"
    fi

Thanks to Ben Kaduk for the suggestion.

Change-Id: I8d949d21153396c0da8db186fd35477ad0383f12
Reviewed-on: https://gerrit.openafs.org/15730
Reviewed-by: Cheyenne Wills <cwills@sinenomine.net>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
2024-06-27 09:10:18 -04:00
..
auth tests: Add missing dependencies for the C-TAP tests 2024-06-24 15:12:11 -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: Remove check/test/tests subdir targets 2021-08-26 10:29:57 -04:00
common tests: Ensure temp file cleanup on Solaris 2024-06-24 15:10:23 -04:00
kauth tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
opr tests: Add missing dependencies for the C-TAP tests 2024-06-24 15:12:11 -04:00
ptserver tests: Add existing-database test for pt_util 2021-10-08 00:05:02 -04:00
rx tests: rx/perf wait for server init before client 2024-04-11 17:45:00 -04:00
tap tests: Remove check/test/tests subdir targets 2021-08-26 10:29:57 -04:00
tests-lib/perl5 tests: Redirect diag() to stdout by default 2024-06-24 17:54:59 -04:00
util util: Avoid bad ascii[1] in volutil_GetPartitionID 2023-09-17 00:46:03 -04:00
venus tests: Accommodate c-tap-harness 4.7 2020-08-20 22:36:56 -04:00
volser tests: Specify unsigned char arrays in vos-t uuid tests 2024-06-24 17:56:34 -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: Add make shell target 2024-06-27 09:10:18 -04:00
README correct whitespace errors in readme files 2013-01-07 07:40:46 -08:00
TESTS tests: Add unit tests for rx_atomic.h 2023-03-01 23:04:04 -05: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