[common_test] Add option cover_stop

By default, test_server will always stop cover (and thus load back the
non cover compiled original beam files) after a test with code
coverage analysis is completed. The new option allows the common_test
user to specify that cover shall not be stopped. This can be useful if
there are processes still running old code, i.e. processes that have
not done any fully qualified function call after the cover
compilation, since loading the original code then will kill those
processes. This is only recommended if the erlang node is to be
stopped after the test run, or if cover can be manually stopped.

8 files changed, 73 insertions, 14 deletions

diff --git a/lib/common_test/doc/src/cover_chapter.xml b/lib/common_test/doc/src/cover_chapter.xml
index 803a71de07..b2e64bfff0 100644
--- a/lib/common_test/doc/src/cover_chapter.xml
+++ b/lib/common_test/doc/src/cover_chapter.xml
@@ -109,6 +109,33 @@
   </section>
 
   <section>
+    <marker id="cover_stop"></marker>
+    <title>Stopping the cover tool when tests are completed</title>
+    <p>By default the Cover tool is automatically stopped when the
+      tests are completed. This causes the original (non cover
+      compiled) modules to be loaded back in to the test node. If a
+      process at this point is still running old code of any of the
+      modules that are cover compiled, meaning that it has not done
+      any fully qualified function call after the cover compilation,
+      the process will now be killed. To avoid this it is possible to
+      set the value of the <c>cover_stop</c> option to
+      <c>false</c>. This means that the modules will stay cover
+      compiled, and it is therefore only recommended if the erlang
+      node(s) under test is terminated after the test is completed
+      or if cover can be manually stopped.</p>
+
+    <p>The option can be set by using the <c>-cover_stop</c> flag with
+      <c>ct_run</c>, by adding <c>{cover_stop,true|false}</c> to the
+      Opts argument to <c><seealso
+      marker="ct#run_test-1">ct:run_test/1</seealso></c>, or by adding
+      a <c>cover_stop</c> term in your test specification (see chapter
+      about <seealso
+      marker="run_test_chapter#test_specifications">test
+      specifications</seealso>).</p>
+
+  </section>
+
+  <section>
     <title>The cover specification file</title>
     <p>These are the terms allowed in a cover specification file:</p>
 
diff --git a/lib/common_test/doc/src/ct_run.xml b/lib/common_test/doc/src/ct_run.xml
index 9cc5495af7..da18640df7 100644
--- a/lib/common_test/doc/src/ct_run.xml
+++ b/lib/common_test/doc/src/ct_run.xml
@@ -104,6 +104,7 @@
 	[-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
 	[-stylesheet CSSFile]
 	[-cover CoverCfgFile]
+	[-cover_stop Bool]
 	[-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
         [-event_handler_init EvHandler1 InitArg1 and
 	 EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
@@ -138,6 +139,7 @@
 	[-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
 	[-stylesheet CSSFile]
 	[-cover CoverCfgFile]
+	[-cover_stop Bool]
 	[-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
         [-event_handler_init EvHandler1 InitArg1 and
 	 EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index ea62df27cc..b5b914d506 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -153,6 +153,8 @@
       <item><c><![CDATA[-stylesheet <css_file>]]></c>, points out a user HTML style sheet (see below).</item>
       <item><c><![CDATA[-cover <cover_cfg_file>]]></c>, to perform code coverage test (see 
 	<seealso marker="cover_chapter#cover">Code Coverage Analysis</seealso>).</item>
+      <item><c><![CDATA[-cover_stop <bool>]]></c>, to specify if the cover tool shall be stopped after the test is completed (see
+	<seealso marker="cover_chapter#cover_stop">Code Coverage Analysis</seealso>).</item>
       <item><c><![CDATA[-event_handler <event_handlers>]]></c>, to install 
         <seealso marker="event_handler_chapter#event_handling">event handlers</seealso>.</item>
       <item><c><![CDATA[-event_handler_init <event_handlers>]]></c>, to install
@@ -495,6 +497,9 @@
       {cover, CoverSpecFile}.
       {cover, NodeRefs, CoverSpecFile}.
       
+      {cover_stop, Bool}.
+      {cover_stop, NodeRefs, Bool}.
+
       {include, IncludeDirs}.
       {include, NodeRefs, IncludeDirs}.
 
diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl
index 5014309c0f..90e4e79ccf 100644
--- a/lib/common_test/src/ct.erl
+++ b/lib/common_test/src/ct.erl
@@ -148,7 +148,7 @@ run(TestDirs) ->
 %%%               {config,CfgFiles} | {userconfig, UserConfig} |
 %%%               {allow_user_terms,Bool} | {logdir,LogDir} |
 %%%               {silent_connections,Conns} | {stylesheet,CSSFile} |
-%%%               {cover,CoverSpecFile} | {step,StepOpts} |
+%%%               {cover,CoverSpecFile} | {cover_stop,Bool} | {step,StepOpts} |
 %%%               {event_handler,EventHandlers} | {include,InclDirs} |
 %%%               {auto_compile,Bool} | {create_priv_dir,CreatePrivDir}  |
 %%%               {multiply_timetraps,M} | {scale_timetraps,Bool} |
diff --git a/lib/common_test/src/ct_master.erl b/lib/common_test/src/ct_master.erl
index 99bec3ea09..f29eba605c 100644
--- a/lib/common_test/src/ct_master.erl
+++ b/lib/common_test/src/ct_master.erl
@@ -51,7 +51,7 @@
 %%%               {testcase,Cases} | {spec,TestSpecs} | {allow_user_terms,Bool} | 
 %%%               {logdir,LogDir} | {event_handler,EventHandlers} | 
 %%%               {silent_connections,Conns} | {cover,CoverSpecFile} |
-%%%		  {userconfig, UserCfgFiles}
+%%%		  {cover_stop,Bool} | {userconfig, UserCfgFiles}
 %%%       CfgFiles = string() | [string()]
 %%%       TestDirs = string() | [string()]
 %%%       Suites = atom() | [atom()]
diff --git a/lib/common_test/src/ct_run.erl b/lib/common_test/src/ct_run.erl
index 4a6a3cdcac..ed7778c25a 100644
--- a/lib/common_test/src/ct_run.erl
+++ b/lib/common_test/src/ct_run.erl
@@ -58,6 +58,7 @@
 	       vts,
 	       shell,
 	       cover,
+	       cover_stop,
 	       coverspec,
 	       step,
 	       logdir,
@@ -245,6 +246,7 @@ script_start1(Parent, Args) ->
     Vts = get_start_opt(vts, true, Args),
     Shell = get_start_opt(shell, true, Args),
     Cover = get_start_opt(cover, fun([CoverFile]) -> ?abs(CoverFile) end, Args),
+    CoverStop = get_start_opt(cover_stop, fun([CS]) -> list_to_atom(CS) end, Args),
     LogDir = get_start_opt(logdir, fun([LogD]) -> LogD end, Args),
     LogOpts = get_start_opt(logopts, fun(Os) -> [list_to_atom(O) || O <- Os] end,
 			    [], Args),
@@ -329,7 +331,8 @@ script_start1(Parent, Args) ->
 		end,
 
    StartOpts = #opts{label = Label, profile = Profile,
-		     vts = Vts, shell = Shell, cover = Cover,
+		     vts = Vts, shell = Shell,
+		     cover = Cover, cover_stop = CoverStop,
 		     logdir = LogDir, logopts = LogOpts,
 		     basic_html = BasicHtml,
 		     verbosity = Verbosity,
@@ -416,6 +419,9 @@ script_start2(StartOpts = #opts{vts = undefined,
 			Cover =
 			    choose_val(StartOpts#opts.cover,
 				       SpecStartOpts#opts.cover),
+			CoverStop =
+			    choose_val(StartOpts#opts.cover_stop,
+				       SpecStartOpts#opts.cover_stop),
 			MultTT =
 			    choose_val(StartOpts#opts.multiply_timetraps,
 				       SpecStartOpts#opts.multiply_timetraps),
@@ -475,6 +481,7 @@ script_start2(StartOpts = #opts{vts = undefined,
 					   profile = Profile,
 					   testspecs = Specs,
 					   cover = Cover,
+					   cover_stop = CoverStop,
 					   logdir = LogDir,
 					   logopts = AllLogOpts,
 					   basic_html = BasicHtml,
@@ -723,6 +730,7 @@ script_usage() ->
 	      "\n\t[-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]"
 	      "\n\t[-stylesheet CSSFile]"	     
 	      "\n\t[-cover CoverCfgFile]"
+	      "\n\t[-cover_stop Bool]"
 	      "\n\t[-event_handler EvHandler1 EvHandler2 .. EvHandlerN]"
 	      "\n\t[-ct_hooks CTHook1 CTHook2 .. CTHookN]"
 	      "\n\t[-include InclDir1 InclDir2 .. InclDirN]"
@@ -745,6 +753,7 @@ script_usage() ->
 	      "\n\t[-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]"
 	      "\n\t[-stylesheet CSSFile]"
 	      "\n\t[-cover CoverCfgFile]"
+	      "\n\t[-cover_stop Bool]"
 	      "\n\t[-event_handler EvHandler1 EvHandler2 .. EvHandlerN]"
 	      "\n\t[-ct_hooks CTHook1 CTHook2 .. CTHookN]"
 	      "\n\t[-include InclDir1 InclDir2 .. InclDirN]"
@@ -938,6 +947,7 @@ run_test2(StartOpts) ->
     %% code coverage
     Cover = get_start_opt(cover,
 			  fun(CoverFile) -> ?abs(CoverFile) end, StartOpts),
+    CoverStop = get_start_opt(cover_stop, value, StartOpts),
 
     %% timetrap manipulation
     MultiplyTT = get_start_opt(multiply_timetraps, value, 1, StartOpts),
@@ -1000,7 +1010,8 @@ run_test2(StartOpts) ->
     Step = get_start_opt(step, value, StartOpts),
 
     Opts = #opts{label = Label, profile = Profile,
-		 cover = Cover, step = Step, logdir = LogDir,
+		 cover = Cover, cover_stop = CoverStop,
+		 step = Step, logdir = LogDir,
 		 logopts = LogOpts, basic_html = BasicHtml,
 		 config = CfgFiles,
 		 verbosity = Verbosity,
@@ -1063,6 +1074,8 @@ run_spec_file(Relaxed,
 	    AllConfig = merge_vals([CfgFiles, SpecOpts#opts.config]),
 	    Cover = choose_val(Opts#opts.cover,
 			       SpecOpts#opts.cover),
+	    CoverStop = choose_val(Opts#opts.cover_stop,
+				   SpecOpts#opts.cover_stop),
 	    MultTT = choose_val(Opts#opts.multiply_timetraps,
 				SpecOpts#opts.multiply_timetraps),
 	    ScaleTT = choose_val(Opts#opts.scale_timetraps,
@@ -1103,6 +1116,7 @@ run_spec_file(Relaxed,
 	    Opts1 = Opts#opts{label = Label,
 			      profile = Profile,
 			      cover = Cover,
+			      cover_stop = CoverStop,
 			      logdir = which(logdir, LogDir),
 			      logopts = AllLogOpts,
 			      stylesheet = Stylesheet,
@@ -1374,6 +1388,7 @@ get_data_for_node(#testspec{label = Labels,
 			    verbosity = VLvls,
 			    silent_connections = SilentConnsList,
 			    cover = CoverFs,
+			    cover_stop = CoverStops,
 			    config = Cfgs,
 			    userconfig = UsrCfgs,
 			    event_handler = EvHs,
@@ -1405,6 +1420,7 @@ get_data_for_node(#testspec{label = Labels,
 		      SCs -> SCs
 		  end,
     Cover = proplists:get_value(Node, CoverFs),
+    CoverStop = proplists:get_value(Node, CoverStops),
     MT = proplists:get_value(Node, MTs),
     ST = proplists:get_value(Node, STs),
     CreatePrivDir = proplists:get_value(Node, PDs),
@@ -1423,6 +1439,7 @@ get_data_for_node(#testspec{label = Labels,
 	  verbosity = Verbosity,
 	  silent_connections = SilentConns,
 	  cover = Cover,
+	  cover_stop = CoverStop,
 	  config = ConfigFiles,
 	  event_handlers = EvHandlers,
 	  ct_hooks = FiltCTHooks,
@@ -1576,14 +1593,7 @@ do_run(Tests, Misc, LogDir, LogOpts) when is_list(Misc),
 	    StepOpts ->
 		#opts{step = StepOpts}
 	end,
-    Opts1 =
-	case proplists:get_value(cover, Misc) of
-	    undefined ->
-		Opts;
-	    CoverFile ->
-		Opts#opts{cover = CoverFile}
-	end,
-    do_run(Tests, [], Opts1#opts{logdir = LogDir}, []);
+    do_run(Tests, [], Opts#opts{logdir = LogDir}, []);
 
 do_run(Tests, Skip, Opts, Args) when is_record(Opts, opts) ->
     #opts{label = Label, profile = Profile, cover = Cover,
@@ -1617,7 +1627,13 @@ do_run(Tests, Skip, Opts, Args) when is_record(Opts, opts) ->
 				{error,Reason} ->
 				    exit({error,Reason});
 				CoverSpec ->
-				    Opts#opts{coverspec = CoverSpec}
+				    CoverStop =
+					case Opts#opts.cover_stop of
+					    undefined -> true;
+					    Stop -> Stop
+					end,
+				    Opts#opts{coverspec = CoverSpec,
+					      cover_stop = CoverStop}
 			    end
 		    end,
 	    %% This env variable is used by test_server to determine
@@ -2120,7 +2136,8 @@ do_run_test(Tests, Skip, Opts) ->
 		    %% tell test_server which modules should be cover compiled
 		    %% note that actual compilation is done when tests start
 		    test_server_ctrl:cover(CovApp, CovFile, CovExcl, CovIncl,
-					   CovCross, CovExport, CovLevel),
+					   CovCross, CovExport, CovLevel,
+					   Opts#opts.cover_stop),
 		    %% save cover data (used e.g. to add nodes dynamically)
 		    ct_util:set_testdata({cover,CovData}),
 		    %% start cover on specified nodes
@@ -2584,6 +2601,9 @@ merge_arguments([LogDir={logdir,_}|Args], Merged) ->
 merge_arguments([CoverFile={cover,_}|Args], Merged) ->
     merge_arguments(Args, handle_arg(replace, CoverFile, Merged));
 
+merge_arguments([CoverStop={cover_stop,_}|Args], Merged) ->
+    merge_arguments(Args, handle_arg(replace, CoverStop, Merged));
+
 merge_arguments([{'case',TC}|Args], Merged) ->
     merge_arguments(Args, handle_arg(merge, {testcase,TC}, Merged));
 
diff --git a/lib/common_test/src/ct_testspec.erl b/lib/common_test/src/ct_testspec.erl
index a8b67d0329..0221b87d49 100644
--- a/lib/common_test/src/ct_testspec.erl
+++ b/lib/common_test/src/ct_testspec.erl
@@ -903,6 +903,8 @@ handle_data(logdir,Node,Dir,Spec) ->
     [{Node,ref2dir(Dir,Spec)}];
 handle_data(cover,Node,File,Spec) ->
     [{Node,get_absfile(File,Spec)}];
+handle_data(cover_stop,Node,Stop,_Spec) ->
+    [{Node,Stop}];
 handle_data(include,Node,Dirs=[D|_],Spec) when is_list(D) ->
     [{Node,ref2dir(Dir,Spec)} || Dir <- Dirs];
 handle_data(include,Node,Dir=[Ch|_],Spec) when is_integer(Ch) ->
@@ -1258,6 +1260,8 @@ valid_terms() ->
      {node,3},
      {cover,2},
      {cover,3},
+     {cover_stop,2},
+     {cover_stop,3},
      {config,2},
      {config,3},
      {config,4},
diff --git a/lib/common_test/src/ct_util.hrl b/lib/common_test/src/ct_util.hrl
index 196b5e46d0..c9c6514fa4 100644
--- a/lib/common_test/src/ct_util.hrl
+++ b/lib/common_test/src/ct_util.hrl
@@ -38,6 +38,7 @@
 		   verbosity=[],
 		   silent_connections=[],
 		   cover=[],
+		   cover_stop=[],
 		   config=[],
 		   userconfig=[],
 		   event_handler=[],