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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2003-2024. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
-module(test_lib).
-include_lib("common_test/include/ct.hrl").
-compile({no_auto_import,[binary_part/2]}).
-export([id/1,recompile/1,recompile_core/1,parallel/0,
uniq/0,opt_opts/1,get_data_dir/1,
is_cloned_mod/1,smoke_disasm/1,p_run/2,p_run/3,
highest_opcode/1]).
%% Used by test case that override BIFs.
-export([binary_part/2,binary/1]).
id(I) -> I.
recompile(Mod) when is_atom(Mod) ->
case whereis(cover_server) of
undefined -> ok;
_ ->
%% Re-compile the test suite if the cover server is running.
Beam = code:which(Mod),
Src = filename:rootname(Beam, ".beam") ++ ".erl",
Opts = [bin_opt_info,recv_opt_info|opt_opts(Mod)],
io:format("Recompiling ~p (~p)\n", [Mod,Opts]),
c:c(Src, [{outdir,filename:dirname(Src)}|Opts])
end,
%% Smoke-test of beam disassembler.
smoke_disasm(Mod).
recompile_core(Mod) when is_atom(Mod) ->
case whereis(cover_server) of
undefined -> ok;
_ ->
%% Re-compile the test suite if the cover server is running.
Beam = code:which(Mod),
Src = filename:rootname(Beam, ".beam"),
Opts = [bin_opt_info,recv_opt_info|opt_opts(Mod)],
io:format("Recompiling ~p (~p)\n", [Mod,Opts]),
c:c(Src, [from_core,{outdir,filename:dirname(Src)}|Opts])
end,
%% Smoke-test of beam disassembler.
smoke_disasm(Mod).
smoke_disasm(Mod) when is_atom(Mod) ->
smoke_disasm(code:which(Mod));
smoke_disasm(File) when is_list(File) ->
Res = beam_disasm:file(File),
{beam_file,_Mod} = {element(1, Res),element(2, Res)}.
parallel() ->
case erlang:system_info(schedulers) =:= 1 of
true -> [];
false -> [parallel]
end.
uniq() ->
U = erlang:unique_integer([positive]),
"_" ++ integer_to_list(U).
%% Retrieve the "interesting" compiler options (options for optimization
%% and compatibility) for the given module.
opt_opts(Mod) ->
Comp = Mod:module_info(compile),
%% `options` may not be set at all if +deterministic is enabled.
Opts = proplists:get_value(options, Comp, []),
lists:filter(fun
(debug_info) -> true;
(dialyzer) -> true;
({feature,_,enable}) -> true;
({feature,_,disable}) -> true;
(inline) -> true;
(line_coverage) -> true;
(no_badrecord) -> true;
(no_bs_create_bin) -> true;
(no_bsm_opt) -> true;
(no_bs_match) -> true;
(no_copt) -> true;
(no_fun_opt) -> true;
(no_min_max_bifs) -> true;
(no_module_opt) -> true;
(no_postopt) -> true;
(no_recv_opt) -> true;
(no_share_opt) -> true;
(no_ssa_opt_float) -> true;
(no_ssa_opt_ranges) -> true;
(no_ssa_opt) -> true;
(no_stack_trimming) -> true;
(no_type_opt) -> true;
(_) -> false
end, Opts).
%% Some test suites gets cloned (e.g. to "record_SUITE" to
%% "record_no_opt_SUITE"), but the data directory is not cloned.
%% This function retrieves the path to the original data directory.
get_data_dir(Config) ->
Data = proplists:get_value(data_dir, Config),
Opts = [{return,list}],
Suffixes = ["_no_opt_SUITE",
"_no_copt_SUITE",
"_no_copt_ssa_SUITE",
"_post_opt_SUITE",
"_inline_SUITE",
"_no_module_opt_SUITE",
"_no_type_opt_SUITE",
"_no_ssa_opt_SUITE",
"_cover_SUITE"],
lists:foldl(fun(Suffix, Acc) ->
Opts = [{return,list}],
re:replace(Acc, Suffix, "_SUITE", Opts)
end, Data, Suffixes).
is_cloned_mod(Mod) ->
is_cloned_mod_1(atom_to_list(Mod)).
%% Test whether Mod is a cloned module. We don't consider modules
%% compiled with compatibility for an older release cloned (that
%% will improve coverage).
is_cloned_mod_1("_no_opt_SUITE") -> true;
is_cloned_mod_1("_no_copt_SUITE") -> true;
is_cloned_mod_1("_no_copt_ssa_SUITE") -> true;
is_cloned_mod_1("_no_ssa_opt_SUITE") -> true;
is_cloned_mod_1("_no_type_opt_SUITE") -> true;
is_cloned_mod_1("_post_opt_SUITE") -> true;
is_cloned_mod_1("_inline_SUITE") -> true;
is_cloned_mod_1("_no_module_opt_SUITE") -> true;
is_cloned_mod_1("_cover_SUITE") -> true;
is_cloned_mod_1([_|T]) -> is_cloned_mod_1(T);
is_cloned_mod_1([]) -> false.
%% Return the highest opcode use in the BEAM module.
highest_opcode(Beam) ->
{ok,{_Mod,[{"Code",Code}]}} = beam_lib:chunks(Beam, ["Code"]),
FormatNumber = 0,
<<16:32,FormatNumber:32,HighestOpcode:32,_/binary>> = Code,
HighestOpcode.
%% p_run(fun(Data) -> ok|error, List) -> ok
%% Will fail the test case if there were any errors.
p_run(Test, List) ->
%% Limit the number of parallel processes to avoid running out of
%% virtual address space or memory. This is especially important
%% on 32-bit Windows, where only 2 GB of virtual address space is
%% available.
N = case {erlang:system_info(schedulers),erlang:system_info(wordsize)} of
{_,4} ->
1;
{N0,8} ->
min(N0, 8)
end,
p_run(Test, List, N).
p_run(Test, List, N) ->
io:format("p_run: ~p parallel processes; ~p jobs\n",
[N,length(List)]),
p_run_loop(Test, List, N, [], 0, 0).
p_run_loop(_, [], _, [], Errors, Ws) ->
case Errors of
0 ->
case Ws of
0 -> ok;
1 -> {comment,"1 warning"};
N -> {comment,integer_to_list(N)++" warnings"}
end;
N ->
ct:fail({N,errors})
end;
p_run_loop(Test, [H|T], N, Refs, Errors, Ws) when length(Refs) < N ->
{_,Ref} = erlang:spawn_monitor(fun() -> exit(Test(H)) end),
p_run_loop(Test, T, N, [Ref|Refs], Errors, Ws);
p_run_loop(Test, List, N, Refs0, Errors0, Ws0) ->
receive
{'DOWN',Ref,process,_,Res} ->
{Errors,Ws} = case Res of
ok -> {Errors0,Ws0};
error -> {Errors0+1,Ws0};
warning -> {Errors0,Ws0+1}
end,
Refs = Refs0 -- [Ref],
p_run_loop(Test, List, N, Refs, Errors, Ws)
end.
%% This is for the misc_SUITE:override_bif testcase
binary_part(_A,_B) ->
dummy.
%% This is for overridden_bif_SUITE.
binary(N) ->
N rem 10 =:= 0.
|
