and added files
[bcm963xx.git] / userapps / opensource / net-snmp / testing / README
1
2 README testing/
3 ===============
4
5 All tests may be run using the following:
6
7         % eval_suite.sh -l
8
9 This runs all the registered tests and reports whether they passed, or not.
10 Some information is given about the nature of test failures (if they occur).
11
12
13 Tests need to be written so that the string "FAILED" is associated with
14 failed sections, and "SUCCESS" with proper closure of a section or
15 function.  The number of SUCCESSes to check for during evaluation is
16 given in the eval_testlist file.
17
18 If a test has no FAILEDs and and the proper number of SUCCESSes, it is
19 considered to have PASSED.  If a test has any FAILEDs or does not achieve
20 the proper number of SUCCESSes, some diagnostic info it output to help
21 determine what happened.
22
23 The test templates for C and Bourne Shell code are T.c and T.sh.  They
24 provide an example of how a test should be instrumented to fit into this
25 scheme.
26
27
28 See also the help output of:
29
30         % eval_suite.sh -h
31         % eval_oneprogram.sh -h
32
33 For a description of the format of "eval_testlist" and what one gets by
34 running with the verbose switches set.
35
36
37
38                 #               #               #               #
39
40
41 FILE LISTING
42 ============
43
44 Test suite control scripts
45 --------------------------
46 eval_oneprogram.sh      Runs a single program taken from eval_testlist.
47
48 eval_suite.sh           Runs all programs in evel_testlist and verifies
49                                 the number of SUCCESSes and FAILUREs
50                                 for each to judge the health of the test.
51
52 eval_testlist           List of current tests.  ADD NEW TESTS HERE.
53
54
55
56 C tests
57 -------
58 etimetest.c             Test of LCD EngineID and Time List.
59 keymanagetest.c         Test for key management functions.
60 misctest.c              Miscellaneous tests: currently, dump_snmpEngineID().
61 scapitest.c             Test for SCAPI functions.
62
63
64
65 Script tests
66 ------------
67 test_keychange.sh       Test KeyChange TC against a gold standard.
68 test_kul.sh             Test other key manipulation functions against
69                                 gold standard.
70
71
72
73 Data files  ("Gold standards")
74 ------------------------------
75         Data files for pre-existing tests.
76         Syntax of the name is: "data.<test_sub_name>-<modifier_for_each_part>"
77
78 data.keychange-md5
79 data.keychange-sha1
80 data.keychange-sha1-des
81 data.kul-md5
82 data.kul-sha1           
83
84
85
86 Test templates and tools environment
87 ------------------------------------
88 test_tools.sh           Standard environment to include in script tests.
89 T.c
90 T.sh                    Templates for future C and sh tests.
91
92