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
|
-module(ct_suite).
%%------------------------------------------------------------------
%% Test Suite Behaviour
%% ------------------------------------------------------------------
-export_type([ct_testname/0,
ct_groupname/0,
ct_config/0,
ct_status/0,
ct_group_def/0,
ct_test_def/0,
ct_info/0
]).
-type ct_testname() :: atom().
-type ct_groupname() :: atom().
-type ct_config() :: [{Key :: atom(), Value :: term()}].
-type ct_status() :: ok |
skipped |
failed.
-type ct_group_props() :: [
parallel |
sequence |
shuffle |
{shuffle, Seed :: {integer(), integer(), integer()}} |
{ct_group_repeat_type(), ct_test_repeat()}
].
-type ct_group_props_ref() ::
ct_group_props() |
default.
-type ct_group_repeat_type() :: repeat |
repeat_until_all_ok |
repeat_until_all_fail |
repeat_until_any_ok |
repeat_until_any_fail.
-type ct_test_repeat() :: integer() |
forever.
-type ct_group_def() :: {ct_groupname(), ct_group_props(), [
ct_testname() |
ct_group_def() |
{group, ct_groupname()} |
ct_testcase_ref()
]}.
-type ct_subgroups_def() :: {ct_groupname(), ct_group_props_ref()} |
{ct_groupname(), ct_group_props_ref(), ct_subgroups_def()}.
-type ct_group_ref() :: {group, ct_groupname()} |
{group, ct_groupname(), ct_group_props_ref()} |
{group, ct_groupname(), ct_group_props_ref(), ct_subgroups_def()}.
-type ct_testcase_ref() :: {testcase, ct_testname(), ct_testcase_repeat_prop()}.
-type ct_testcase_repeat_prop() :: [{repeat, ct_test_repeat()} |
{repeat_until_ok, ct_test_repeat()} |
{repeat_until_fail, ct_test_repeat()}].
-type ct_info() :: {timetrap, ct_info_timetrap()} |
{require, ct_info_required()} |
{require, Name :: atom(), ct_info_required()} |
{userdata, UserData :: term()} |
{silent_connections, Conns :: [atom()]} |
{stylesheet, CSSFile :: string()} |
{ct_hooks, CTHs :: ct_hooks()}.
-type ct_info_timetrap() :: MilliSec :: integer() |
{seconds, integer()} |
{minutes, integer()} |
{hours, integer()} |
{Mod :: atom(), Func :: atom(), Args :: list()} |
ct_info_timetrap_fun().
-type ct_info_timetrap_fun() :: fun().
-type ct_info_required() :: Key :: atom() |
{Key :: atom(), SubKeys :: ct_info_required_subkeys()} |
{Key :: atom(), SubKey :: atom()} |
{Key :: atom(), SubKey :: atom(), SubKeys :: ct_info_required_subkeys()}.
-type ct_info_required_subkeys() :: SubKey :: atom() |
[SubKey :: atom()].
-type ct_hooks() :: [
CTHModule :: atom() |
{CTHModule :: atom(), CTHInitArgs :: term()} |
{CTHModule :: atom(), CTHInitArgs :: term(), CTHPriority :: integer()}
].
-type ct_test_def() :: ct_testname() | ct_group_ref() | ct_testcase_ref().
-callback all() ->
[TestDef :: ct_test_def()] |
{skip, Reason :: term()}.
-callback groups() ->
[GroupDef :: ct_group_def()].
-callback suite() ->
[Info :: ct_info()].
-callback init_per_suite(Config :: ct_config()) ->
NewConfig :: ct_config() |
{skip, Reason :: term()} |
{skip_and_save, Reason :: term(), SaveConfig :: ct_config()}.
-callback end_per_suite(Config :: ct_config()) ->
term() |
{save_config, SaveConfig :: ct_config()}.
-callback group(GroupName :: ct_groupname()) ->
[Info :: ct_info()].
-callback init_per_group(GroupName :: ct_groupname(), Config :: ct_config()) ->
NewConfig :: ct_config() |
{skip, Reason :: term()}.
-callback end_per_group(GroupName :: ct_groupname(), Config :: ct_config()) ->
term() |
{return_group_result, Status :: ct_status()}.
-callback init_per_testcase(TestCase :: ct_testname(), Config :: ct_config()) ->
NewConfig :: ct_config() |
{fail, Reason :: term()} |
{skip, Reason :: term()}.
-callback end_per_testcase(TestCase :: ct_testname(), Config :: ct_config()) ->
term() |
{fail, Reason :: term()} |
{save_config, SaveConfig :: ct_config()}.
%% only all/0 is mandatory
-optional_callbacks([groups/0,
suite/0,
init_per_suite/1,
end_per_suite/1,
group/1,
init_per_group/2,
end_per_group/2,
init_per_testcase/2,
end_per_testcase/2
]).
|
