selftest: Add some more documentation. Rename env => target to avoid confusion.
[ira/wip.git] / source / selftest / README
1 # vim: ft=rst
2
3 This directory contains test scripts that are useful for running a
4 bunch of tests all at once. 
5
6 ===============
7 Available tests
8 ===============
9 The available tests are obtained from a script, usually 
10 selftest/samba{3,4}_tests.sh. This script should for each test output 
11 the name of the test, the command to run and the environment that should be 
12 provided.
13
14 ============
15 Environments
16 ============
17 Tests often need to run against a server with particular things set up, 
18 a "environment". This environment is provided by the test "target": Samba 3, 
19 Samba 4 or Windows.
20
21 The following environments are currently available:
22
23  - none: No server set up, no variables set.
24  - dc: Domain controller set up. The following environment variables will 
25    be set:
26      * USERNAME: Administrator user name
27          * PASSWORD: Administrator password
28          * DOMAIN: Domain name
29          * REALM: Realm name
30          * SERVER: DC host name 
31          * SERVER_IP: DC IPv4 address
32          * NETBIOSNAME: DC NetBIOS name
33          * NETIOSALIAS: DC NetBIOS alias
34
35  - member: Domain controller and member server that is joined to it set up. The
36    following environment variables will be set:
37      * USERNAME: Domain administrator user name
38          * PASSWORD: Domain administrator password
39          * DOMAIN: Domain name
40          * REALM: Realm name
41          * SERVER: Name of the member server