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
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2021-2022. 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(error_info_lib).
-export([test_error_info/2, test_error_info/3]).
%% The wrapper fun should behave as if it was apply/3.
%% See os_SUITE for an example usage.
-type wrapper() :: fun((module(),function(),list(term)) -> term()).
%% Options that can be given to testcases
-type option() :: {integer(), Regexp :: string()} | %% Match argument #1 against RegExp
{general, Regexp :: string()} | %% Match general info against RegExp
{wrapper, wrapper()} | %% Wrap the test call using this fun
{gl, pid()} | %% Use this group leader for the test
no_fail | %% The test will not fail
allow_rename | %% Allow the exception to not originate from Func
unexplained. %% Allow the test to not provide any explanation
-type test() :: {Func :: function(), Args :: [term()]} |
{Func :: function(), Args :: [term()], Opts :: list(option())}.
-spec test_error_info(module(), list(test())) -> ok.
test_error_info(Module, List) ->
test_error_info(Module, List, []).
test_error_info(Module, L0, Options) ->
L1 = lists:foldl(fun({_,A}, Acc) when is_integer(A) -> Acc;
({F,A}, Acc) -> [{F,A,[]}|Acc];
({F,A,Opts}, Acc) -> [{F,A,Opts}|Acc]
end, [], L0),
Tests = ordsets:from_list([{F,length(A)} || {F,A,_} <- L1] ++
[{F,A} || {F,A} <- L0, is_integer(A)]),
Bifs0 = get_bifs(Module, Options),
Bifs = ordsets:from_list(Bifs0),
NYI =
case lists:member(allow_nyi, Options) of
false ->
[{F,lists:duplicate(A, '*'),nyi} || {F,A} <- Bifs -- Tests];
true ->
[]
end,
L = lists:sort(NYI ++ L1),
do_error_info(L, Module, []).
get_bifs(Module, Options) ->
case lists:member(snifs_only, Options) of
true ->
[{F,A} || {M,F,A} <- erlang:system_info(snifs),
M =:= Module,
A =/= 0];
false ->
[{F,A} || {F,A} <- Module:module_info(exports),
A =/= 0,
F =/= module_info]
end.
do_error_info([{_,Args,nyi}=H|T], Module, Errors) ->
case lists:all(fun(A) -> A =:= '*' end, Args) of
true ->
do_error_info(T, Module, [{nyi,H}|Errors]);
false ->
do_error_info(T, Module, [{bad_nyi,H}|Errors])
end;
do_error_info([{F,Args,Opts}|T], Module, Errors) ->
eval_bif_error(F, Args, Opts, T, Module, Errors);
do_error_info([], _Module, Errors0) ->
case lists:sort(Errors0) of
[] ->
ok;
[_|_]=Errors ->
io:format("\n~p\n", [Errors]),
ct:fail({length(Errors),errors})
end.
eval_bif_error(F, Args, Opts, T, Module, Errors0) ->
OldGl = group_leader(),
group_leader(proplists:get_value(gl, Opts, OldGl), self()),
Wrapper = proplists:get_value(wrapper, Opts, fun(M, Fun, A) -> apply(M, Fun, A) end),
try Wrapper(Module, F, Args) of
Result ->
group_leader(OldGl, self()),
case lists:member(no_fail, Opts) of
true ->
do_error_info(T, Module, Errors0);
false ->
do_error_info(T, Module, [{should_fail,{F,Args},Result}|Errors0])
end
catch
error:Reason:Stk ->
group_leader(OldGl, self()),
AllowRename = lists:member(allow_rename, Opts),
SF = fun(Mod, _, _) -> Mod =:= test_server end,
Str = erl_error:format_exception(error, Reason, Stk, #{stack_trim_fun => SF}),
BinStr = unicode:characters_to_binary(Str),
ArgStr = lists:join(", ", [io_lib:format("~p", [A]) || A <- Args]),
io:format("\n~p:~p(~s)\n~ts", [Module,F,ArgStr,BinStr]),
ArgumentTests =
case lists:filtermap(
fun({general,Match}) ->
{true,"[*][*][*].*" ++ Match};
({ArgSlot, Match}) when is_integer(ArgSlot) ->
{true,io_lib:format("[*][*][*] argument ~B:.*~ts",[ArgSlot,Match])};
(_) ->
false
end, Opts) of
[] ->
["[*][*][*] argument \\d+:"];
Tests ->
Tests
end,
case Stk of
[{Module,ActualF,ActualArgs,Info}|_] ->
Errors1 =
case lists:member(unexplained, Opts) of
true ->
Errors0;
false ->
lists:foldl(
fun(Match, Errors) ->
case re:run(BinStr, Match, [global, unicode]) of
{match,[_]} ->
Errors;
{match,_} ->
[{too_many_explanations,{F,Args},
Info,BinStr,lists:flatten(Match)}|Errors];
nomatch ->
[{no_explanation,{F,Args},
Info,BinStr,lists:flatten(Match)}|Errors]
end
end, Errors0, ArgumentTests)
end,
Errors = case {ActualF,ActualArgs} of
{F,Args} ->
Errors1;
_ when AllowRename ->
Errors1;
_ ->
[{renamed,{F,length(Args)},{ActualF,ActualArgs}}|Errors1]
end,
do_error_info(T, Module, Errors);
_ when not AllowRename ->
Errors = [{renamed,{F,length(Args)},hd(Stk)}|Errors0],
do_error_info(T, Module, Errors);
_ ->
do_error_info(T, Module, Errors0)
end;
E:R:ST ->
group_leader(OldGl, self()),
erlang:raise(E,R,ST)
end.
|
