2011-01-31 16:43:31 +00:00
|
|
|
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
|
2009-12-31 18:42:53 +00:00
|
|
|
%% ex: ts=4 sw=4 et
|
2009-12-05 22:18:09 +00:00
|
|
|
%% -------------------------------------------------------------------
|
|
|
|
%%
|
|
|
|
%% rebar: Erlang Build Tools
|
|
|
|
%%
|
2010-02-05 17:34:38 +00:00
|
|
|
%% Copyright (c) 2009, 2010 Dave Smith (dizzyd@dizzyd.com)
|
2009-12-05 22:18:09 +00:00
|
|
|
%%
|
|
|
|
%% Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
%% of this software and associated documentation files (the "Software"), to deal
|
|
|
|
%% in the Software without restriction, including without limitation the rights
|
|
|
|
%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
%% copies of the Software, and to permit persons to whom the Software is
|
|
|
|
%% furnished to do so, subject to the following conditions:
|
|
|
|
%%
|
|
|
|
%% The above copyright notice and this permission notice shall be included in
|
|
|
|
%% all copies or substantial portions of the Software.
|
|
|
|
%%
|
|
|
|
%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
%% THE SOFTWARE.
|
|
|
|
%% -------------------------------------------------------------------
|
2010-02-05 17:34:38 +00:00
|
|
|
%% @author Dave Smith <dizzyd@dizzyd.com>
|
|
|
|
%% @doc rebar_eunit supports the following commands:
|
|
|
|
%% <ul>
|
|
|
|
%% <li>eunit - runs eunit tests</li>
|
2012-08-09 16:37:26 +00:00
|
|
|
%% <li>clean - remove ?EUNIT_DIR directory</li>
|
2011-08-11 20:52:34 +00:00
|
|
|
%% <li>reset_after_eunit::boolean() - default = true.
|
|
|
|
%% If true, try to "reset" VM state to approximate state prior to
|
|
|
|
%% running the EUnit tests:
|
|
|
|
%% <ul>
|
2012-01-17 15:57:48 +00:00
|
|
|
%% <li>Stop net_kernel if it was started</li>
|
|
|
|
%% <li>Stop OTP applications not running before EUnit tests were run</li>
|
|
|
|
%% <li>Kill processes not running before EUnit tests were run</li>
|
|
|
|
%% <li>Reset OTP application environment variables</li>
|
|
|
|
%% </ul>
|
|
|
|
%% </li>
|
2010-02-05 17:34:38 +00:00
|
|
|
%% </ul>
|
|
|
|
%% The following Global options are supported:
|
|
|
|
%% <ul>
|
|
|
|
%% <li>verbose=1 - show extra output from the eunit test</li>
|
2012-07-29 00:04:50 +00:00
|
|
|
%% <li>
|
|
|
|
%% suites="foo,bar" - runs tests in foo.erl, test/foo_tests.erl and
|
|
|
|
%% tests in bar.erl, test/bar_tests.erl
|
|
|
|
%% </li>
|
|
|
|
%% <li>
|
|
|
|
%% suites="foo,bar" tests="baz"- runs first test with name starting
|
|
|
|
%% with 'baz' in foo.erl, test/foo_tests.erl and tests in bar.erl,
|
|
|
|
%% test/bar_tests.erl
|
2012-08-19 21:23:06 +00:00
|
|
|
%% </li>
|
|
|
|
%% <li>
|
|
|
|
%% tests="baz"- For every existing suite, run the first test whose
|
|
|
|
%% name starts with bar and, if no such test exists, run the test
|
|
|
|
%% whose name starts with bar in the suite's _tests module
|
|
|
|
%% </li>
|
2010-02-05 17:34:38 +00:00
|
|
|
%% </ul>
|
|
|
|
%% Additionally, for projects that have separate folders for the core
|
2011-01-28 15:08:27 +00:00
|
|
|
%% implementation, and for the unit tests, then the following
|
|
|
|
%% <code>rebar.config</code> option can be provided:
|
2012-11-10 20:59:19 +00:00
|
|
|
%% <code>{eunit_compile_opts, [{src_dirs, ["src", "dir"]}]}.</code>.
|
2010-02-05 17:34:38 +00:00
|
|
|
%% @copyright 2009, 2010 Dave Smith
|
2009-12-05 22:18:09 +00:00
|
|
|
%% -------------------------------------------------------------------
|
|
|
|
-module(rebar_eunit).
|
|
|
|
|
2011-02-13 15:35:03 +00:00
|
|
|
-export([eunit/2,
|
2012-08-09 11:25:01 +00:00
|
|
|
clean/2]).
|
2009-12-05 22:18:09 +00:00
|
|
|
|
2012-11-10 20:59:19 +00:00
|
|
|
%% for internal use only
|
|
|
|
-export([info/2]).
|
|
|
|
|
2009-12-05 22:18:09 +00:00
|
|
|
-include("rebar.hrl").
|
|
|
|
|
2012-08-09 16:37:26 +00:00
|
|
|
-define(EUNIT_DIR, ".eunit").
|
|
|
|
|
2009-12-05 22:18:09 +00:00
|
|
|
%% ===================================================================
|
|
|
|
%% Public API
|
|
|
|
%% ===================================================================
|
|
|
|
|
2012-07-13 20:47:56 +00:00
|
|
|
eunit(Config, _AppFile) ->
|
2011-03-24 17:36:44 +00:00
|
|
|
ok = ensure_dirs(),
|
|
|
|
%% Save code path
|
|
|
|
CodePath = setup_code_path(),
|
2014-01-14 11:38:33 +00:00
|
|
|
CompileOnly = rebar_config:get_global(Config, compile_only, false),
|
2012-08-09 16:37:26 +00:00
|
|
|
{ok, SrcErls} = rebar_erlc_compiler:test_compile(Config, "eunit",
|
|
|
|
?EUNIT_DIR),
|
2012-08-09 11:25:01 +00:00
|
|
|
case CompileOnly of
|
|
|
|
"true" ->
|
|
|
|
true = code:set_path(CodePath),
|
|
|
|
?CONSOLE("Compiled modules for eunit~n", []);
|
|
|
|
false ->
|
|
|
|
run_eunit(Config, CodePath, SrcErls)
|
|
|
|
end.
|
|
|
|
|
|
|
|
clean(_Config, _File) ->
|
2012-08-09 16:37:26 +00:00
|
|
|
rebar_file_utils:rm_rf(?EUNIT_DIR).
|
2012-08-09 11:25:01 +00:00
|
|
|
|
|
|
|
%% ===================================================================
|
|
|
|
%% Internal functions
|
|
|
|
%% ===================================================================
|
2009-12-07 22:17:24 +00:00
|
|
|
|
2012-11-10 20:59:19 +00:00
|
|
|
info(help, eunit) ->
|
|
|
|
info_help("Run eunit tests");
|
|
|
|
info(help, clean) ->
|
|
|
|
Description = ?FMT("Delete eunit test dir (~s)", [?EUNIT_DIR]),
|
|
|
|
info_help(Description).
|
|
|
|
|
|
|
|
info_help(Description) ->
|
|
|
|
?CONSOLE(
|
|
|
|
"~s.~n"
|
|
|
|
"~n"
|
|
|
|
"Valid rebar.config options:~n"
|
|
|
|
" ~p~n"
|
|
|
|
" ~p~n"
|
|
|
|
" ~p~n"
|
|
|
|
" ~p~n"
|
|
|
|
" ~p~n"
|
|
|
|
" ~p~n"
|
|
|
|
"Valid command line options:~n"
|
2014-02-05 21:56:44 +00:00
|
|
|
" suite[s]=\"foo,bar\" (Run tests in foo.erl, test/foo_tests.erl and~n"
|
2012-11-10 20:59:19 +00:00
|
|
|
" tests in bar.erl, test/bar_tests.erl)~n"
|
2014-02-05 21:56:44 +00:00
|
|
|
" test[s]=\"baz\" (For every existing suite, run the first test whose~n"
|
2012-11-10 20:59:19 +00:00
|
|
|
" name starts with bar and, if no such test exists,~n"
|
|
|
|
" run the test whose name starts with bar in the~n"
|
2014-01-14 11:24:52 +00:00
|
|
|
" suite's _tests module)~n"
|
2014-02-06 19:58:38 +00:00
|
|
|
" random_suite_order=true (Run tests in random order)~n"
|
|
|
|
" random_suite_order=Seed (Run tests in random order,~n"
|
|
|
|
" with the PRNG seeded with Seed)~n"
|
2014-01-14 11:24:52 +00:00
|
|
|
" compile_only=true (Compile but do not run tests)",
|
2012-11-10 20:59:19 +00:00
|
|
|
[
|
|
|
|
Description,
|
|
|
|
{eunit_opts, []},
|
|
|
|
{eunit_compile_opts, []},
|
|
|
|
{eunit_first_files, []},
|
|
|
|
{cover_enabled, false},
|
|
|
|
{cover_print_enabled, false},
|
|
|
|
{cover_export_enabled, false}
|
|
|
|
]).
|
|
|
|
|
2012-08-09 11:25:01 +00:00
|
|
|
run_eunit(Config, CodePath, SrcErls) ->
|
2012-08-09 16:37:26 +00:00
|
|
|
%% Build a list of all the .beams in ?EUNIT_DIR -- use this for
|
2011-02-13 15:34:33 +00:00
|
|
|
%% cover and eunit testing. Normally you can just tell cover
|
|
|
|
%% and/or eunit to scan the directory for you, but eunit does a
|
|
|
|
%% code:purge in conjunction with that scan and causes any cover
|
2012-07-29 00:04:50 +00:00
|
|
|
%% compilation info to be lost.
|
2012-07-31 14:39:25 +00:00
|
|
|
|
2012-08-09 16:37:26 +00:00
|
|
|
AllBeamFiles = rebar_utils:beams(?EUNIT_DIR),
|
2011-02-13 15:34:33 +00:00
|
|
|
{BeamFiles, TestBeamFiles} =
|
|
|
|
lists:partition(fun(N) -> string:str(N, "_tests.beam") =:= 0 end,
|
|
|
|
AllBeamFiles),
|
|
|
|
OtherBeamFiles = TestBeamFiles --
|
|
|
|
[filename:rootname(N) ++ "_tests.beam" || N <- AllBeamFiles],
|
2014-02-05 19:41:25 +00:00
|
|
|
ModuleBeamFiles = randomize_suites(Config, BeamFiles ++ OtherBeamFiles),
|
2012-07-29 00:04:50 +00:00
|
|
|
|
2013-08-15 08:26:50 +00:00
|
|
|
%% Get matching tests and modules
|
2012-07-29 00:04:50 +00:00
|
|
|
AllModules = [rebar_utils:beam_to_mod(?EUNIT_DIR, N) || N <- AllBeamFiles],
|
2014-06-14 16:12:18 +00:00
|
|
|
{Tests, FilteredModules} =
|
2013-08-15 08:26:50 +00:00
|
|
|
get_tests_and_modules(Config, ModuleBeamFiles, AllModules),
|
2012-07-29 00:04:50 +00:00
|
|
|
|
2010-05-03 17:37:14 +00:00
|
|
|
SrcModules = [rebar_utils:erl_to_mod(M) || M <- SrcErls],
|
2011-01-28 15:08:27 +00:00
|
|
|
|
2013-04-24 19:43:07 +00:00
|
|
|
{ok, CoverLog} = rebar_cover_utils:init(Config, ModuleBeamFiles,
|
|
|
|
eunit_dir()),
|
2011-08-03 18:28:33 +00:00
|
|
|
|
2011-08-11 20:52:34 +00:00
|
|
|
StatusBefore = status_before_eunit(),
|
2012-07-29 00:04:50 +00:00
|
|
|
EunitResult = perform_eunit(Config, Tests),
|
2010-02-03 12:27:09 +00:00
|
|
|
|
2014-06-14 16:12:18 +00:00
|
|
|
rebar_cover_utils:perform_cover(Config, FilteredModules, SrcModules,
|
2013-04-24 19:43:07 +00:00
|
|
|
eunit_dir()),
|
|
|
|
rebar_cover_utils:close(CoverLog),
|
2011-08-03 18:28:33 +00:00
|
|
|
|
2011-08-11 20:52:34 +00:00
|
|
|
case proplists:get_value(reset_after_eunit, get_eunit_opts(Config),
|
|
|
|
true) of
|
|
|
|
true ->
|
|
|
|
reset_after_eunit(StatusBefore);
|
|
|
|
false ->
|
|
|
|
ok
|
|
|
|
end,
|
|
|
|
|
2012-08-28 11:46:54 +00:00
|
|
|
%% Stop cover to clean the cover_server state. This is important if we want
|
|
|
|
%% eunit+cover to not slow down when analyzing many Erlang modules.
|
|
|
|
ok = cover:stop(),
|
|
|
|
|
2010-02-19 22:37:48 +00:00
|
|
|
case EunitResult of
|
|
|
|
ok ->
|
|
|
|
ok;
|
|
|
|
_ ->
|
2010-06-28 21:19:19 +00:00
|
|
|
?ABORT("One or more eunit tests failed.~n", [])
|
2010-02-03 12:27:09 +00:00
|
|
|
end,
|
2010-06-28 21:19:19 +00:00
|
|
|
|
|
|
|
%% Restore code path
|
2010-10-10 20:11:13 +00:00
|
|
|
true = code:set_path(CodePath),
|
2012-07-13 20:47:56 +00:00
|
|
|
ok.
|
2010-02-19 22:37:48 +00:00
|
|
|
|
2011-03-24 17:36:44 +00:00
|
|
|
ensure_dirs() ->
|
2012-08-09 16:37:26 +00:00
|
|
|
%% Make sure ?EUNIT_DIR/ and ebin/ directory exists (append dummy module)
|
|
|
|
ok = filelib:ensure_dir(filename:join(eunit_dir(), "dummy")),
|
2011-03-26 16:56:54 +00:00
|
|
|
ok = filelib:ensure_dir(filename:join(rebar_utils:ebin_dir(), "dummy")).
|
2011-03-24 17:36:44 +00:00
|
|
|
|
2012-08-09 16:37:26 +00:00
|
|
|
eunit_dir() ->
|
|
|
|
filename:join(rebar_utils:get_cwd(), ?EUNIT_DIR).
|
|
|
|
|
2011-03-24 17:36:44 +00:00
|
|
|
setup_code_path() ->
|
|
|
|
%% Setup code path prior to compilation so that parse_transforms
|
|
|
|
%% and the like work properly. Also, be sure to add ebin_dir()
|
|
|
|
%% to the END of the code path so that we don't have to jump
|
|
|
|
%% through hoops to access the .app file
|
|
|
|
CodePath = code:get_path(),
|
2012-08-09 16:37:26 +00:00
|
|
|
true = code:add_patha(eunit_dir()),
|
2011-03-26 16:56:54 +00:00
|
|
|
true = code:add_pathz(rebar_utils:ebin_dir()),
|
2011-03-24 17:36:44 +00:00
|
|
|
CodePath.
|
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
%%
|
2013-08-15 08:26:50 +00:00
|
|
|
%% == get matching tests ==
|
2012-08-20 11:55:55 +00:00
|
|
|
%%
|
2013-08-15 08:26:50 +00:00
|
|
|
get_tests_and_modules(Config, ModuleBeamFiles, AllModules) ->
|
|
|
|
SelectedSuites = get_selected_suites(Config, AllModules),
|
|
|
|
{Tests, QualifiedTests} = get_qualified_and_unqualified_tests(Config),
|
|
|
|
Modules = get_test_modules(SelectedSuites, Tests,
|
|
|
|
QualifiedTests, ModuleBeamFiles),
|
2014-06-14 16:12:18 +00:00
|
|
|
FilteredModules = get_matching_modules(AllModules, Modules, QualifiedTests),
|
2013-08-15 08:26:50 +00:00
|
|
|
MatchedTests = get_matching_tests(Modules, Tests, QualifiedTests),
|
2014-06-14 16:12:18 +00:00
|
|
|
{MatchedTests, FilteredModules}.
|
2012-08-20 11:55:55 +00:00
|
|
|
|
2013-08-15 08:26:50 +00:00
|
|
|
%%
|
|
|
|
%% == get suites specified via 'suites' option ==
|
|
|
|
%%
|
|
|
|
get_selected_suites(Config, Modules) ->
|
2014-02-05 21:56:44 +00:00
|
|
|
RawSuites = get_suites(Config),
|
2012-07-11 18:36:41 +00:00
|
|
|
Suites = [list_to_atom(Suite) || Suite <- string:tokens(RawSuites, ",")],
|
2012-11-20 15:50:00 +00:00
|
|
|
[M || M <- Suites, lists:member(M, Modules)].
|
2012-06-20 22:08:51 +00:00
|
|
|
|
2014-02-05 21:56:44 +00:00
|
|
|
get_suites(Config) ->
|
|
|
|
case rebar_config:get_global(Config, suites, "") of
|
|
|
|
"" ->
|
|
|
|
rebar_config:get_global(Config, suite, "");
|
|
|
|
Suites ->
|
|
|
|
Suites
|
|
|
|
end.
|
|
|
|
|
2013-08-15 08:26:50 +00:00
|
|
|
get_qualified_and_unqualified_tests(Config) ->
|
|
|
|
RawFunctions = rebar_utils:get_experimental_global(Config, tests, ""),
|
|
|
|
FunctionNames = [FunctionName ||
|
|
|
|
FunctionName <- string:tokens(RawFunctions, ",")],
|
|
|
|
get_qualified_and_unqualified_tests1(FunctionNames, [], []).
|
|
|
|
|
|
|
|
get_qualified_and_unqualified_tests1([], Functions, QualifiedFunctions) ->
|
|
|
|
{Functions, QualifiedFunctions};
|
|
|
|
get_qualified_and_unqualified_tests1([TestName|TestNames], Functions,
|
|
|
|
QualifiedFunctions) ->
|
|
|
|
case string:tokens(TestName, ":") of
|
|
|
|
[TestName] ->
|
|
|
|
Function = list_to_atom(TestName),
|
|
|
|
get_qualified_and_unqualified_tests1(
|
|
|
|
TestNames, [Function|Functions], QualifiedFunctions);
|
|
|
|
[ModuleName, FunctionName] ->
|
|
|
|
M = list_to_atom(ModuleName),
|
|
|
|
F = list_to_atom(FunctionName),
|
|
|
|
get_qualified_and_unqualified_tests1(TestNames, Functions,
|
|
|
|
[{M, F}|QualifiedFunctions]);
|
|
|
|
_ ->
|
|
|
|
?ABORT("Unsupported test function specification: ~s~n", [TestName])
|
|
|
|
end.
|
|
|
|
|
|
|
|
%% Provide modules which are to be searched for tests.
|
|
|
|
%% Several scenarios are possible:
|
2014-02-05 19:41:25 +00:00
|
|
|
%%
|
|
|
|
%% == randomize suites ==
|
|
|
|
%%
|
|
|
|
|
|
|
|
randomize_suites(Config, Modules) ->
|
|
|
|
case rebar_config:get_global(Config, random_suite_order, undefined) of
|
|
|
|
undefined ->
|
|
|
|
Modules;
|
|
|
|
"true" ->
|
|
|
|
Seed = crypto:rand_uniform(1, 65535),
|
|
|
|
randomize_suites1(Modules, Seed);
|
|
|
|
String ->
|
|
|
|
try list_to_integer(String) of
|
|
|
|
Seed ->
|
|
|
|
randomize_suites1(Modules, Seed)
|
|
|
|
catch
|
|
|
|
error:badarg ->
|
|
|
|
?ERROR("Bad random seed provided: ~p~n", [String]),
|
|
|
|
?FAIL
|
|
|
|
end
|
|
|
|
end.
|
|
|
|
|
|
|
|
randomize_suites1(Modules, Seed) ->
|
2014-02-20 18:10:47 +00:00
|
|
|
_ = random:seed(35, Seed, 1337),
|
2014-02-05 19:41:25 +00:00
|
|
|
?CONSOLE("Randomizing suite order with seed ~b~n", [Seed]),
|
|
|
|
[X||{_,X} <- lists:sort([{random:uniform(), M} || M <- Modules])].
|
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
%%
|
|
|
|
%% == get matching tests ==
|
2013-08-15 08:26:50 +00:00
|
|
|
%% 1) Specific tests have been provided and/or
|
|
|
|
%% no unqualified tests have been specified and
|
|
|
|
%% there were some qualified tests, then we can search for
|
|
|
|
%% functions in specified suites (or in empty set of suites).
|
2012-08-20 11:55:55 +00:00
|
|
|
%%
|
2013-08-15 08:26:50 +00:00
|
|
|
%% 2) Neither specific suites nor qualified test names have been
|
|
|
|
%% provided use ModuleBeamFiles which filters out "*_tests"
|
|
|
|
%% modules so EUnit won't doubly run them and cover only
|
|
|
|
%% calculates coverage on production code. However,
|
|
|
|
%% keep "*_tests" modules that are not automatically
|
|
|
|
%% included by EUnit.
|
|
|
|
%%
|
|
|
|
%% From 'Primitives' in the EUnit User's Guide
|
|
|
|
%% http://www.erlang.org/doc/apps/eunit/chapter.html
|
|
|
|
%% "In addition, EUnit will also look for another
|
|
|
|
%% module whose name is ModuleName plus the suffix
|
|
|
|
%% _tests, and if it exists, all the tests from that
|
|
|
|
%% module will also be added. (If ModuleName already
|
|
|
|
%% contains the suffix _tests, this is not done.) E.g.,
|
|
|
|
%% the specification {module, mymodule} will run all
|
|
|
|
%% tests in the modules mymodule and mymodule_tests.
|
|
|
|
%% Typically, the _tests module should only contain
|
|
|
|
%% test cases that use the public interface of the main
|
|
|
|
%% module (and no other code)."
|
|
|
|
get_test_modules(SelectedSuites, Tests, QualifiedTests, ModuleBeamFiles) ->
|
|
|
|
SuitesProvided = SelectedSuites =/= [],
|
|
|
|
OnlyQualifiedTestsProvided = QualifiedTests =/= [] andalso Tests =:= [],
|
|
|
|
if
|
|
|
|
SuitesProvided orelse OnlyQualifiedTestsProvided ->
|
|
|
|
SelectedSuites;
|
|
|
|
true ->
|
|
|
|
[rebar_utils:beam_to_mod(?EUNIT_DIR, N) ||
|
|
|
|
N <- ModuleBeamFiles]
|
2014-02-05 21:56:44 +00:00
|
|
|
end.
|
|
|
|
|
2014-06-14 16:12:18 +00:00
|
|
|
get_matching_modules(AllModules, Modules, QualifiedTests) ->
|
2013-08-15 08:26:50 +00:00
|
|
|
ModuleFilterMapper =
|
|
|
|
fun({M, _}) ->
|
|
|
|
case lists:member(M, AllModules) of
|
|
|
|
true -> {true, M};
|
|
|
|
_-> false
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
ModulesFromQualifiedTests = lists:zf(ModuleFilterMapper, QualifiedTests),
|
|
|
|
lists:usort(Modules ++ ModulesFromQualifiedTests).
|
|
|
|
|
|
|
|
get_matching_tests(Modules, [], []) ->
|
|
|
|
Modules;
|
|
|
|
get_matching_tests(Modules, [], QualifiedTests) ->
|
|
|
|
FilteredQualifiedTests = filter_qualified_tests(Modules, QualifiedTests),
|
|
|
|
lists:merge(Modules, make_test_primitives(FilteredQualifiedTests));
|
|
|
|
get_matching_tests(Modules, Tests, QualifiedTests) ->
|
|
|
|
AllTests = lists:merge(QualifiedTests,
|
|
|
|
get_matching_tests1(Modules, Tests, [])),
|
|
|
|
make_test_primitives(AllTests).
|
|
|
|
|
|
|
|
filter_qualified_tests(Modules, QualifiedTests) ->
|
|
|
|
TestsFilter = fun({Module, _Function}) ->
|
|
|
|
lists:all(fun(M) -> M =/= Module end, Modules) end,
|
|
|
|
lists:filter(TestsFilter, QualifiedTests).
|
2012-07-29 00:04:50 +00:00
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
get_matching_tests1([], _Functions, TestFunctions) ->
|
2012-07-29 00:04:50 +00:00
|
|
|
TestFunctions;
|
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
get_matching_tests1([Module|TModules], Functions, TestFunctions) ->
|
2012-07-29 00:04:50 +00:00
|
|
|
%% Get module exports
|
|
|
|
ModuleStr = atom_to_list(Module),
|
|
|
|
ModuleExports = get_beam_test_exports(ModuleStr),
|
|
|
|
%% Get module _tests exports
|
|
|
|
TestModuleStr = string:concat(ModuleStr, "_tests"),
|
|
|
|
TestModuleExports = get_beam_test_exports(TestModuleStr),
|
|
|
|
%% Build tests {M, F} list
|
2012-08-20 11:55:55 +00:00
|
|
|
Tests = get_matching_tests2(Functions, {Module, ModuleExports},
|
2012-08-22 17:17:17 +00:00
|
|
|
{list_to_atom(TestModuleStr),
|
|
|
|
TestModuleExports}),
|
2012-08-20 11:55:55 +00:00
|
|
|
get_matching_tests1(TModules, Functions,
|
|
|
|
lists:merge([TestFunctions, Tests])).
|
2012-07-29 00:04:50 +00:00
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
get_matching_tests2(Functions, {Mod, ModExports}, {TestMod, TestModExports}) ->
|
2012-07-29 00:04:50 +00:00
|
|
|
%% Look for matching functions into ModExports
|
|
|
|
ModExportsStr = [atom_to_list(E1) || E1 <- ModExports],
|
|
|
|
TestModExportsStr = [atom_to_list(E2) || E2 <- TestModExports],
|
|
|
|
get_matching_exports(Functions, {Mod, ModExportsStr},
|
|
|
|
{TestMod, TestModExportsStr}, []).
|
|
|
|
|
|
|
|
get_matching_exports([], _, _, Matched) ->
|
|
|
|
Matched;
|
|
|
|
get_matching_exports([Function|TFunctions], {Mod, ModExportsStr},
|
|
|
|
{TestMod, TestModExportsStr}, Matched) ->
|
|
|
|
|
|
|
|
FunctionStr = atom_to_list(Function),
|
|
|
|
%% Get matching Function in module, otherwise look in _tests module
|
|
|
|
NewMatch = case get_matching_export(FunctionStr, ModExportsStr) of
|
|
|
|
[] ->
|
|
|
|
{TestMod, get_matching_export(FunctionStr,
|
|
|
|
TestModExportsStr)};
|
|
|
|
MatchingExport ->
|
|
|
|
{Mod, MatchingExport}
|
|
|
|
end,
|
|
|
|
case NewMatch of
|
|
|
|
{_, []} ->
|
|
|
|
get_matching_exports(TFunctions, {Mod, ModExportsStr},
|
|
|
|
{TestMod, TestModExportsStr}, Matched);
|
|
|
|
_ ->
|
|
|
|
get_matching_exports(TFunctions, {Mod, ModExportsStr},
|
|
|
|
{TestMod, TestModExportsStr},
|
|
|
|
[NewMatch|Matched])
|
|
|
|
end.
|
|
|
|
|
|
|
|
get_matching_export(_FunctionStr, []) ->
|
|
|
|
[];
|
|
|
|
get_matching_export(FunctionStr, [ExportStr|TExportsStr]) ->
|
|
|
|
case string:str(ExportStr, FunctionStr) of
|
|
|
|
1 ->
|
|
|
|
list_to_atom(ExportStr);
|
|
|
|
_ ->
|
|
|
|
get_matching_export(FunctionStr, TExportsStr)
|
|
|
|
end.
|
|
|
|
|
|
|
|
get_beam_test_exports(ModuleStr) ->
|
|
|
|
FilePath = filename:join(eunit_dir(),
|
|
|
|
string:concat(ModuleStr, ".beam")),
|
|
|
|
case filelib:is_regular(FilePath) of
|
|
|
|
true ->
|
|
|
|
{beam_file, _, Exports0, _, _, _} = beam_disasm:file(FilePath),
|
|
|
|
Exports1 = [FunName || {FunName, FunArity, _} <- Exports0,
|
|
|
|
FunArity =:= 0],
|
|
|
|
F = fun(FName) ->
|
|
|
|
FNameStr = atom_to_list(FName),
|
|
|
|
re:run(FNameStr, "_test(_)?") =/= nomatch
|
|
|
|
end,
|
|
|
|
lists:filter(F, Exports1);
|
|
|
|
_ ->
|
|
|
|
[]
|
|
|
|
end.
|
|
|
|
|
2012-09-03 20:36:53 +00:00
|
|
|
make_test_primitives(RawTests) ->
|
|
|
|
%% Use {test,M,F} and {generator,M,F} if at least R15B02. Otherwise,
|
|
|
|
%% use eunit_test:function_wrapper/2 fallback.
|
|
|
|
%% eunit_test:function_wrapper/2 was renamed to eunit_test:mf_wrapper/2
|
|
|
|
%% in R15B02; use that as >= R15B02 check.
|
|
|
|
%% TODO: remove fallback and use only {test,M,F} and {generator,M,F}
|
|
|
|
%% primitives once at least R15B02 is required.
|
2012-08-31 20:07:42 +00:00
|
|
|
{module, eunit_test} = code:ensure_loaded(eunit_test),
|
2012-09-03 20:36:53 +00:00
|
|
|
MakePrimitive = case erlang:function_exported(eunit_test, mf_wrapper, 2) of
|
|
|
|
true -> fun eunit_primitive/3;
|
|
|
|
false -> fun pre15b02_eunit_primitive/3
|
|
|
|
end,
|
2012-08-31 20:07:42 +00:00
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
?CONSOLE(" Running test function(s):~n", []),
|
|
|
|
F = fun({M, F2}, Acc) ->
|
|
|
|
?CONSOLE(" ~p:~p/0~n", [M, F2]),
|
|
|
|
FNameStr = atom_to_list(F2),
|
|
|
|
NewFunction =
|
|
|
|
case re:run(FNameStr, "_test_") of
|
|
|
|
nomatch ->
|
|
|
|
%% Normal test
|
2012-09-03 20:36:53 +00:00
|
|
|
MakePrimitive(test, M, F2);
|
2012-08-20 11:55:55 +00:00
|
|
|
_ ->
|
|
|
|
%% Generator
|
2012-09-03 20:36:53 +00:00
|
|
|
MakePrimitive(generator, M, F2)
|
2012-08-20 11:55:55 +00:00
|
|
|
end,
|
|
|
|
[NewFunction|Acc]
|
|
|
|
end,
|
|
|
|
lists:foldl(F, [], RawTests).
|
|
|
|
|
2012-09-03 20:36:53 +00:00
|
|
|
eunit_primitive(Type, M, F) ->
|
|
|
|
{Type, M, F}.
|
2012-08-20 11:55:55 +00:00
|
|
|
|
2012-09-03 20:36:53 +00:00
|
|
|
pre15b02_eunit_primitive(test, M, F) ->
|
|
|
|
eunit_test:function_wrapper(M, F);
|
|
|
|
pre15b02_eunit_primitive(generator, M, F) ->
|
|
|
|
{generator, eunit_test:function_wrapper(M, F)}.
|
2012-08-20 11:55:55 +00:00
|
|
|
|
|
|
|
%%
|
|
|
|
%% == run tests ==
|
|
|
|
%%
|
|
|
|
|
2012-07-29 00:04:50 +00:00
|
|
|
perform_eunit(Config, Tests) ->
|
2010-02-19 22:37:48 +00:00
|
|
|
EunitOpts = get_eunit_opts(Config),
|
2009-12-10 05:00:28 +00:00
|
|
|
|
2012-08-09 16:37:26 +00:00
|
|
|
%% Move down into ?EUNIT_DIR while we run tests so any generated files
|
2009-12-14 14:59:00 +00:00
|
|
|
%% are created there (versus in the source dir)
|
|
|
|
Cwd = rebar_utils:get_cwd(),
|
2012-08-09 16:37:26 +00:00
|
|
|
ok = file:set_cwd(?EUNIT_DIR),
|
2009-12-14 14:59:00 +00:00
|
|
|
|
2012-07-29 00:04:50 +00:00
|
|
|
EunitResult = (catch eunit:test(Tests, EunitOpts)),
|
2010-06-28 21:19:19 +00:00
|
|
|
|
2009-12-14 14:59:00 +00:00
|
|
|
%% Return to original working dir
|
2010-10-10 20:11:13 +00:00
|
|
|
ok = file:set_cwd(Cwd),
|
2010-06-28 21:19:19 +00:00
|
|
|
|
|
|
|
EunitResult.
|
|
|
|
|
2010-02-19 22:37:48 +00:00
|
|
|
get_eunit_opts(Config) ->
|
|
|
|
%% Enable verbose in eunit if so requested..
|
2013-12-06 19:55:41 +00:00
|
|
|
BaseOpts = case rebar_log:is_verbose(Config) of
|
2010-02-19 22:37:48 +00:00
|
|
|
true ->
|
|
|
|
[verbose];
|
|
|
|
false ->
|
|
|
|
[]
|
|
|
|
end,
|
2009-12-07 22:17:24 +00:00
|
|
|
|
2010-02-19 22:37:48 +00:00
|
|
|
BaseOpts ++ rebar_config:get_list(Config, eunit_opts, []).
|
2009-12-07 22:17:24 +00:00
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
%%
|
|
|
|
%% == reset_after_eunit ==
|
|
|
|
%%
|
2011-08-11 20:52:34 +00:00
|
|
|
|
|
|
|
status_before_eunit() ->
|
|
|
|
Apps = get_app_names(),
|
|
|
|
AppEnvs = [{App, application:get_all_env(App)} || App <- Apps],
|
|
|
|
{erlang:processes(), erlang:is_alive(), AppEnvs, ets:tab2list(ac_tab)}.
|
|
|
|
|
2012-08-20 11:55:55 +00:00
|
|
|
get_app_names() ->
|
|
|
|
[AppName || {AppName, _, _} <- application:loaded_applications()].
|
|
|
|
|
2011-08-11 20:52:34 +00:00
|
|
|
reset_after_eunit({OldProcesses, WasAlive, OldAppEnvs, _OldACs}) ->
|
|
|
|
IsAlive = erlang:is_alive(),
|
|
|
|
if not WasAlive andalso IsAlive ->
|
|
|
|
?DEBUG("Stopping net kernel....\n", []),
|
|
|
|
erl_epmd:stop(),
|
2011-08-25 09:41:22 +00:00
|
|
|
_ = net_kernel:stop(),
|
2011-08-23 19:17:18 +00:00
|
|
|
pause_until_net_kernel_stopped();
|
2011-08-11 20:52:34 +00:00
|
|
|
true ->
|
|
|
|
ok
|
|
|
|
end,
|
|
|
|
|
|
|
|
OldApps = [App || {App, _} <- OldAppEnvs],
|
|
|
|
Apps = get_app_names(),
|
2011-08-25 09:41:22 +00:00
|
|
|
_ = [begin
|
|
|
|
_ = case lists:member(App, OldApps) of
|
|
|
|
true -> ok;
|
|
|
|
false -> application:stop(App)
|
|
|
|
end,
|
|
|
|
ok = application:unset_env(App, K)
|
|
|
|
end || App <- Apps, App /= rebar,
|
2012-12-16 20:30:15 +00:00
|
|
|
{K, _V} <- application:get_all_env(App),
|
|
|
|
K =/= included_applications],
|
2011-08-11 20:52:34 +00:00
|
|
|
|
|
|
|
reconstruct_app_env_vars(Apps),
|
2011-10-31 22:11:50 +00:00
|
|
|
|
|
|
|
Processes = erlang:processes(),
|
|
|
|
_ = kill_extras(Processes -- OldProcesses),
|
|
|
|
|
2011-08-11 20:52:34 +00:00
|
|
|
ok.
|
|
|
|
|
|
|
|
kill_extras(Pids) ->
|
2011-08-23 22:32:07 +00:00
|
|
|
%% Killing any of the procs below will either:
|
|
|
|
%% 1. Interfere with stuff that we don't want interfered with, or
|
|
|
|
%% 2. May/will force the 'kernel' app to shutdown, which *will*
|
|
|
|
%% interfere with rebar's ability To Do Useful Stuff(tm).
|
2011-08-24 17:11:48 +00:00
|
|
|
%% This list may require changes as OTP versions and/or
|
|
|
|
%% rebar use cases change.
|
|
|
|
KeepProcs = [cover_server, eunit_server,
|
Don't kill any inet_gethost_native after eunit
Avoid error reports like this one:
prompt$ rebar eunit
==> dummy (eunit)
Test passed.
=ERROR REPORT==== 29-Dec-2011::23:22:11 ===
** Generic server inet_gethost_native_sup terminating
** Last message in was {'EXIT',<0.62.0>,killed}
** When Server state == {state,inet_gethost_native,undefined,<0.62.0>,
{local,inet_gethost_native_sup}}
** Reason for termination ==
** killed
Previously, it could happen if an eunit test did something that
required a name lookup, like in this example:
-module(dummy_tests).
-include_lib("eunit/include/eunit.hrl").
x_test() ->
{ok, _Hostent} = inet:gethostbyname(localhost).
The inet_gethost_native is a process, started on demand, under a
supervisor_bridge under the kernel_sup, but it is not a gen_server
process or the like, so it has nothing in '$ancestors' in its process
dictionary to indicate it is part of kernel.
2011-12-29 22:38:03 +00:00
|
|
|
eqc, eqc_license, eqc_locked,
|
|
|
|
%% inet_gethost_native is started on demand, when
|
|
|
|
%% doing name lookups. It is under kernel_sup, under
|
|
|
|
%% a supervisor_bridge.
|
|
|
|
inet_gethost_native],
|
2011-08-11 20:52:34 +00:00
|
|
|
Killed = [begin
|
|
|
|
Info = case erlang:process_info(Pid) of
|
|
|
|
undefined -> [];
|
|
|
|
Else -> Else
|
|
|
|
end,
|
2011-08-24 17:11:48 +00:00
|
|
|
Keep1 = case proplists:get_value(registered_name, Info) of
|
|
|
|
undefined ->
|
|
|
|
false;
|
|
|
|
Name ->
|
|
|
|
lists:member(Name, KeepProcs)
|
|
|
|
end,
|
|
|
|
Keep2 = case proplists:get_value(dictionary, Info) of
|
|
|
|
undefined ->
|
|
|
|
false;
|
|
|
|
Ds ->
|
|
|
|
case proplists:get_value('$ancestors', Ds) of
|
|
|
|
undefined ->
|
|
|
|
false;
|
|
|
|
As ->
|
|
|
|
lists:member(kernel_sup, As)
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
if Keep1 orelse Keep2 ->
|
2011-08-11 20:52:34 +00:00
|
|
|
ok;
|
|
|
|
true ->
|
|
|
|
?DEBUG("Kill ~p ~p\n", [Pid, Info]),
|
|
|
|
exit(Pid, kill),
|
|
|
|
Pid
|
|
|
|
end
|
|
|
|
end || Pid <- Pids],
|
|
|
|
case lists:usort(Killed) -- [ok] of
|
|
|
|
[] ->
|
|
|
|
?DEBUG("No processes to kill\n", []),
|
|
|
|
[];
|
|
|
|
Else ->
|
2011-08-25 09:41:22 +00:00
|
|
|
lists:foreach(fun(Pid) -> wait_until_dead(Pid) end, Else),
|
2011-08-11 20:52:34 +00:00
|
|
|
Else
|
|
|
|
end.
|
|
|
|
|
|
|
|
reconstruct_app_env_vars([App|Apps]) ->
|
|
|
|
CmdLine0 = proplists:get_value(App, init:get_arguments(), []),
|
|
|
|
CmdVars = [{list_to_atom(K), list_to_atom(V)} || {K, V} <- CmdLine0],
|
2011-08-23 19:22:04 +00:00
|
|
|
AppFile = (catch filename:join([code:lib_dir(App),
|
|
|
|
"ebin",
|
|
|
|
atom_to_list(App) ++ ".app"])),
|
2011-08-11 20:52:34 +00:00
|
|
|
AppVars = case file:consult(AppFile) of
|
|
|
|
{ok, [{application, App, Ps}]} ->
|
|
|
|
proplists:get_value(env, Ps, []);
|
|
|
|
_ ->
|
|
|
|
[]
|
|
|
|
end,
|
2012-02-11 18:26:09 +00:00
|
|
|
|
|
|
|
%% App vars specified in config files override those in the .app file.
|
|
|
|
%% Config files later in the args list override earlier ones.
|
|
|
|
AppVars1 = case init:get_argument(config) of
|
|
|
|
{ok, ConfigFiles} ->
|
|
|
|
{App, MergedAppVars} = lists:foldl(fun merge_app_vars/2,
|
|
|
|
{App, AppVars},
|
|
|
|
ConfigFiles),
|
|
|
|
MergedAppVars;
|
|
|
|
error ->
|
|
|
|
AppVars
|
|
|
|
end,
|
|
|
|
AllVars = CmdVars ++ AppVars1,
|
2011-08-11 20:52:34 +00:00
|
|
|
?DEBUG("Reconstruct ~p ~p\n", [App, AllVars]),
|
2011-08-25 09:41:22 +00:00
|
|
|
lists:foreach(fun({K, V}) -> application:set_env(App, K, V) end, AllVars),
|
2011-08-11 20:52:34 +00:00
|
|
|
reconstruct_app_env_vars(Apps);
|
|
|
|
reconstruct_app_env_vars([]) ->
|
|
|
|
ok.
|
|
|
|
|
2012-02-11 18:26:09 +00:00
|
|
|
merge_app_vars(ConfigFile, {App, AppVars}) ->
|
|
|
|
File = ensure_config_extension(ConfigFile),
|
|
|
|
FileAppVars = app_vars_from_config_file(File, App),
|
|
|
|
Dict1 = dict:from_list(AppVars),
|
|
|
|
Dict2 = dict:from_list(FileAppVars),
|
|
|
|
Dict3 = dict:merge(fun(_Key, _Value1, Value2) -> Value2 end, Dict1, Dict2),
|
|
|
|
{App, dict:to_list(Dict3)}.
|
|
|
|
|
|
|
|
ensure_config_extension(File) ->
|
|
|
|
%% config files must end with .config on disk but when specifying them
|
|
|
|
%% via the -config option the extension is optional
|
|
|
|
BaseFileName = filename:basename(File, ".config"),
|
|
|
|
DirName = filename:dirname(File),
|
|
|
|
filename:join(DirName, BaseFileName ++ ".config").
|
|
|
|
|
|
|
|
app_vars_from_config_file(File, App) ->
|
|
|
|
case file:consult(File) of
|
|
|
|
{ok, [Env]} ->
|
|
|
|
proplists:get_value(App, Env, []);
|
|
|
|
_ ->
|
|
|
|
[]
|
|
|
|
end.
|
|
|
|
|
2011-08-11 20:52:34 +00:00
|
|
|
wait_until_dead(Pid) when is_pid(Pid) ->
|
2011-08-28 00:40:28 +00:00
|
|
|
Ref = erlang:monitor(process, Pid),
|
2011-08-11 20:52:34 +00:00
|
|
|
receive
|
|
|
|
{'DOWN', Ref, process, _Obj, Info} ->
|
|
|
|
Info
|
|
|
|
after 10*1000 ->
|
|
|
|
exit({timeout_waiting_for, Pid})
|
|
|
|
end;
|
|
|
|
wait_until_dead(_) ->
|
|
|
|
ok.
|
2011-08-23 19:17:18 +00:00
|
|
|
|
|
|
|
pause_until_net_kernel_stopped() ->
|
|
|
|
pause_until_net_kernel_stopped(10).
|
|
|
|
|
|
|
|
pause_until_net_kernel_stopped(0) ->
|
|
|
|
exit(net_kernel_stop_failed);
|
|
|
|
pause_until_net_kernel_stopped(N) ->
|
2013-08-14 07:24:39 +00:00
|
|
|
case node() of
|
|
|
|
'nonode@nohost' ->
|
2011-08-23 19:17:18 +00:00
|
|
|
?DEBUG("Stopped net kernel.\n", []),
|
2013-08-14 07:24:39 +00:00
|
|
|
ok;
|
|
|
|
_ ->
|
|
|
|
timer:sleep(100),
|
|
|
|
pause_until_net_kernel_stopped(N - 1)
|
2011-08-23 19:17:18 +00:00
|
|
|
end.
|