openssh/regress/README.regress

   1 Overview.
   2
   3 $ ./configure && make tests
   4
   5 You'll see some progress info. A failure will cause either the make to
   6 abort or the driver script to report a "FATAL" failure.
   7
   8 The test consists of 2 parts. The first is the file-based tests which is
   9 driven by the Makefile, and the second is a set of network or proxycommand
  10 based tests, which are driven by a driver script (test-exec.sh) which is
  11 called multiple times by the Makefile.
  12
  13 Failures in the first part will cause the Makefile to return an error.
  14 Failures in the second part will print a "FATAL" message for the failed
  15 test and continue.
  16
  17 OpenBSD has a system-wide regression test suite. OpenSSH Portable's test
  18 suite is based on OpenBSD's with modifications.
  19
  20
  21 Environment variables.
  22
  23 SUDO: path to sudo command, if desired. Note that some systems (notably
  24         systems using PAM) require sudo to execute some tests.
  25 TEST_SSH_TRACE: set yo "yes" for verbose output from tests
  26 TEST_SSH_QUIET: set to "yes" to suppress non-fatal output.
  27 TEST_SSH_x: path to "ssh" command under test, where x=SSH,SSHD,SSHAGENT,SSHADD
  28         SSHKEYGEN,SSHKEYSCAN,SFTP,SFTPSERVER
  29 OBJ: used by test scripts to access build dir.
  30
  31
  32 Individual tests.
  33
  34 You can invoke test-exec.sh directly if you set up the path to find the
  35 binaries under test and the test scripts themselves, for example:
  36
  37 $ cd regress
  38 $ PATH=`pwd`/..:$PATH:. sh test-exec.sh `pwd` agent-timeout.sh
  39 ok agent timeout test
  40
  41
  42 Files.
  43
  44 test-exec.sh: the main test driver. Sets environment, creates config files
  45 and keys and runs the specified test.
  46
  47 At the time of writing, the individual tests are:
  48 agent-timeout.sh:       agent timeout test
  49 agent.sh:               simple agent test
  50 broken-pipe.sh:         broken pipe test
  51 connect-privsep.sh:     proxy connect with privsep
  52 connect.sh:             simple connect
  53 exit-status.sh:         remote exit status
  54 forwarding.sh:          local and remote forwarding
  55 keygen-change.sh:       change passphrase for key
  56 keyscan.sh:             keyscan
  57 proto-mismatch.sh:      protocol version mismatch
  58 proto-version.sh:       sshd version with different protocol combinations
  59 proxy-connect.sh:       proxy connect
  60 sftp.sh:                basic sftp put/get
  61 ssh-com-client.sh:      connect with ssh.com client
  62 ssh-com-keygen.sh:      ssh.com key import
  63 ssh-com-sftp.sh:        basic sftp put/get with ssh.com server
  64 ssh-com.sh:             connect to ssh.com server
  65 stderr-after-eof.sh:    stderr data after eof
  66 stderr-data.sh:         stderr data transfer
  67 transfer.sh:            transfer data
  68 try-ciphers.sh:         try ciphers
  69 yes-head.sh:            yes pipe head
  70
  71
  72 Problems?
  73
  74 Run the failing test with shell tracing (-x) turned on:
  75 $ PATH=`pwd`/..:$PATH:. sh -x test-exec.sh `pwd` agent-timeout.sh
  76
  77 Failed tests can be difficult to diagnose. Suggestions:
  78 - run the individual test via ./test-exec.sh `pwd` [testname]
  79 - set LogLevel to VERBOSE in test-exec.sh and enable syslogging of
  80   auth.debug (eg to /var/log/authlog).
  81
  82
  83 Known Issues.
  84
  85
  86 $Id$