1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
.TH ct_master 3 "common_test 1.3.2" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
ct_master \- Distributed test execution control for Common Test\&.
.SH DESCRIPTION
.LP
Distributed test execution control for Common Test\&.
.LP
This module exports functions for running Common Test nodes on multiple hosts in parallel\&.
.SH EXPORTS
.LP
.B
abort() -> ok
.br
.RS
.LP
Stops all running tests\&.
.RE
.LP
.B
abort(Nodes) -> ok
.br
.RS
.TP
Types
Nodes = atom() | [atom()]
.br
.RE
.RS
.LP
Stops tests on specified nodes\&.
.RE
.LP
.B
progress() -> [{Node, Status}]
.br
.RS
.TP
Types
Node = atom()
.br
Status = finished_ok | ongoing | aborted | {error, Reason}
.br
Reason = term()
.br
.RE
.RS
.LP
Returns test progress\&. If \fIStatus\fR is \fIongoing\fR, tests are running on the node and have not yet finished\&.
.RE
.LP
.B
run(TestSpecs) -> ok
.br
.RS
.TP
Types
TestSpecs = string() | [SeparateOrMerged]
.br
.RE
.RS
.LP
Equivalent to run(TestSpecs, false, [], [])\&.
.RE
.LP
.B
run(TestSpecs, InclNodes, ExclNodes) -> ok
.br
.RS
.TP
Types
TestSpecs = string() | [SeparateOrMerged]
.br
SeparateOrMerged = string() | [string()]
.br
InclNodes = [atom()]
.br
ExclNodes = [atom()]
.br
.RE
.RS
.LP
Equivalent to run(TestSpecs, false, InclNodes, ExclNodes)\&.
.RE
.LP
.B
run(TestSpecs, AllowUserTerms, InclNodes, ExclNodes) -> ok
.br
.RS
.TP
Types
TestSpecs = string() | [SeparateOrMerged]
.br
SeparateOrMerged = string() | [string()]
.br
AllowUserTerms = bool()
.br
InclNodes = [atom()]
.br
ExclNodes = [atom()]
.br
.RE
.RS
.LP
Tests are spawned on the nodes as specified in \fITestSpecs\fR\&. Each specification in TestSpec will be handled separately\&. It is however possible to also specify a list of specifications that should be merged into one before the tests are executed\&. Any test without a particular node specification will also be executed on the nodes in \fIInclNodes\fR\&. Nodes in the \fIExclNodes\fR list will be excluded from the test\&.
.RE
.LP
.B
run_on_node(TestSpecs, Node) -> ok
.br
.RS
.TP
Types
TestSpecs = string() | [SeparateOrMerged]
.br
SeparateOrMerged = string() | [string()]
.br
Node = atom()
.br
.RE
.RS
.LP
Equivalent to run_on_node(TestSpecs, false, Node)\&.
.RE
.LP
.B
run_on_node(TestSpecs, AllowUserTerms, Node) -> ok
.br
.RS
.TP
Types
TestSpecs = string() | [SeparateOrMerged]
.br
SeparateOrMerged = string() | [string()]
.br
AllowUserTerms = bool()
.br
Node = atom()
.br
.RE
.RS
.LP
Tests are spawned on \fINode\fR according to \fITestSpecs\fR\&.
.RE
.LP
.B
run_test(Node, Opts) -> ok
.br
.RS
.TP
Types
Node = atom()
.br
Opts = [OptTuples]
.br
OptTuples = {config, CfgFiles} | {dir, TestDirs} | {suite, Suites} | {testcase, Cases} | {spec, TestSpecs} | {allow_user_terms, Bool} | {logdir, LogDir} | {event_handler, EventHandlers} | {silent_connections, Conns} | {cover, CoverSpecFile}
.br
CfgFiles = string() | [string()]
.br
TestDirs = string() | [string()]
.br
Suites = atom() | [atom()]
.br
Cases = atom() | [atom()]
.br
TestSpecs = string() | [string()]
.br
LogDir = string()
.br
EventHandlers = EH | [EH]
.br
EH = atom() | {atom(), InitArgs} | {[atom()], InitArgs}
.br
InitArgs = [term()]
.br
Conns = all | [atom()]
.br
.RE
.RS
.LP
Tests are spawned on \fINode\fR using \fIct:run_test/1\fR\&.
.RE
|
