- fixed include path
[strongswan.git] / testing / README
1
2                  ------------------------------------
3                   strongSwan UML - Running the Tests
4                  ------------------------------------
5
6
7 Contents
8 --------
9
10    1. Starting up the UML testing environment
11    2. Running the automated tests
12    3. Manual testing
13
14
15 1. Starting up the UML testing environment
16    ---------------------------------------
17   
18 When the strongSwan UML testing environment has been put into place by
19 running the "make-testing" script then you are ready to start up the
20 UML instances by calling
21
22     ./start-testing <hosts>
23     
24 This main script first calls the subscript
25
26     scripts/start-switches
27
28 that starts the three UML switches umlswitch0, umlswitch1, and umlswitch2
29 which are connecting the UML instances among each other and via tun/tap
30 devices also make them accessible from the host system.
31       
32 Then depending on the setting of the UMLSTARTMODE variable defined
33 in "testing.conf", the UML instances given on the command line are started
34 up with different terminals:
35
36 If you are running the KDE graphical environment then by setting
37
38     UMLSTARTMODE=konsole
39     
40 the script
41
42     scripts/kstart-umls <hosts>
43      
44 is called which starts up each of the UML instances defined by <hosts> in
45 a KDE konsole. If
46
47     UMLSTARTMODE=xterm
48
49 is set then
50  
51     scripts/xstart-umls <hosts>
52     
53 starts up the UML instances in an xterm each. And with the choice
54
55     UMLSTARTMODE=screen
56    
57 the instances are started up by
58
59     scripts/start-umls <hosts>
60     
61 in the background but the Linux command "screen -r <host>" can be used to
62 connect a terminal to the UML instance <host> if desired.
63
64
65     if [ $ENABLE_DO_TESTS = "yes" ]
66     then
67         do-tests
68     fi
69
70 either executes all the tests defined in the "testing/tests" directory
71 if the variable SELECTEDTESTSONLY in "testing.conf" is set to "no" or the
72 selected tests defined by the string in SELELECTEDTESTS if SELECTEDTESTSONLY
73 is set to "yes".
74
75     if [ $ENABLE_STOP_TESTING = "yes" ]
76     then
77         stop-testing <hosts>
78     fi
79
80 stops the both the UML switches and the UML instances designated by the
81 <hosts> argument.
82
83
84 2. Running the automated tests
85    ---------------------------
86
87 The script
88
89     ./do-tests <testnames>
90
91 runs the automated tests. With an empty <testnames> argument the tests
92 as defined in "testing.conf" are executed, otherwise the tests enumerated
93 by the <testnames> argument will be run as shown in the example below.
94
95     ./do-tests net2net-psk net2net-cert
96
97 Each test is divided into the following phases:
98
99     * scripts/load-testconfig <testname>
100       loads the UML hosts with test specific settings if such are provided.
101       
102     * next the "pretest.dat" script found in each test directory is executed.
103       Among other commands, strongSwan is started on the IPsec hosts.
104
105     * the "evaltest.dat" script evaluates if the test has been successful.
106       
107     * the "posttest.dat" script terminates the test e.g. by stopping
108       strongSwan on the IPsec hosts.
109
110     * scripts/restore-defaults <testname>
111       restores the default settings on the UML hosts.
112
113 The test results and configuration settings for all tests settings are stored
114 in a folder labeled with the current date in the directory
115   
116     ~/strongswan-testing/testresults
117      
118 the same results are also automatically transferred to the Apache server
119 running on UML instance "winnetou" and can be accessed via the URL
120
121     http://192.168.0.150/testresults/
122
123
124 3. Manual testing
125    --------------
126    
127 The greates flexibility can be achieved with manual testing. Just set
128    
129     ENABLE_DO_TESTS="no"
130     ENABLE_STOP_TESTING="no"
131        
132 in "testing.conf" and start the UML instances that you want to experiment with
133 by calling
134
135     ./start-testing <hosts>
136     
137 If you want to preload a test scenario with configurations differing from
138 the default values, e.g. when using Preshared Keys then you can do this
139 with the command
140
141     scripts/load-testconfig net2net-psk
142     
143 You can then log onto any UML instance using its konsole, xterm or screen
144 terminal as root with the default password
145
146     tuxmux
147     
148 You can then execute any commands the UML instances, including changing
149 and recompiling the strongSwan source code located in the /root directory.
150
151 After you have finished testing, the default configuration settings can
152 restored with the command
153
154     scripts/restore-defaults net2net-psk
155
156
157 -----------------------------------------------------------------------------
158
159 This file is RCSID $Id: README,v 1.2 2004/12/20 16:26:39 as Exp $
160