gentoo docs have been updated
[openafs-wiki.git] / running_the_test_suite.mdwn
1 ### <a name="Running the Test Suite"></a> Running the Test Suite
2
3 [[OpenAFS]] includes a suite of basic test scripts in the src/tests directory. The tests directory also contains a utility called afs-newcell.pl to create a test cell on a single host. You will need to already have a kerberos server running with an AFS principal and an admin principal. You should also have a partitions mounted as /vicepa and /vicepb for the test volumes. See the src/tests/afs-newcell.pl for details.
4
5 The paths to the binaries and AFS configuration is are written to src/tests/OpenAFS/Dirpaths.pm when the tests are built. This means you must run 'make all' in src/tests before attempting to use afs-newcell.pl. The afs-newcell.pl program must be run as root.
6
7       cd src/tests
8       make all
9       sudo perl afs-newcell.pl
10
11 The afs-newcell.pl program will prompt for the required cell configuration unless started with the --batch options. You will need to specify the name of your new cell, the host name of this machine, the target partition id (a for /vicepa), and the username of the AFS administrator (which must be named 'admin' for the current pts tests).
12
13 You will also need to provide the type of Kerberos server, the name of the Kerberos realm (which can be different than the AFS cell name), and the location of the keytab file that contains the AFS server encryption key and the admin's encryption key. Finally, you may provide any server options for the AFS database and fileservers.
14
15     Server options:
16     What server name should be used? [host.domain.com]
17     What cellname should be used? [testcell]
18     What vice partition? [a]
19     What administrator username? [admin]
20
21     Kerberos options:
22     Which Kerberos is to be used? [MIT]
23     What Kerberos realm? [TESTCELL]
24     What keytab file? [/usr/afs/etc/krb5.keytab]
25
26     Database Server options:
27     ptserver options: []
28     vlserver options: []
29
30     Fileserver options:
31     Use DAFS fileserver (requires DAFS build option)? (yes/no) [no]
32     fileserver options: []
33     volserver options: []
34     salvageserver options: []
35     salvager options: []
36
37 The parameters are optionally saved to a script called run-afs-newcell.sh, in case you need to re-run the setup. Also, the Kerberos parameters for the new cell are saved in the file run-tests.conf. If all goes well, the servers should be running and the client loaded. You should be able to see your new cell at /afs/testcell (or whatever you called your cell). Your cell will have a few, empty test volumes that you should be able to see with a vos listvldb.
38
39 Run the run-tests script to run the AFS test suite. The program can be run as an ordinary user. The keytab file specified when afs-newcell was run will be used to authenticate the admin user for the tests.
40
41       ./run-tests -all
42
43 The output will look something like this,
44
45     Authenticating to cell testcell.
46     ...
47     Running creat1
48     Running mkdir1
49     Running mkdir2
50     ....
51     -----------------------------------------------------------
52     Failed test(s) were:  write-large write-ro ...