cover_SUITE: Run part of the test suite when cover is running

We used to skip the entire test suite if the cover server had already
been started by common_test, but that means that we will get bad
coverage for the cover module.

Modify the test suite to to run all tests case that don't explicitly
start or stop the cover server to increase the coverage. In addition,
add a special coverage_analysis/1 test case that only runs when
the cover server is already running.

1 files changed, 69 insertions, 20 deletions

diff --git a/lib/tools/test/cover_SUITE.erl b/lib/tools/test/cover_SUITE.erl
index bd71218474..ec61c57cec 100644
--- a/lib/tools/test/cover_SUITE.erl
+++ b/lib/tools/test/cover_SUITE.erl
@@ -22,7 +22,8 @@
 	 suite/0,groups/0,init_per_suite/1, end_per_suite/1, 
 	 init_per_group/2,end_per_group/2]).
 
--export([start/1, compile/1, analyse/1, misc/1, stop/1, 
+-export([coverage/1, coverage_analysis/1,
+	 start/1, compile/1, analyse/1, misc/1, stop/1,
 	 distribution/1, reconnect/1, die_and_reconnect/1,
 	 dont_reconnect_after_stop/1, stop_node_after_disconnect/1,
 	 export_import/1,
@@ -30,6 +31,8 @@
          otp_8188/1, otp_8270/1, otp_8273/1, otp_8340/1,
 	 otp_10979_hanging_node/1, compile_beam_opts/1, eep37/1]).
 
+-export([do_coverage/1]).
+
 -include_lib("test_server/include/test_server.hrl").
 
 %%----------------------------------------------------------------------
@@ -46,25 +49,25 @@
 suite() -> [{ct_hooks,[ts_install_cth]}].
 
 all() -> 
+    NoStartStop = [eif,otp_5305,otp_5418,otp_7095,otp_8273,
+		   otp_8340,otp_8188,compile_beam_opts,eep37],
+    StartStop = [start, compile, analyse, misc, stop,
+		 distribution, reconnect, die_and_reconnect,
+		 dont_reconnect_after_stop, stop_node_after_disconnect,
+		 export_import, otp_5031, otp_6115,
+		 otp_8270, otp_10979_hanging_node],
     case whereis(cover_server) of
 	undefined ->
-	    [start, compile, analyse, misc, stop,
-	     distribution, reconnect, die_and_reconnect,
-	     dont_reconnect_after_stop, stop_node_after_disconnect,
-	     export_import, otp_5031, eif, otp_5305, otp_5418,
-	     otp_6115, otp_7095, otp_8188, otp_8270, otp_8273,
-	     otp_8340, otp_10979_hanging_node, compile_beam_opts, eep37];
+	    [coverage,StartStop ++ NoStartStop];
 	_pid ->
-	    {skip,
-	     "It looks like the test server is running "
-	     "cover. Can't run cover test."}
+	    [coverage|NoStartStop++[coverage_analysis]]
     end.
 
 groups() -> 
     [].
 
 init_per_suite(Config) ->
-    Config.
+    [{ct_is_running_cover,whereis(cover_server) =/= undefined}|Config].
 
 end_per_suite(_Config) ->
     ok.
@@ -90,13 +93,64 @@ init_per_testcase(TC, Config) when TC =:= misc;
 init_per_testcase(_TestCase, Config) ->
     Config.
 
-end_per_testcase(TestCase, _Config) ->
-    case lists:member(TestCase,[start,compile,analyse,misc]) of
+end_per_testcase(TestCase, Config) ->
+    NoStop = [start,compile,analyse,misc],
+    DontStop = proplists:get_bool(ct_is_running_cover, Config) orelse
+	lists:member(TestCase, NoStop),
+    case DontStop of
 	true -> ok;
 	false -> cover:stop()
     end,
     ok.
 
+coverage(Config) when is_list(Config) ->
+    {ok,?MODULE} = cover:compile_beam(?MODULE),
+    ?MODULE:do_coverage(Config).
+
+do_coverage(Config) ->
+    Outdir = ?config(priv_dir, Config),
+    ExportFile = filename:join(Outdir, "export"),
+    ok = cover:export(ExportFile, ?MODULE),
+    {error,{already_started,_}} = cover:start(),
+    {error,_} = cover:compile_beam(non_existing_module),
+    _ = cover:which_nodes(),
+    _ = cover:modules(),
+    _ = cover:imported(),
+    {error,{not_cover_compiled,lists}} = cover:analyze(lists),
+
+    %% Cover escaping of '&' in HTML files.
+
+    case proplists:get_bool(ct_is_running_cover, Config) of
+	false ->
+	    %% Cover server was implicitly started when this module
+	    %% was cover-compiled. We must stop the cover server, but
+	    %% we must ensure that this module is not on the call
+	    %% stack when it is unloaded. Therefore, the call that
+	    %% follows MUST be tail-recursive.
+	    cover:stop();
+	true ->
+	    %% Cover server was started by common_test; don't stop it.
+	    ok
+    end.
+
+%% This test case will only be run when common_test is running cover.
+coverage_analysis(Config) when is_list(Config) ->
+    {ok,Analysis1} = cover:analyze(?MODULE),
+    io:format("~p\n", [Analysis1]),
+    {ok,Analysis2} = cover:analyze(?MODULE, calls),
+    io:format("~p\n", [Analysis2]),
+    {ok,_Analysis3} = cover:analyze(?MODULE, calls, line),
+
+    Outdir = ?config(priv_dir, Config),
+    Outfile = filename:join(Outdir, ?MODULE),
+
+    {ok,Outfile} = cover:analyze_to_file(?MODULE, Outfile),
+    {ok,Contents} = file:read_file(Outfile),
+    ok = file:delete(Outfile),
+    ok = io:put_chars(Contents),
+    {ok,Outfile} = cover:analyze_to_file(?MODULE, Outfile, [html]),
+    ok.
+
 start(suite) -> [];
 start(Config) when is_list(Config) ->
     ?line ok = file:set_cwd(?config(data_dir, Config)),
@@ -759,7 +813,6 @@ eif(Config) when is_list(Config) ->
     %% in cover_inc.beam - not the ones from the included file.
     ?line cover_inc:func(),
     ?line {ok, [_, _]} = cover:analyse(cover_inc, line),
-    ?line cover:stop(),
     ok.
     
 otp_5305(suite) -> [];
@@ -775,7 +828,6 @@ otp_5305(Config) when is_list(Config) ->
              ">>,
     ?line ok = file:write_file(File, Test),
     ?line {ok, t} = cover:compile(File),
-    ?line cover:stop(),
     ?line ok = file:delete(File),
 
     ok.
@@ -790,7 +842,6 @@ otp_5418(Config) when is_list(Config) ->
     ?line ok = file:write_file(File, Test),
     ?line {ok, t} = cover:compile(File),
     ?line {ok,{t,{0,0}}} = cover:analyse(t, module),
-    ?line cover:stop(),
     ?line ok = file:delete(File),
 
     ok.
@@ -952,7 +1003,6 @@ otp_7095(Config) when is_list(Config) ->
                {{t,67},1},{{t,69},1},{{t,71},1},{{t,74},1},
                     {{t,76},0},{{t,78},1},
                {{t,82},2}]} = cover:analyse(t, calls, line),
-    ?line cover:stop(),
     ?line ok = file:delete(File),
 
     ok.
@@ -1028,7 +1078,6 @@ otp_8273(Config) when is_list(Config) ->
              ">>,
     ?line File = cc_mod(t, Test, Config),
     ?line ok = t:t(),
-    ?line cover:stop(),
     ?line ok = file:delete(File),
 
     ok.
@@ -1066,7 +1115,6 @@ otp_8188(Config) when is_list(Config) ->
     ?line File = cc_mod(t, Test, Config),
     ?line false = t:test(nok),
     ?line {ok,[{{t,11},1},{{t,12},1}]} = cover:analyse(t, calls, line),
-    ?line cover:stop(),
     ?line ok = file:delete(File),
 
     %% Bit string comprehensions are now traversed;
@@ -1433,6 +1481,8 @@ compile_beam_opts(Config) when is_list(Config) ->
                             export_all,
                             debug_info,
                             return_errors]),
+    code:purge(t),
+    code:delete(t),
     Exports =
         [{func1,0},
          {macro, 0},
@@ -1443,7 +1493,6 @@ compile_beam_opts(Config) when is_list(Config) ->
     Exports = t:module_info(exports),
     {ok, t} = cover:compile_beam("t"),
     Exports = t:module_info(exports),
-    cover:stop(),
     ok = file:delete("t.beam"),
     ok = file:set_cwd(Cwd),
     ok.