openssh/regress
Darren Tucker e045e0c62a - dtucker@cvs.openbsd.org 2008/06/10 23:13:43
[Makefile regress/key-options.sh]
     Add regress test for key options.  ok djm@
2008-06-11 09:38:12 +10:00
..
.cvsignore
addrmatch.sh - (dtucker) [Makefile.in configure.ac regress/addrmatch.sh] Skip IPv6 2008-06-11 04:15:05 +10:00
agent-getpeereid.sh - jmc@cvs.openbsd.org 2007/11/25 15:35:09 2008-03-12 23:58:55 +11:00
agent-ptrace.sh - (dtucker) [regress/agent-ptrace.sh] Make ttrace gdb error a little more 2007-03-03 09:42:23 +11:00
agent-timeout.sh
agent.sh - jmc@cvs.openbsd.org 2007/11/25 15:35:09 2008-03-12 23:58:55 +11:00
banner.sh
broken-pipe.sh
brokenkeys.sh
bsd.regress.mk
cfgmatch.sh - dtucker@cvs.openbsd.org 2006/12/13 08:36:36 2007-10-26 14:45:13 +10:00
cipher-speed.sh - pvalchev@cvs.openbsd.org 2007/06/07 19:41:46 2007-10-26 14:45:57 +10:00
connect-privsep.sh
connect.sh
dsa_ssh2.prv
dsa_ssh2.pub
dynamic-forward.sh
envpass.sh
exit-status.sh
forcecommand.sh
forwarding.sh
key-options.sh - dtucker@cvs.openbsd.org 2008/06/10 23:13:43 2008-06-11 09:38:12 +10:00
keygen-change.sh
keyscan.sh
localcommand.sh - (tim) [regress/localcommand.sh] Shell portability fix. Reported by imorgan at 2008-03-14 11:02:51 -07:00
login-timeout.sh
Makefile fix version tag 2008-06-11 01:33:21 +10:00
multiplex.sh
proto-mismatch.sh
proto-version.sh
proxy-connect.sh
putty-ciphers.sh - djm@cvs.openbsd.org 2007/12/21 04:13:53 2008-03-13 00:17:00 +11:00
putty-kex.sh - djm@cvs.openbsd.org 2007/12/21 04:13:53 2008-03-13 00:17:00 +11:00
putty-transfer.sh - djm@cvs.openbsd.org 2007/12/21 04:13:53 2008-03-13 00:17:00 +11:00
README.regress
reconfigure.sh
reexec.sh
rekey.sh
rsa_openssh.prv
rsa_openssh.pub
rsa_ssh2.prv
runtests.sh
scp-ssh-wrapper.sh
scp.sh
sftp-badcmds.sh - djm@cvs.openbsd.org 2008/03/24 21:46:54 2008-03-27 11:26:56 +11:00
sftp-batch.sh
sftp-cmds.sh - (tim) [regress/sftp-cmds.sh] s/cd/lcd/ in lls test. Reported by 2008-03-14 10:39:17 -07:00
sftp-glob.sh - (tim) [regress/sftp-glob.sh] Shell portability fix. 2008-03-07 19:00:33 -08:00
sftp.sh
ssh2putty.sh - (tim) [regress/sftp-cmds.sh regress/ssh2putty.sh] Shell portability fixes 2008-03-13 18:21:06 -07:00
ssh-com-client.sh
ssh-com-keygen.sh
ssh-com-sftp.sh
ssh-com.sh
sshd-log-wrapper.sh
stderr-after-eof.sh
stderr-data.sh
t4.ok
t5.ok
test-exec.sh - dtucker@cvs.openbsd.org 2008/06/10 15:28:49 2008-06-11 01:39:38 +10:00
transfer.sh
try-ciphers.sh - pvalchev@cvs.openbsd.org 2007/06/07 19:41:46 2007-10-26 14:45:57 +10:00
yes-head.sh

Overview.

$ ./configure && make tests

You'll see some progress info. A failure will cause either the make to
abort or the driver script to report a "FATAL" failure.

The test consists of 2 parts. The first is the file-based tests which is
driven by the Makefile, and the second is a set of network or proxycommand
based tests, which are driven by a driver script (test-exec.sh) which is
called multiple times by the Makefile.

Failures in the first part will cause the Makefile to return an error.
Failures in the second part will print a "FATAL" message for the failed
test and continue.

OpenBSD has a system-wide regression test suite. OpenSSH Portable's test
suite is based on OpenBSD's with modifications.


Environment variables.

SUDO: path to sudo command, if desired. Note that some systems (notably
	systems using PAM) require sudo to execute some tests.
TEST_SSH_TRACE: set to "yes" for verbose output from tests 
TEST_SSH_QUIET: set to "yes" to suppress non-fatal output.
TEST_SSH_x: path to "ssh" command under test, where x=SSH,SSHD,SSHAGENT,SSHADD
	SSHKEYGEN,SSHKEYSCAN,SFTP,SFTPSERVER
OBJ: used by test scripts to access build dir.
TEST_SHELL: shell used for running the test scripts.
TEST_SSH_PORT: TCP port to be used for the listening tests.
TEST_SSH_SSH_CONFOTPS: Configuration directives to be added to ssh_config
	before running each test.
TEST_SSH_SSHD_CONFOTPS: Configuration directives to be added to sshd_config
	before running each test.


Individual tests.

You can run an individual test from the top-level Makefile, eg:
$ make tests LTESTS=agent-timeout

If you need to manipulate the environment more you can invoke test-exec.sh
directly if you set up the path to find the binaries under test and the
test scripts themselves, for example:

$ cd regress
$ PATH=`pwd`/..:$PATH:. TEST_SHELL=/bin/sh sh test-exec.sh `pwd` \
    agent-timeout.sh
ok agent timeout test


Files.

test-exec.sh: the main test driver. Sets environment, creates config files
and keys and runs the specified test.

At the time of writing, the individual tests are:
agent-timeout.sh:	agent timeout test
agent.sh:		simple agent test
broken-pipe.sh:		broken pipe test
connect-privsep.sh:	proxy connect with privsep
connect.sh:		simple connect
exit-status.sh:		remote exit status
forwarding.sh:		local and remote forwarding
keygen-change.sh:	change passphrase for key
keyscan.sh:		keyscan
proto-mismatch.sh:	protocol version mismatch
proto-version.sh:	sshd version with different protocol combinations
proxy-connect.sh:	proxy connect
sftp.sh:		basic sftp put/get
ssh-com-client.sh:	connect with ssh.com client
ssh-com-keygen.sh:	ssh.com key import
ssh-com-sftp.sh:	basic sftp put/get with ssh.com server
ssh-com.sh:		connect to ssh.com server
stderr-after-eof.sh:	stderr data after eof
stderr-data.sh:		stderr data transfer
transfer.sh:		transfer data
try-ciphers.sh:		try ciphers
yes-head.sh:		yes pipe head


Problems?

Run the failing test with shell tracing (-x) turned on:
$ PATH=`pwd`/..:$PATH:. sh -x test-exec.sh `pwd` agent-timeout.sh

Failed tests can be difficult to diagnose. Suggestions:
- run the individual test via ./test-exec.sh `pwd` [testname]
- set LogLevel to VERBOSE in test-exec.sh and enable syslogging of
  auth.debug (eg to /var/log/authlog).


Known Issues.

- If your build requires ssh-rand-helper regress tests will fail
  unless ssh-rand-helper is in pre-installed (the path to
  ssh-rand-helper is hard coded).

- Similarly, if you do not have "scp" in your system's $PATH then the
  multiplex scp tests will fail (since the system's shell startup scripts
  will determine where the shell started by sshd will look for scp).

- Recent GNU coreutils deprecate "head -[n]": this will cause the yes-head
  test to fail.  The old behaviour can be restored by setting (and
  exporting) _POSIX2_VERSION=199209 before running the tests.

$Id: README.regress,v 1.10 2005/10/03 10:14:18 dtucker Exp $