1d95e11bfSDag-Erling SmørgravOverview. 2d95e11bfSDag-Erling Smørgrav 3d95e11bfSDag-Erling Smørgrav$ ./configure && make tests 4d95e11bfSDag-Erling Smørgrav 5d95e11bfSDag-Erling SmørgravYou'll see some progress info. A failure will cause either the make to 6d95e11bfSDag-Erling Smørgravabort or the driver script to report a "FATAL" failure. 7d95e11bfSDag-Erling Smørgrav 8d95e11bfSDag-Erling SmørgravThe test consists of 2 parts. The first is the file-based tests which is 9d95e11bfSDag-Erling Smørgravdriven by the Makefile, and the second is a set of network or proxycommand 10d95e11bfSDag-Erling Smørgravbased tests, which are driven by a driver script (test-exec.sh) which is 11d95e11bfSDag-Erling Smørgravcalled multiple times by the Makefile. 12d95e11bfSDag-Erling Smørgrav 13d95e11bfSDag-Erling SmørgravFailures in the first part will cause the Makefile to return an error. 14d95e11bfSDag-Erling SmørgravFailures in the second part will print a "FATAL" message for the failed 15d95e11bfSDag-Erling Smørgravtest and continue. 16d95e11bfSDag-Erling Smørgrav 17d95e11bfSDag-Erling SmørgravOpenBSD has a system-wide regression test suite. OpenSSH Portable's test 18d95e11bfSDag-Erling Smørgravsuite is based on OpenBSD's with modifications. 19d95e11bfSDag-Erling Smørgrav 20d95e11bfSDag-Erling Smørgrav 21d95e11bfSDag-Erling SmørgravEnvironment variables. 22d95e11bfSDag-Erling Smørgrav 23d95e11bfSDag-Erling SmørgravSUDO: path to sudo command, if desired. Note that some systems (notably 24d95e11bfSDag-Erling Smørgrav systems using PAM) require sudo to execute some tests. 25efcad6b7SDag-Erling SmørgravTEST_SSH_TRACE: set to "yes" for verbose output from tests 26d95e11bfSDag-Erling SmørgravTEST_SSH_QUIET: set to "yes" to suppress non-fatal output. 27d95e11bfSDag-Erling SmørgravTEST_SSH_x: path to "ssh" command under test, where x=SSH,SSHD,SSHAGENT,SSHADD 28d95e11bfSDag-Erling Smørgrav SSHKEYGEN,SSHKEYSCAN,SFTP,SFTPSERVER 29d95e11bfSDag-Erling SmørgravOBJ: used by test scripts to access build dir. 30d74d50a8SDag-Erling SmørgravTEST_SHELL: shell used for running the test scripts. 31d74d50a8SDag-Erling SmørgravTEST_SSH_PORT: TCP port to be used for the listening tests. 32d74d50a8SDag-Erling SmørgravTEST_SSH_SSH_CONFOTPS: Configuration directives to be added to ssh_config 33d74d50a8SDag-Erling Smørgrav before running each test. 34d74d50a8SDag-Erling SmørgravTEST_SSH_SSHD_CONFOTPS: Configuration directives to be added to sshd_config 35d74d50a8SDag-Erling Smørgrav before running each test. 36d95e11bfSDag-Erling Smørgrav 37d95e11bfSDag-Erling Smørgrav 38d95e11bfSDag-Erling SmørgravIndividual tests. 39d95e11bfSDag-Erling Smørgrav 40d74d50a8SDag-Erling SmørgravYou can run an individual test from the top-level Makefile, eg: 41d74d50a8SDag-Erling Smørgrav$ make tests LTESTS=agent-timeout 42d74d50a8SDag-Erling Smørgrav 43d74d50a8SDag-Erling SmørgravIf you need to manipulate the environment more you can invoke test-exec.sh 44d74d50a8SDag-Erling Smørgravdirectly if you set up the path to find the binaries under test and the 45d74d50a8SDag-Erling Smørgravtest scripts themselves, for example: 46d95e11bfSDag-Erling Smørgrav 47d95e11bfSDag-Erling Smørgrav$ cd regress 48d74d50a8SDag-Erling Smørgrav$ PATH=`pwd`/..:$PATH:. TEST_SHELL=/bin/sh sh test-exec.sh `pwd` \ 49d74d50a8SDag-Erling Smørgrav agent-timeout.sh 50d95e11bfSDag-Erling Smørgravok agent timeout test 51d95e11bfSDag-Erling Smørgrav 52d95e11bfSDag-Erling Smørgrav 53d95e11bfSDag-Erling SmørgravFiles. 54d95e11bfSDag-Erling Smørgrav 55d95e11bfSDag-Erling Smørgravtest-exec.sh: the main test driver. Sets environment, creates config files 56d95e11bfSDag-Erling Smørgravand keys and runs the specified test. 57d95e11bfSDag-Erling Smørgrav 58d95e11bfSDag-Erling SmørgravAt the time of writing, the individual tests are: 59d95e11bfSDag-Erling Smørgravagent-timeout.sh: agent timeout test 60d95e11bfSDag-Erling Smørgravagent.sh: simple agent test 61d95e11bfSDag-Erling Smørgravbroken-pipe.sh: broken pipe test 62d95e11bfSDag-Erling Smørgravconnect-privsep.sh: proxy connect with privsep 63d95e11bfSDag-Erling Smørgravconnect.sh: simple connect 64d95e11bfSDag-Erling Smørgravexit-status.sh: remote exit status 65d95e11bfSDag-Erling Smørgravforwarding.sh: local and remote forwarding 66d95e11bfSDag-Erling Smørgravkeygen-change.sh: change passphrase for key 67d95e11bfSDag-Erling Smørgravkeyscan.sh: keyscan 68d95e11bfSDag-Erling Smørgravproto-mismatch.sh: protocol version mismatch 69d95e11bfSDag-Erling Smørgravproto-version.sh: sshd version with different protocol combinations 70d95e11bfSDag-Erling Smørgravproxy-connect.sh: proxy connect 71d95e11bfSDag-Erling Smørgravsftp.sh: basic sftp put/get 72d95e11bfSDag-Erling Smørgravssh-com-client.sh: connect with ssh.com client 73d95e11bfSDag-Erling Smørgravssh-com-keygen.sh: ssh.com key import 74d95e11bfSDag-Erling Smørgravssh-com-sftp.sh: basic sftp put/get with ssh.com server 75d95e11bfSDag-Erling Smørgravssh-com.sh: connect to ssh.com server 76d95e11bfSDag-Erling Smørgravstderr-after-eof.sh: stderr data after eof 77d95e11bfSDag-Erling Smørgravstderr-data.sh: stderr data transfer 78d95e11bfSDag-Erling Smørgravtransfer.sh: transfer data 79d95e11bfSDag-Erling Smørgravtry-ciphers.sh: try ciphers 80d95e11bfSDag-Erling Smørgravyes-head.sh: yes pipe head 81d95e11bfSDag-Erling Smørgrav 82d95e11bfSDag-Erling Smørgrav 83d95e11bfSDag-Erling SmørgravProblems? 84d95e11bfSDag-Erling Smørgrav 85d95e11bfSDag-Erling SmørgravRun the failing test with shell tracing (-x) turned on: 86d95e11bfSDag-Erling Smørgrav$ PATH=`pwd`/..:$PATH:. sh -x test-exec.sh `pwd` agent-timeout.sh 87d95e11bfSDag-Erling Smørgrav 88d95e11bfSDag-Erling SmørgravFailed tests can be difficult to diagnose. Suggestions: 89d95e11bfSDag-Erling Smørgrav- run the individual test via ./test-exec.sh `pwd` [testname] 90d95e11bfSDag-Erling Smørgrav- set LogLevel to VERBOSE in test-exec.sh and enable syslogging of 91d95e11bfSDag-Erling Smørgrav auth.debug (eg to /var/log/authlog). 92d95e11bfSDag-Erling Smørgrav 93d95e11bfSDag-Erling Smørgrav 94d95e11bfSDag-Erling SmørgravKnown Issues. 95d95e11bfSDag-Erling Smørgrav 9652028650SDag-Erling Smørgrav- If your build requires ssh-rand-helper regress tests will fail 9752028650SDag-Erling Smørgrav unless ssh-rand-helper is in pre-installed (the path to 9852028650SDag-Erling Smørgrav ssh-rand-helper is hard coded). 99efcad6b7SDag-Erling Smørgrav 100d74d50a8SDag-Erling Smørgrav- Recent GNU coreutils deprecate "head -[n]": this will cause the yes-head 101d74d50a8SDag-Erling Smørgrav test to fail. The old behaviour can be restored by setting (and 102d74d50a8SDag-Erling Smørgrav exporting) _POSIX2_VERSION=199209 before running the tests. 103d74d50a8SDag-Erling Smørgrav 104d74d50a8SDag-Erling Smørgrav$Id: README.regress,v 1.9 2004/08/17 12:31:33 dtucker Exp $ 105