Merge pull request #1684 from tsloughter/cover-export

add eunit and ct option to set coverdata file name

src/rebar_prv_common_test.erl

@@ -8,8 +8,11 @@
 -export([init/1,
          do/1,
          format_error/1]).
-%% exported for test purposes, consider private
--export([compile/2, prepare_tests/1, translate_paths/2]).
+
+-ifdef(TEST).
+%% exported for test purposes
+-export([compile/2, prepare_tests/1, translate_paths/2, maybe_write_coverdata/1]).
+-endif.
 
 -include("rebar.hrl").
 -include_lib("providers/include/providers.hrl").
@@ -728,7 +731,8 @@ maybe_write_coverdata(State) ->
         true  -> rebar_state:set(State, cover_enabled, true);
         false -> State
     end,
-    rebar_prv_cover:maybe_write_coverdata(State1, ?PROVIDER).
+    Name = proplists:get_value(cover_export_name, RawOpts, ?PROVIDER),
+    rebar_prv_cover:maybe_write_coverdata(State1, Name).
 
 ct_opts(_State) ->
     [{dir, undefined, "dir", string, help(dir)}, %% comma-separated list
@@ -744,6 +748,7 @@ ct_opts(_State) ->
      {logopts, undefined, "logopts", string, help(logopts)}, %% comma-separated list
      {verbosity, undefined, "verbosity", integer, help(verbosity)}, %% Integer
      {cover, $c, "cover", {boolean, false}, help(cover)},
+     {cover_export_name, undefined, "cover_export_name", string, help(cover_export_name)},
      {repeat, undefined, "repeat", integer, help(repeat)}, %% integer
      {duration, undefined, "duration", string, help(duration)}, % format: HHMMSS
      {until, undefined, "until", string, help(until)}, %% format: YYMoMoDD[HHMMSS]
@@ -797,6 +802,8 @@ help(verbosity) ->
     "Verbosity";
 help(cover) ->
     "Generate cover data";
+help(cover_export_name) ->
+    "Base name of the coverdata file to write";
 help(repeat) ->
     "How often to repeat tests";
 help(duration) ->

src/rebar_prv_cover.erl

@@ -372,10 +372,10 @@ redirect_cover_output(State, CoverPid) ->
                         [append]),
     group_leader(F, CoverPid).
 
-write_coverdata(State, Task) ->
+write_coverdata(State, Name) ->
     DataDir = cover_dir(State),
     ok = filelib:ensure_dir(filename:join([DataDir, "dummy.log"])),
-    ExportFile = filename:join([DataDir, atom_to_list(Task) ++ ".coverdata"]),
+    ExportFile = filename:join([DataDir, rebar_utils:to_list(Name) ++ ".coverdata"]),
     case cover:export(ExportFile) of
         ok ->
             %% dump accumulated coverdata after writing

src/rebar_prv_eunit.erl

@@ -472,7 +472,8 @@ maybe_write_coverdata(State) ->
         true  -> rebar_state:set(State, cover_enabled, true);
         false -> State
     end,
-    rebar_prv_cover:maybe_write_coverdata(State1, ?PROVIDER).
+    Name = proplists:get_value(cover_export_name, RawOpts, ?PROVIDER),
+    rebar_prv_cover:maybe_write_coverdata(State1, Name).
 
 handle_results(ok) -> ok;
 handle_results(error) ->
@@ -484,6 +485,7 @@ eunit_opts(_State) ->
     [{app, undefined, "app", string, help(app)},
      {application, undefined, "application", string, help(app)},
      {cover, $c, "cover", boolean, help(cover)},
+     {cover_export_name, undefined, "cover_export_name", string, help(cover_export_name)},
      {dir, $d, "dir", string, help(dir)},
      {file, $f, "file", string, help(file)},
      {module, $m, "module", string, help(module)},
@@ -495,6 +497,7 @@ eunit_opts(_State) ->
 
 help(app)       -> "Comma separated list of application test suites to run. Equivalent to `[{application, App}]`.";
 help(cover)     -> "Generate cover data. Defaults to false.";
+help(cover_export_name) -> "Base name of the coverdata file to write";
 help(dir)       -> "Comma separated list of dirs to load tests from. Equivalent to `[{dir, Dir}]`.";
 help(file)      -> "Comma separated list of files to load tests from. Equivalent to `[{file, File}]`.";
 help(module)    -> "Comma separated list of modules to load tests from. Equivalent to `[{module, Module}]`.";

test/rebar_cover_SUITE.erl

@@ -7,6 +7,7 @@
          all/0,
          flag_coverdata_written/1,
          config_coverdata_written/1,
+         config_coverdata_overridden_name_written/1,
          basic_extra_src_dirs/1,
          release_extra_src_dirs/1,
          root_extra_src_dirs/1,
@@ -34,6 +35,7 @@ init_per_testcase(_, Config) ->
 
 all() ->
     [flag_coverdata_written, config_coverdata_written,
+     config_coverdata_overridden_name_written,
      basic_extra_src_dirs, release_extra_src_dirs,
      root_extra_src_dirs,
      index_written,
@@ -70,6 +72,21 @@ config_coverdata_written(Config) ->
 
     true = filelib:is_file(filename:join([AppDir, "_build", "test", "cover", "eunit.coverdata"])).
 
+config_coverdata_overridden_name_written(Config) ->
+    AppDir = ?config(apps, Config),
+
+    Name = rebar_test_utils:create_random_name("cover_"),
+    Vsn = rebar_test_utils:create_random_vsn(),
+    rebar_test_utils:create_eunit_app(AppDir, Name, Vsn, [kernel, stdlib]),
+
+    RebarConfig = [{erl_opts, [{d, some_define}]}, {cover_enabled, true}],
+    rebar_test_utils:run_and_check(Config,
+                                   RebarConfig,
+                                   ["eunit", "--cover_export_name=test_name"],
+                                   {ok, [{app, Name}]}),
+
+    true = filelib:is_file(filename:join([AppDir, "_build", "test", "cover", "test_name.coverdata"])).
+
 basic_extra_src_dirs(Config) ->
     AppDir = ?config(apps, Config),
 

test/rebar_ct_SUITE.erl

@@ -49,6 +49,7 @@
          cfg_cover_spec/1,
          cfg_atom_suites/1,
          cover_compiled/1,
+         cover_export_name/1,
          misspecified_ct_opts/1,
          misspecified_ct_compile_opts/1,
          misspecified_ct_first_files/1,
@@ -121,7 +122,8 @@ groups() -> [{basic_app, [], [basic_app_default_dirs,
                             cmd_create_priv_dir,
                             cmd_include_dir,
                             cmd_sys_config]},
-             {cover, [], [cover_compiled]}].
+             {cover, [], [cover_compiled,
+                          cover_export_name]}].
 
 init_per_group(basic_app, Config) ->
     C = rebar_test_utils:init_rebar_state(Config, "ct_"),
@@ -1251,6 +1253,29 @@ cover_compiled(Config) ->
     Mod = list_to_atom(Name),
     {file, _} = cover:is_compiled(Mod).
 
+cover_export_name(Config) ->
+    State = ?config(result, Config),
+
+    Providers = rebar_state:providers(State),
+    Namespace = rebar_state:namespace(State),
+    CommandProvider = providers:get_provider(ct, Providers, Namespace),
+    GetOptSpec = providers:opts(CommandProvider),
+    {ok, GetOptResult} = getopt:parse(GetOptSpec, ["--cover", "--cover_export_name=export_name"]),
+
+    NewState = rebar_state:command_parsed_args(State, GetOptResult),
+
+    Tests = rebar_prv_common_test:prepare_tests(NewState),
+    {ok, _} = rebar_prv_common_test:compile(NewState, Tests),
+    rebar_prv_common_test:maybe_write_coverdata(NewState),
+
+    Name = ?config(name, Config),
+    Mod = list_to_atom(Name),
+    {file, _} = cover:is_compiled(Mod),
+
+    Dir = rebar_dir:profile_dir(rebar_state:opts(NewState), [default, test]),
+    ct:pal("DIR ~s", [Dir]),
+    true = filelib:is_file(filename:join([Dir, "cover", "export_name.coverdata"])).
+
 misspecified_ct_opts(Config) ->
     C = rebar_test_utils:init_rebar_state(Config, "ct_cfg_atom_suites_"),