tc-testing/creating-plugins/AddingPlugins.txt

1 tdc - Adding plugins for tdc
3 Author: Brenda J. Butler - bjb@mojatatu.com
6 --------------
9 There are some examples in plugin-lib.
11 The plugin can be used to add functionality to the test framework,
14 - adding commands to be run before and/or after the test suite
15 - adding commands to be run before and/or after the test cases
16 - adding commands to be run before and/or after the execute phase of the test cases
17 - ability to alter the command to be run in any phase:
18     pre        (the pre-suite stage)
23     post       (the post-suite stage)
24 - ability to add to the command line args, and use them at run time
29     def __init__(self)
30     def pre_suite(self, testcount, testidlist)     # see "PRE_SUITE" below
31     def post_suite(self, ordinal)                  # see "SKIPPING" below
32     def pre_case(self, test_ordinal, testid)       # see "PRE_CASE" below
33     def post_case(self)
34     def pre_execute(self)
35     def post_execute(self)
36     def adjust_command(self, stage, command)       # see "ADJUST" below
37     def add_args(self, parser)                     # see "ADD_ARGS" below
38     def check_args(self, args, remaining)          # see "CHECK_ARGS" below
44 testidlist (array of test ids for tests that will be run).  This is
48 TAP output.  The tdc.py script will do that for the test suite as
49 defined in the test case, but if the plugin is being used to run extra
50 tests on each test (eg, check for memory leaks on associated
51 co-processes) then that other tap output can be generated in the
52 post-suite method using this info passed in to the pre_suite method.
58 test to be attempted.  It can use this info when outputting
59 the TAP output for the extra test cases.
64 The pre_case method will receive the ordinal number of the test
65 and the test id.  Useful for outputing the extra test results.
104 eg:  raise Exception('plugin xxx, arg -y is wrong, fix it')