mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
52ffc6a152
Add a copy of docs/writing-tests from C TAP Harness as HOWTO and add a README with some additional explanations more specific to OpenAFS. Change-Id: Ic5b04805db6b00bcb82862ad8d2ebe466f2c266b Reviewed-on: http://gerrit.openafs.org/2109 Reviewed-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Russ Allbery <rra@stanford.edu> Tested-by: Russ Allbery <rra@stanford.edu>
33 lines
1.7 KiB
Plaintext
33 lines
1.7 KiB
Plaintext
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.c 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.
|
|
|
|
runtests.c, tap/basic.c, tap/basic.h, tap/libtap.sh, and HOWTO come from
|
|
the C TAP Harness distribution 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 tap directory rather than modifying
|
|
basic.c, basic.h, or libtap.sh.
|