Make it possible to use unique priv_dir names

Introduce the optional feature to have Test Server generate
priv_dir directory names that are unique for each test case
or config function. The name of the option/flag is
'unique_priv_dir' and it can be set to value 'auto' or
'manual'. If auto, Test Server creates each priv_dir
automatically (can be expensive in case of many and/or repeated
cases). If manual, the user needs to create the priv_dir
explicitly by calling ct:make_priv_dir/0.

4 files changed, 58 insertions, 25 deletions

diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl
index 0a77527b2f..83ed0a66d7 100644
--- a/lib/common_test/src/ct.erl
+++ b/lib/common_test/src/ct.erl
@@ -64,7 +64,7 @@
 	 print/1, print/2, print/3,
 	 pal/1, pal/2, pal/3,
 	 capture_start/0, capture_stop/0, capture_get/0, capture_get/1,
-	 fail/1, fail/2, comment/1, comment/2,
+	 fail/1, fail/2, comment/1, comment/2, make_priv_dir/0,
 	 testcases/2, userdata/2, userdata/3,
 	 timetrap/1, get_timetrap_info/0, sleep/1]).
 
@@ -673,6 +673,15 @@ send_html_comment(Comment) ->
     ct_util:set_testdata({comment,Html}),
     test_server:comment(Html).
 
+%%%-----------------------------------------------------------------
+%%% @spec make_priv_dir() -> ok | {error,Reason}
+%%%      Reason = term()
+%%% @doc If the test has been started with the unique_priv_dir 
+%%% option set to manual, in order for the test case to use the
+%%% private directory, it must first create it by calling
+%%% this function.
+make_priv_dir() ->
+    test_server:make_priv_dir().
 
 %%%-----------------------------------------------------------------
 %%% @spec get_target_name(Handle) -> {ok,TargetName} | {error,Reason}
diff --git a/lib/common_test/src/ct_logs.erl b/lib/common_test/src/ct_logs.erl
index bb30cafbeb..0cd9b5f7cb 100644
--- a/lib/common_test/src/ct_logs.erl
+++ b/lib/common_test/src/ct_logs.erl
@@ -1665,10 +1665,6 @@ make_all_suites_index(When) when is_atom(When) ->
     notify_and_lock_file(AbsIndexName),
     LogDirs = filelib:wildcard(logdir_prefix()++".*/*"++?logdir_ext),
     Sorted = sort_logdirs(LogDirs, []),
-
-    %%! --- Tue Jan 17 16:30:44 2012 --- peppe was here!
-    io:format(user, "~nLOGDIRS = ~p~nSORTED: ~p~n~n", [LogDirs,Sorted]),
-
     Result = make_all_suites_index1(When, AbsIndexName, Sorted),
     notify_and_unlock_file(AbsIndexName),
     Result;
@@ -1690,10 +1686,6 @@ make_all_suites_index(NewTestData = {_TestName,DirName}) ->
 		_           -> "..."
 	    end,
     notify_and_lock_file(AbsIndexName),
-
-    %%! --- Mon Jan 16 23:37:33 2012 --- peppe was here!
-    io:format(user, "ALL SUITES CACHED: ~p, ~p, ~p~n", [AbsIndexName,NewTestData,LogDirData]),
-
     Result =
 	case catch make_all_suites_ix_cached(AbsIndexName,
 					     NewTestData,
@@ -1781,10 +1773,6 @@ make_all_suites_index1(When, AbsIndexName, AllLogDirs) ->
     end.
 
 make_all_suites_index2(IndexName, AllTestLogDirs) ->
-
-%%! --- Mon Jan 16 23:40:08 2012 --- peppe was here!
-    io:format(user, "ALL SUITES (~p): ~p~n", [IndexName,AllTestLogDirs]),
-
     {ok,Index0,_Totals,CacheData} =
 	make_all_suites_index3(AllTestLogDirs,
 			       all_suites_index_header(),
diff --git a/lib/common_test/src/ct_run.erl b/lib/common_test/src/ct_run.erl
index 05b10bca32..7798d369d2 100644
--- a/lib/common_test/src/ct_run.erl
+++ b/lib/common_test/src/ct_run.erl
@@ -63,6 +63,7 @@
 	       stylesheet,
 	       multiply_timetraps = 1,
 	       scale_timetraps = false,
+	       unique_priv_dir = false,
 	       testspecs = [],
 	       tests}).
 
@@ -178,6 +179,10 @@ script_start1(Parent, Args) ->
 			    fun([CT]) -> list_to_atom(CT);
 			       ([]) -> true
 			    end, false, Args),
+    UniquePrivDir = get_start_opt(unique_priv_dir,
+				  fun([UPD]) -> list_to_atom(UPD);
+				     ([]) -> auto
+				  end, false, Args),
     EvHandlers = event_handler_args2opts(Args),
     CTHooks = ct_hooks_args2opts(Args),
     EnableBuiltinHooks = get_start_opt(enable_builtin_hooks,
@@ -255,7 +260,8 @@ script_start1(Parent, Args) ->
 		     silent_connections = SilentConns,
 		     stylesheet = Stylesheet,
 		     multiply_timetraps = MultTT,
-		     scale_timetraps = ScaleTT},
+		     scale_timetraps = ScaleTT,
+		     unique_priv_dir = UniquePrivDir},
 
     %% check if log files should be refreshed or go on to run tests...
     Result = run_or_refresh(StartOpts, Args),
@@ -322,12 +328,21 @@ script_start2(StartOpts = #opts{vts = undefined,
 
 			Cover = choose_val(StartOpts#opts.cover,
 					   SpecStartOpts#opts.cover),
-			MultTT = choose_val(StartOpts#opts.multiply_timetraps,
-					    SpecStartOpts#opts.multiply_timetraps),
-			ScaleTT = choose_val(StartOpts#opts.scale_timetraps,
-					     SpecStartOpts#opts.scale_timetraps),
-			AllEvHs = merge_vals([StartOpts#opts.event_handlers,
-					      SpecStartOpts#opts.event_handlers]),
+			MultTT =
+			    choose_val(StartOpts#opts.multiply_timetraps,
+				       SpecStartOpts#opts.multiply_timetraps),
+			ScaleTT =
+			    choose_val(StartOpts#opts.scale_timetraps,
+				       SpecStartOpts#opts.scale_timetraps),
+
+			UniquePrivDir =
+			    choose_val(StartOpts#opts.unique_priv_dir,
+				       SpecStartOpts#opts.unique_priv_dir),
+
+			AllEvHs = 
+			    merge_vals([StartOpts#opts.event_handlers,
+					SpecStartOpts#opts.event_handlers]),
+
 			AllCTHooks = merge_vals(
 					[StartOpts#opts.ct_hooks,
 					 SpecStartOpts#opts.ct_hooks]),
@@ -354,7 +369,8 @@ script_start2(StartOpts = #opts{vts = undefined,
 					       EnableBuiltinHooks,
 					   include = AllInclude,
 					   multiply_timetraps = MultTT,
-					   scale_timetraps = ScaleTT}}
+					   scale_timetraps = ScaleTT,
+					   unique_priv_dir = UniquePrivDir}}
 		end;
 	    _ ->
 		{undefined,StartOpts}
@@ -567,6 +583,7 @@ script_usage() ->
 	      "\n\t[-no_auto_compile]"
 	      "\n\t[-multiply_timetraps N]"
 	      "\n\t[-scale_timetraps]"
+	      "\n\t[-unique_priv_dir [auto | manual]]"
 	      "\n\t[-basic_html]\n\n"),
     io:format("Run tests from command line:\n\n"
 	      "\tct_run [-dir TestDir1 TestDir2 .. TestDirN] |"
@@ -586,6 +603,7 @@ script_usage() ->
 	      "\n\t[-no_auto_compile]"
 	      "\n\t[-multiply_timetraps N]"
 	      "\n\t[-scale_timetraps]"
+	      "\n\t[-unique_priv_dir [auto | manual]]"
 	      "\n\t[-basic_html]"
 	      "\n\t[-repeat N [-force_stop]] |"
 	      "\n\t[-duration HHMMSS [-force_stop]] |"
@@ -606,6 +624,7 @@ script_usage() ->
 	      "\n\t[-no_auto_compile]"
 	      "\n\t[-multiply_timetraps N]"
 	      "\n\t[-scale_timetraps]"
+	      "\n\t[-unique_priv_dir [auto | manual]]"
 	      "\n\t[-basic_html]"
 	      "\n\t[-repeat N [-force_stop]] |"
 	      "\n\t[-duration HHMMSS [-force_stop]] |"
@@ -782,6 +801,9 @@ run_test2(StartOpts) ->
     MultiplyTT = get_start_opt(multiply_timetraps, value, 1, StartOpts),
     ScaleTT = get_start_opt(scale_timetraps, value, false, StartOpts),
 
+    %% create unique priv dir names
+    UniquePrivDir = get_start_opt(unique_priv_dir, value, false, StartOpts),
+
     %% auto compile & include files
     Include =
 	case proplists:get_value(auto_compile, StartOpts) of
@@ -842,7 +864,8 @@ run_test2(StartOpts) ->
 		 silent_connections = SilentConns,
 		 stylesheet = Stylesheet,
 		 multiply_timetraps = MultiplyTT,
-		 scale_timetraps = ScaleTT},
+		 scale_timetraps = ScaleTT,
+		 unique_priv_dir = UniquePrivDir},
 
     %% test specification
     case proplists:get_value(spec, StartOpts) of
@@ -889,6 +912,8 @@ run_spec_file(Relaxed,
 				SpecOpts#opts.multiply_timetraps),
 	    ScaleTT = choose_val(Opts#opts.scale_timetraps,
 				 SpecOpts#opts.scale_timetraps),
+	    UniquePrivDir = choose_val(Opts#opts.unique_priv_dir,
+				       SpecOpts#opts.unique_priv_dir),
 	    AllEvHs = merge_vals([Opts#opts.event_handlers,
 				  SpecOpts#opts.event_handlers]),
 	    AllInclude = merge_vals([Opts#opts.include,
@@ -912,6 +937,7 @@ run_spec_file(Relaxed,
 			      testspecs = AbsSpecs,
 			      multiply_timetraps = MultTT,
 			      scale_timetraps = ScaleTT,
+			      unique_priv_dir = UniquePrivDir,
 			      ct_hooks = AllCTHooks,
 			      enable_builtin_hooks = EnableBuiltinHooks
 			     },
@@ -1170,7 +1196,8 @@ get_data_for_node(#testspec{label = Labels,
 			    enable_builtin_hooks = EnableBuiltinHooks,
 			    include = Incl,
 			    multiply_timetraps = MTs,
-			    scale_timetraps = STs}, Node) ->
+			    scale_timetraps = STs,
+			    unique_priv_dir = UPDs}, Node) ->
     Label = proplists:get_value(Node, Labels),
     Profile = proplists:get_value(Node, Profiles),
     LogDir = case proplists:get_value(Node, LogDirs) of
@@ -1184,6 +1211,7 @@ get_data_for_node(#testspec{label = Labels,
     Cover = proplists:get_value(Node, CoverFs),
     MT = proplists:get_value(Node, MTs),
     ST = proplists:get_value(Node, STs),
+    UniquePrivDir = proplists:get_value(Node, UPDs),
     ConfigFiles = [{?ct_config_txt,F} || {N,F} <- Cfgs, N==Node] ++
 	[CBF || {N,CBF} <- UsrCfgs, N==Node],
     EvHandlers =  [{H,A} || {N,H,A} <- EvHs, N==Node],
@@ -1200,7 +1228,8 @@ get_data_for_node(#testspec{label = Labels,
 	  enable_builtin_hooks = EnableBuiltinHooks,
 	  include = Include,
 	  multiply_timetraps = MT,
-	  scale_timetraps = ST}.
+	  scale_timetraps = ST,
+	  unique_priv_dir = UniquePrivDir}.
 
 refresh_logs(LogDir) ->
     {ok,Cwd} = file:get_cwd(),
@@ -1842,6 +1871,8 @@ do_run_test(Tests, Skip, Opts) ->
 	    test_server_ctrl:multiply_timetraps(Opts#opts.multiply_timetraps),
 	    test_server_ctrl:scale_timetraps(Opts#opts.scale_timetraps),
 
+	    test_server_ctrl:unique_priv_dir(Opts#opts.unique_priv_dir),
+
 	    ct_event:notify(#event{name=start_info,
 				   node=node(),
 				   data={NoOfTests,NoOfSuites,NoOfCases}}),
@@ -2419,6 +2450,10 @@ opts2args(EnvStartOpts) ->
 			  [{scale_timetraps,[]}];
 		     ({scale_timetraps,false}) ->
 			  [];
+		     ({unique_priv_dir,false}) ->
+			  [];
+		     ({unique_priv_dir,UPD}) when is_atom(UPD) ->
+			  [{unique_priv_dir,[UPD]}];
 		     ({force_stop,true}) ->
 			  [{force_stop,[]}];
 		     ({force_stop,false}) ->
diff --git a/lib/common_test/src/ct_util.hrl b/lib/common_test/src/ct_util.hrl
index bde832811a..da96743732 100644
--- a/lib/common_test/src/ct_util.hrl
+++ b/lib/common_test/src/ct_util.hrl
@@ -43,9 +43,10 @@
 		   include=[],
 		   multiply_timetraps=[],
 		   scale_timetraps=[],
+		   unique_priv_dir=[],
 		   alias=[],
 		   tests=[],
-		   merge_tests = true }).
+		   merge_tests=true}).
 
 -record(cover, {app=none,
 		level=details,