tests: Update README files and add new README files where missing
[vlendec/samba-autobuild/.git] / ctdb / tests / eventscripts / README
1 eventscript unit tests
2 ======================
3
4 This directory contains some eventscript unit tests for CTDB.  These
5 tests can be run as a non-privileged user.  There are a lot of stub
6 implementations of commands (located in stubs/) used to make the
7 eventscripts think they're running against a real system.
8
9 Test case filenames look like:
10
11   <eventscript>.<event>.NNN.sh
12
13 The test helper functions will run <eventscript> with specified
14 options.  If using the simple_test() or iterate_test() helper
15 functions then the 1st <event> argument is automatically passed.  When
16 simple_test_event() is used the event name must be explicitly passed
17 as the 1st argument - this is more flexible and supports multiple
18 events per test.
19
20 Examples:
21
22 * ../run_tests.sh .
23
24   Run all tests, displaying minimal output.
25
26 * ../run_tests.sh -s .
27
28   Run all tests, displaying minimal output and a summary.
29
30 * ../run_tests.sh -s ./10.interface.*.sh
31
32   Run all the tests against the 10.interface eventscript.
33
34 * ../run_tests.sh -v -s .
35
36   Run all tests, displaying extra output and a summary.
37
38 * ../run_tests.sh -sq .
39
40   Run all tests, displaying only a summary.
41
42 * ../run_tests.sh -X ./10.interface.startup.002.sh
43
44   Run a test and have the eventscript itself run with "sh -x".  This
45   will usually make a test fail because the (undesirable) trace output
46   will be included with the output of the eventscript.  However, this
47   is useful for finding out why a test might be failing.