src/testsuite/README

   1
   2                      ngIRCd - Next Generation IRC Server
   3
   4                       (c)2001-2004 by Alexander Barton,
   5                     alex@barton.de, http://www.barton.de/
   6
   7                ngIRCd is free software and published under the
   8                    terms of the GNU General Public License.
   9
  10                        -- README for the Test Suite --
  11
  12
  13 I. Overview
  14 ~~~~~~~~~~~
  15
  16 The purpose of the "test suite" contained in this directory is to detect
  17 bugs and incompatibilities in ngIRCd introduced during coding and after
  18 building ngIRCd on a specific platform.
  19
  20 To run the "standard" tests call "make check". It will build ngIRCd (if
  21 required) and run some tests on it. These tests should be portable and run
  22 on all supported platforms without errors.
  23
  24 Please note: most tests of this suite depend on the external tools expect(1)
  25 and telnet(1), so make sure you have them installed. If not, the tests will
  26 not fail but simply be skipped.
  27
  28
  29 II. Shell Scripts
  30 ~~~~~~~~~~~~~~~~
  31
  32 getpid.sh <name>
  33
  34         This script is used to detect the PID of the running process with
  35         the given name in a portable manner. The result is echoed on the
  36         console. It is a helper script for some other scripts of this suite.
  37
  38 start-server.sh
  39
  40         start-server.sh starts up the test binary, "T-ngircd". It makes sure
  41         that getpid.sh is available and working, and that no other instance
  42         of the test binary is already running.
  43         The exit code is 0 if the test binary could be started.
  44
  45 stop-server.sh
  46
  47         This script uses getpid.sh to detect a running test binary "T-ngircd"
  48         and then shuts it down using the TERM signal.
  49         The exit code is 0 if the test binary could be stopped.
  50
  51 stress-server.sh
  52
  53         ...
  54
  55 tests.sh
  56
  57         ...
  58
  59
  60 III. Scripts for expect(1)
  61 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  62
  63 channel-test.e
  64 check-idle.e
  65 connect-test.e
  66 mode-test.e
  67 stress-A.e
  68 stress-B.e
  69
  70
  71 --
  72 $Id: README,v 1.1 2004/09/04 13:58:31 alex Exp $