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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
%% This library is free software; you can redistribute it and/or modify
%% it under the terms of the GNU Lesser General Public License as
%% published by the Free Software Foundation; either version 2 of the
%% License, or (at your option) any later version.
%%
%% This library is distributed in the hope that it will be useful, but
%% WITHOUT ANY WARRANTY; without even the implied warranty of
%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
%% Lesser General Public License for more details.
%%
%% You should have received a copy of the GNU Lesser General Public
%% License along with this library; if not, write to the Free Software
%% Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
%% USA
%%
%% @copyright 2004-2009 Mickaël Rémond, Richard Carlsson
%% @author Mickaël Rémond <[email protected]>
%% [http://www.process-one.net/]
%% @author Richard Carlsson <[email protected]>
%% @version {@version}, {@date} {@time}
%% @doc This module is the main EUnit user interface.
-module(eunit).
-include("eunit.hrl").
-include("eunit_internal.hrl").
%% Official exports
-export([start/0, stop/0, test/1, test/2]).
%% Experimental; may be removed or relocated
-export([start/1, stop/1, test/3, submit/1, submit/2, submit/3, watch/1,
watch/2, watch/3, watch_path/1, watch_path/2, watch_path/3,
watch_regexp/1, watch_regexp/2, watch_regexp/3, watch_app/1,
watch_app/2, watch_app/3]).
%% EUnit entry points
%% TODO: Command line interface similar to that of edoc?
%% @doc Starts the EUnit server. Normally, you don't need to call this
%% function; it is started automatically.
start() ->
start(?SERVER).
%% @private
%% @doc See {@link start/0}.
start(Server) ->
eunit_server:start(Server).
%% @doc Stops the EUnit server. Normally, you don't need to call this
%% function.
stop() ->
stop(?SERVER).
%% @private
%% @doc See {@link stop/0}.
stop(Server) ->
eunit_server:stop(Server).
%% @private
watch(Target) ->
watch(Target, []).
%% @private
watch(Target, Options) ->
watch(?SERVER, Target, Options).
%% @private
watch(Server, Target, Options) ->
eunit_server:watch(Server, Target, Options).
%% @private
watch_path(Target) ->
watch_path(Target, []).
%% @private
watch_path(Target, Options) ->
watch_path(?SERVER, Target, Options).
%% @private
watch_path(Server, Target, Options) ->
eunit_server:watch_path(Server, Target, Options).
%% @private
watch_regexp(Target) ->
watch_regexp(Target, []).
%% @private
watch_regexp(Target, Options) ->
watch_regexp(?SERVER, Target, Options).
%% @private
watch_regexp(Server, Target, Options) ->
eunit_server:watch_regexp(Server, Target, Options).
%% @private
watch_app(Name) ->
watch_app(Name, []).
%% @private
watch_app(Name, Options) ->
watch_app(?SERVER, Name, Options).
%% @private
watch_app(Server, Name, Options) ->
case code:lib_dir(Name) of
Path when is_list(Path) ->
watch_path(Server, filename:join(Path, "ebin"), Options);
_ ->
error
end.
%% @equiv test(Tests, [])
test(Tests) ->
test(Tests, []).
%% @spec test(Tests::term(), Options::[term()]) -> ok | {error, term()}
%% @doc Runs a set of tests. The format of `Tests' is described in the
%% section <a
%% href="overview-summary.html#EUnit_test_representation">EUnit test
%% representation</a> of the overview.
%%
%% Example: ```eunit:test(fred)''' runs all tests in the module `fred'
%% and also any tests in the module `fred_tests', if that module exists.
%%
%% Options:
%% <dl>
%% <dt>`verbose'</dt>
%% <dd>Displays more details about the running tests.</dd>
%% </dl>
%%
%% Options in the environment variable EUNIT are also included last in
%% the option list, i.e., have lower precedence than those in `Options'.
%% @see test/1
test(Tests, Options) ->
test(?SERVER, Tests, all_options(Options)).
%% @private
%% @doc See {@link test/2}.
test(Server, Tests, Options) ->
Listeners = listeners(Options),
Serial = eunit_serial:start(Listeners),
case eunit_server:start_test(Server, Serial, Tests, Options) of
{ok, Reference} -> test_run(Reference, Listeners);
{error, R} -> {error, R}
end.
test_run(Reference, Listeners) ->
receive
{start, Reference} ->
cast(Listeners, {start, Reference})
end,
receive
{done, Reference} ->
cast(Listeners, {stop, Reference, self()}),
wait_until_listeners_have_terminated(Listeners),
receive
{result, Reference, Result} ->
Result
end
end.
cast([P | Ps], Msg) ->
P ! Msg,
cast(Ps, Msg);
cast([], _Msg) ->
ok.
wait_until_listeners_have_terminated([P | Ps]) ->
MRef = erlang:monitor(process, P),
receive
{'DOWN', MRef, process, P, _} ->
wait_until_listeners_have_terminated(Ps)
end;
wait_until_listeners_have_terminated([]) ->
ok.
%% TODO: functions that run tests on a given node, not a given server
%% TODO: maybe some functions could check for a globally registered server?
%% TODO: some synchronous but completely quiet interface function
%% @private
submit(T) ->
submit(T, []).
%% @private
submit(T, Options) ->
submit(?SERVER, T, Options).
%% @private
submit(Server, T, Options) ->
Dummy = spawn(fun devnull/0),
eunit_server:start_test(Server, Dummy, T, Options).
listeners(Options) ->
%% note that eunit_tty must always run, because it sends the final
%% {result,...} message that the test_run() function is waiting for
Ls = [{eunit_tty, Options} | proplists:get_all_values(report, Options)],
Ps = start_listeners(Ls),
%% the event_log option is for debugging, to view the raw events
case proplists:get_value(event_log, Options) of
undefined ->
Ps;
X ->
LogFile = if is_list(X) -> X;
true -> "eunit-events.log"
end,
[spawn_link(fun () -> event_logger(LogFile) end) | Ps]
end.
start_listeners([P | Ps]) when is_pid(P) ; is_atom(P) ->
[P | start_listeners(Ps)];
start_listeners([{Mod, Opts} | Ps]) when is_atom(Mod) ->
[Mod:start(Opts) | start_listeners(Ps)];
start_listeners([]) ->
[].
%% TODO: make this report file errors
event_logger(LogFile) ->
case file:open(LogFile, [write]) of
{ok, FD} ->
receive
{start, Reference} ->
event_logger_loop(Reference, FD)
end;
Error ->
exit(Error)
end.
event_logger_loop(Reference, FD) ->
receive
{status, _Id, _Info}=Msg ->
io:fwrite(FD, "~tp.\n", [Msg]),
event_logger_loop(Reference, FD);
{stop, Reference, _ReplyTo} ->
%% no need to reply, just exit
file:close(FD),
exit(normal)
end.
%% TODO: make a proper logger for asynchronous execution with submit/3
devnull() ->
receive _ -> devnull() end.
%% including options from EUNIT environment variable
all_options(Opts) ->
try os:getenv("EUNIT") of
false -> Opts;
S ->
{ok, Ts, _} = erl_scan:string(S),
{ok, V} = erl_parse:parse_term(Ts ++ [{dot,1}]),
if is_list(V) -> Opts ++ V;
true -> Opts ++ [V]
end
catch
_:_ -> Opts
end.
|
