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