freebsd-dev/tools/regression
Jilles Tjoelker 9d8ca3b2ad nftw(): POSIX says directories causing loops should be silently skipped.
Formerly, loops caused nftw() to abort the traversal with ELOOP.
2012-08-09 22:05:40 +00:00
..
acct tests: sort & fix includes, remove -include from CFLAGS of acct tests 2011-01-06 20:05:24 +00:00
acltools Add test for acl_is_trivial_np(3). 2011-03-22 17:26:56 +00:00
aio - Fix QA issues 2011-02-22 05:13:26 +00:00
atm
audit/audit_pipe_ioctl
bin sh: Add a simple test for the "local" builtin. 2012-07-15 10:22:13 +00:00
bpf
ccd/layout
doat Fix some memory errors in *at() regression tests. 2011-10-18 22:51:40 +00:00
environ
ethernet/ethermulti
execve
fifo Check fchmod()/fchown() in fifo_misc test. 2012-02-26 15:32:02 +00:00
file Spelling fixes for tools/ 2011-12-30 00:04:11 +00:00
filemon Support also running a 32-bit test on 64-bit platforms. 2012-06-29 15:54:07 +00:00
fsx
gaithrstress
geom
geom_concat
geom_eli Fix resize regressions tests - we need to destroy BSDlabel before we can 2011-10-25 13:41:12 +00:00
geom_gate
geom_gpt
geom_mirror
geom_nop
geom_raid3
geom_shsec
geom_stripe
geom_uzip
ia64
include/tgmath
ipfw/fwd Add support for IPv6 to ipfw fwd: 2011-08-20 17:05:11 +00:00
ipsec
kgssapi
kqueue Clarify the meaning of a test. 2011-07-08 12:16:30 +00:00
kthread/kld Spelling fixes for tools/ 2011-12-30 00:04:11 +00:00
lib nftw(): POSIX says directories causing loops should be silently skipped. 2012-08-09 22:05:40 +00:00
mac
mlock
mmap
mqueue
msdosfs Convert files over to UTF-8. 2012-01-05 21:36:53 +00:00
net80211
netatalk/simple_send
netinet Properly initialise the "len" argument to getsockname(2) in the tcpdrop 2011-08-06 19:20:17 +00:00
netinet6
netipx
nfsmmap Spelling fixes for tools/ 2011-12-30 00:04:11 +00:00
p1003_1b
pipe Add a test for r228510. 2011-12-14 23:26:48 +00:00
pjdfstest Recognize 'none' or '0' as no flags. 2012-07-04 17:31:53 +00:00
poll Test the poll(2) return value. 2010-08-28 17:38:40 +00:00
posixsem
posixsem2
posixshm
priv Spelling fixes for tools/ 2011-12-30 00:04:11 +00:00
pthread Reencode files from latin1 to UTF-8. 2011-12-29 12:33:27 +00:00
redzone9
rpcsec_gss
sbin More mdconfig(8) tests. 2012-01-26 18:16:16 +00:00
security Fix order of arguments to lseek(). 2012-02-29 19:50:49 +00:00
sigqueue
sockets Add regression tests for the setsockopt(2) SO_SETFIB socket option. 2012-02-17 03:25:26 +00:00
sysvmsg According to shared memory man pages, advice including <sys/types.h> 2012-05-21 07:52:46 +00:00
sysvsem According to shared memory man pages, advice including <sys/types.h> 2012-05-21 07:52:46 +00:00
sysvshm According to shared memory man pages, advice including <sys/types.h> 2012-05-21 07:52:46 +00:00
tls
tmpfs
ufs/uprintf
usb Add regression test for USB enumeration. 2012-03-01 20:45:17 +00:00
usr.bin Remove the "funny targets" make check. We no longer need embedded :: targets 2012-07-05 18:23:36 +00:00
usr.sbin The etcupdate utility is a tool for managing updates to files that are 2012-07-13 13:23:48 +00:00
vfs
zfs
geom_subr.sh
README Spelling fixes for tools/ 2011-12-30 00:04:11 +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 netatalk tests require 'options NETATALK' in the kernel.
A test may be skipped by printing '# skip Reason for skipping' after the
test name.  For example,

    ok 1 - netatalk # skip 'options NETATALK' 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
ia64		ia64 specific regression tests
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