freebsd-dev/tools/regression
Warner Losh fbbd9655e5 Renumber copyright clause 4
Renumber cluase 4 to 3, per what everybody else did when BSD granted
them permission to remove clause 3. My insistance on keeping the same
numbering for legal reasons is too pedantic, so give up on that point.

Submitted by:	Jan Schaumann <jschauma@stevens.edu>
Pull Request:	https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
..
aio/aiop Renumber copyright clause 4 2017-02-28 23:42:47 +00:00
atm
audit/audit_pipe_ioctl NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
bpf Clean up and add some test cases for ALU instructions. 2016-10-21 06:56:30 +00:00
capsicum/syscalls Move libcasper tests from regression/capsicum/libcasper/ to 2016-09-08 20:01:26 +00:00
ccd/layout
doat NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
environ NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
ethernet/ethermulti NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
fsx NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
gaithrstress Fix LDADD/DPADD that should be LIBADD. 2015-12-04 03:17:47 +00:00
geom Fix LDADD/DPADD that should be LIBADD. 2015-12-04 03:17:47 +00:00
geom_gpt
include META_MODE: Remove DEP_RELDIR from Makefile.depend files. 2015-09-25 19:26:08 +00:00
ipfw/fwd
ipsec
iscsi Revert r257385; was testing a shell script to automatically append the proper 2013-10-30 14:48:46 +00:00
kgssapi Fix LDADD/DPADD that should be LIBADD. 2015-12-04 03:17:47 +00:00
kthread/kld NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
lib/libc/regex Integrate the remaining tools/regression/lib/msun testcases into the 2015-12-20 05:06:44 +00:00
mlock NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
msdosfs
net/if_tap
net80211 Unbreak regression testing tools for net80211 crypto cipher modules 2015-10-22 17:08:12 +00:00
netinet Use print as a function for Python 3 [PEP 3105] 2015-11-19 00:01:52 +00:00
netinet6 NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
nfsmmap NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
p1003_1b - Replace N(a)/N(i)/N(T)/LEN(a)/ARRAY_SIZE(a) with nitems() 2015-08-29 19:47:20 +00:00
poll
posixsem Fix LDADD/DPADD that should be LIBADD. 2015-12-04 03:17:47 +00:00
posixsem2 sem: Don't free nameinfo that is still in list when open() fails. 2016-01-22 14:52:31 +00:00
priv Fix LDADD/DPADD that should be LIBADD. 2015-12-04 03:17:47 +00:00
pthread Fix LDADD/DPADD that should be LIBADD. 2015-12-04 03:17:47 +00:00
redzone9
rpcsec_gss Fix LDADD/DPADD that should be LIBADD. 2015-12-04 03:17:47 +00:00
security Use nitems(x) instead of sizeof(x)/sizeof(x[0]) 2015-11-02 00:42:31 +00:00
sigqueue NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
sockets Add a regression test for putting a socket on kqueue, and then doing 2017-02-14 21:56:01 +00:00
sysvmsg NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
sysvsem semget(): Check for [EEXIST] error first. 2016-02-07 22:12:39 +00:00
sysvshm Cosmetics: 2015-03-18 22:05:15 +00:00
tls Add missing stdlib.h header 2015-12-08 05:27:22 +00:00
tmpfs NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
ufs/uprintf NO_MAN= has been deprecated in favor of MAN= for some time, go ahead 2014-04-13 05:21:56 +00:00
usb
usr.bin env: Fix crash when -S string is not empty but no operand follows. 2015-03-08 14:12:43 +00:00
zfs Remove calls to die added for associated bugs 2016-07-31 06:28:40 +00:00
README Remove ia64. 2014-07-07 00:27:09 +00:00
TODO

$FreeBSD$

This directory is for regression test programs.

A regression test program is one that will exercise a particular bit of the
system to check that we have not reintroduced an old bug.

Tests should be implemented in files with a .t extension.  Each .t file
can contain more than one test, and can be implemented in any scripting
language -- /bin/sh, Perl...

The test protocol is quite simple.  At its most basic, each .t file should, 
when run, print a line in this format:

   1..m

where m is the number of tests that will be run.

Each test should produce a single line of output.  This line should start
with one of

   ok n
   not ok n

to indicate whether or not the test succeeded.  'n' is the test's number.
Anything after this on the line (up to the first '#' if present) is 
considered to be the name of the test.  Naming tests is optional, but 
encouraged.

A test may be written which is conditional, and may need to be skipped.
For example, the netinet tests require 'options INET' in the kernel.
A test may be skipped by printing '# skip Reason for skipping' after the
test name.  For example,

    ok 1 - netinet # skip 'options INET' not compiled in

A test may be flagged as 'todo'.  This indicates that you expect the test
to fail (perhaps because the necessary functionality hasn't been written
yet).  'todo' tests are expected to fail, so when they start working the
test framework can alert you to this happy occurrence.  Flag these tests 
with a '# TODO' comment after the test name

    not ok 1 - infiniteloop # TODO write test for an infinite loop

This is modelled on the protocol followed by the Test::Harness Perl
module (and therefore much of the automated testing carried out by the 
Perl community).  More documentation can be found at:

    http://search.cpan.org/~petdance/Test-Harness-2.42/lib/Test/Harness.pm

To run the tests and parse their output install the devel/p5-Test-Harness
port.  This includes the prove(1) command which is used to run the tests
and collate the output.

    prove geom_concat		# run all the tests in geom_concat
    prove -r lib		# run all tests in lib/, and subdirectories
    prove -r -v lib		# as above, with verbose output
    prove -r			# run *all* the tests

Tests that are for parts of the base system should go into a directory here
which is the same as their path relative to src/, for example the uuencode(1)
utility resides in src/usr.bin/uuencode so its regression test resides in
src/tools/regression/usr.bin/uuencode.

To avoid the pre-commit check program complaining about the lack of
CVS keywords in test data files, use a .in suffix for input files and
a .out suffix for output files.

To execute individual regression tests for binaries that you are
developing, add their directory in the path before running the tests.
Example:
cd /usr/src/tools/regression/usr.bin
(PATH=/home/user/src/experimental/jot:$PATH ; make SUBDIR=jot)

Please make a subdir per other regression test, and add a brief description to
this file.

acct		Exercise the integer to float conversion used in acct(5)
geom		Some tests and an out-of-kernel simulator for the GEOM code
nfsmmap		Some tests to exercise some tricky cases in NFS and mmap
p1003_1b	Exercise 1003.1B scheduler
pipe		Pipe code regression test
fsx		General filesystem exerciser
sysvmsg 	SysV IPC Message Queue Regression Utility
sysvsem 	SysV IPC Semaphore Regression Utility
sysvshm 	SysV IPC Shared Memory Regression Utility
gaithrstress	General threaded getaddrinfo(3) exerciser
date		Date(1) + format string regression test