1ct_master(3)               Erlang Module Definition               ct_master(3)
2
3
4

NAME

6       ct_master - Distributed test execution control for Common Test.
7

DESCRIPTION

9       Distributed test execution control for Common Test.
10
11       This module exports functions for running Common Test nodes on multiple
12       hosts in parallel.
13

EXPORTS

15       abort() -> ok
16
17              Stops all running tests.
18
19       abort(Nodes) -> ok
20
21              Types:
22
23                 Nodes = atom() | [atom()]
24
25              Stops tests on specified nodes.
26
27       basic_html(Bool) -> ok
28
29              Types:
30
31                 Bool = true | false
32
33              If set to true, the ct_master logs are written  on  a  primitive
34              HTML format, not using the Common Test CSS style sheet.
35
36       get_event_mgr_ref() -> MasterEvMgrRef
37
38              Types:
39
40                 MasterEvMgrRef = atom()
41
42              Gets  a  reference  to the Common Test master event manager. The
43              reference can be used to, for example, add a user-specific event
44              handler while tests are running.
45
46              Example:
47
48               gen_event:add_handler(ct_master:get_event_mgr_ref(), my_ev_h, [])
49
50       progress() -> [{Node, Status}]
51
52              Types:
53
54                 Node = atom()
55                 Status = finished_ok | ongoing | aborted | {error, Reason}
56                 Reason = term()
57
58              Returns  test  progress. If Status is ongoing, tests are running
59              on the node and are not yet finished.
60
61       run(TestSpecs) -> ok
62
63              Types:
64
65                 TestSpecs = string() | [SeparateOrMerged]
66
67              Equivalent to ct_master:run(TestSpecs, false, [], []).
68
69       run(TestSpecs, InclNodes, ExclNodes) -> ok
70
71              Types:
72
73                 TestSpecs = string() | [SeparateOrMerged]
74                 SeparateOrMerged = string() | [string()]
75                 InclNodes = [atom()]
76                 ExclNodes = [atom()]
77
78              Equivalent to ct_master:run(TestSpecs, false, InclNodes,  ExclN‐
79              odes).
80
81       run(TestSpecs, AllowUserTerms, InclNodes, ExclNodes) -> ok
82
83              Types:
84
85                 TestSpecs = string() | [SeparateOrMerged]
86                 SeparateOrMerged = string() | [string()]
87                 AllowUserTerms = bool()
88                 InclNodes = [atom()]
89                 ExclNodes = [atom()]
90
91              Tests  are  spawned on the nodes as specified in TestSpecs. Each
92              specification in TestSpec is handled separately. However, it  is
93              also  possible  to specify a list of specifications to be merged
94              into one specification before the tests are executed.  Any  test
95              without  a particular node specification is also executed on the
96              nodes in InclNodes. Nodes in the  ExclNodes  list  are  excluded
97              from the test.
98
99       run_on_node(TestSpecs, Node) -> ok
100
101              Types:
102
103                 TestSpecs = string() | [SeparateOrMerged]
104                 SeparateOrMerged = string() | [string()]
105                 Node = atom()
106
107              Equivalent to ct_master:run_on_node(TestSpecs, false, Node).
108
109       run_on_node(TestSpecs, AllowUserTerms, Node) -> ok
110
111              Types:
112
113                 TestSpecs = string() | [SeparateOrMerged]
114                 SeparateOrMerged = string() | [string()]
115                 AllowUserTerms = bool()
116                 Node = atom()
117
118              Tests are spawned on Node according to TestSpecs.
119
120       run_test(Node, Opts) -> ok
121
122              Types:
123
124                 Node = atom()
125                 Opts = [OptTuples]
126                 OptTuples  =  {config,  CfgFiles} | {dir, TestDirs} | {suite,
127                 Suites} |  {testcase,  Cases}  |  {spec,  TestSpecs}  |  {al‐
128                 low_user_terms,  Bool}  |  {logdir, LogDir} | {event_handler,
129                 EventHandlers} | {silent_connections, Conns} | {cover, Cover‐
130                 SpecFile} | {cover_stop, Bool} | {userconfig, UserCfgFiles}
131                 CfgFiles = string() | [string()]
132                 TestDirs = string() | [string()]
133                 Suites = atom() | [atom()]
134                 Cases = atom() | [atom()]
135                 TestSpecs = string() | [string()]
136                 LogDir = string()
137                 EventHandlers = EH | [EH]
138                 EH = atom() | {atom(), InitArgs} | {[atom()], InitArgs}
139                 InitArgs = [term()]
140                 Conns = all | [atom()]
141
142              Tests are spawned on Node using ct:run_test/1
143
144
145
146Ericsson AB                   common_test 1.25.1                  ct_master(3)