Add test suite for the unique_priv_dir feature

8 files changed, 419 insertions, 8 deletions

diff --git a/lib/common_test/src/ct_run.erl b/lib/common_test/src/ct_run.erl
index 7798d369d2..19afb4b9f6 100644
--- a/lib/common_test/src/ct_run.erl
+++ b/lib/common_test/src/ct_run.erl
@@ -63,7 +63,7 @@
 	       stylesheet,
 	       multiply_timetraps = 1,
 	       scale_timetraps = false,
-	       unique_priv_dir = false,
+	       unique_priv_dir,
 	       testspecs = [],
 	       tests}).
 
@@ -182,7 +182,7 @@ script_start1(Parent, Args) ->
     UniquePrivDir = get_start_opt(unique_priv_dir,
 				  fun([UPD]) -> list_to_atom(UPD);
 				     ([]) -> auto
-				  end, false, Args),
+				  end, Args),
     EvHandlers = event_handler_args2opts(Args),
     CTHooks = ct_hooks_args2opts(Args),
     EnableBuiltinHooks = get_start_opt(enable_builtin_hooks,
@@ -802,7 +802,7 @@ run_test2(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),
+    UniquePrivDir = get_start_opt(unique_priv_dir, value, StartOpts),
 
     %% auto compile & include files
     Include =
@@ -1871,8 +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),
-
+	    test_server_ctrl:unique_priv_dir(choose_val(Opts#opts.unique_priv_dir,
+							false)),
 	    ct_event:notify(#event{name=start_info,
 				   node=node(),
 				   data={NoOfTests,NoOfSuites,NoOfCases}}),
@@ -2453,7 +2453,7 @@ opts2args(EnvStartOpts) ->
 		     ({unique_priv_dir,false}) ->
 			  [];
 		     ({unique_priv_dir,UPD}) when is_atom(UPD) ->
-			  [{unique_priv_dir,[UPD]}];
+			  [{unique_priv_dir,[atom_to_list(UPD)]}];
 		     ({force_stop,true}) ->
 			  [{force_stop,[]}];
 		     ({force_stop,false}) ->
diff --git a/lib/common_test/src/ct_testspec.erl b/lib/common_test/src/ct_testspec.erl
index b68cbd3aa1..9e8065c636 100644
--- a/lib/common_test/src/ct_testspec.erl
+++ b/lib/common_test/src/ct_testspec.erl
@@ -568,6 +568,21 @@ add_tests([{scale_timetraps,Node,ST}|Ts],Spec) ->
 add_tests([{scale_timetraps,ST}|Ts],Spec) ->
     add_tests([{scale_timetraps,all_nodes,ST}|Ts],Spec);
 
+%% --- unique_priv_dir ---
+add_tests([{unique_priv_dir,all_nodes,UPD}|Ts],Spec) ->
+    Tests = lists:map(fun(N) -> {unique_priv_dir,N,UPD} end, list_nodes(Spec)),
+    add_tests(Tests++Ts,Spec);
+add_tests([{unique_priv_dir,Nodes,UPD}|Ts],Spec) when is_list(Nodes) ->
+    Ts1 = separate(Nodes,unique_priv_dir,[UPD],Ts,Spec#testspec.nodes),
+    add_tests(Ts1,Spec);
+add_tests([{unique_priv_dir,Node,UPD}|Ts],Spec) ->
+    UPDs = Spec#testspec.unique_priv_dir,
+    UPDs1 = [{ref2node(Node,Spec#testspec.nodes),UPD} |
+	    lists:keydelete(ref2node(Node,Spec#testspec.nodes),1,UPDs)],
+    add_tests(Ts,Spec#testspec{unique_priv_dir=UPDs1});
+add_tests([{unique_priv_dir,UPD}|Ts],Spec) ->
+    add_tests([{unique_priv_dir,all_nodes,UPD}|Ts],Spec);
+
 %% --- config ---
 add_tests([{config,all_nodes,Files}|Ts],Spec) ->
     Tests = lists:map(fun(N) -> {config,N,Files} end, list_nodes(Spec)),
@@ -1158,7 +1173,8 @@ valid_terms() ->
      {skip_groups,6},
      {skip_groups,7},
      {skip_cases,5},
-     {skip_cases,6}
+     {skip_cases,6},
+     {unique_priv_dir,2}
     ].
 
 %% this function "guesses" if the user has misspelled a term name
diff --git a/lib/common_test/test/Makefile b/lib/common_test/test/Makefile
index 6d09a28634..332c444145 100644
--- a/lib/common_test/test/Makefile
+++ b/lib/common_test/test/Makefile
@@ -29,7 +29,7 @@ MODULES= \
 	ct_test_support_eh \
 	ct_userconfig_callback \
 	ct_smoke_test_SUITE \
-	ct_bugs_SUITE \
+	ct_priv_dir_SUITE \
 	ct_event_handler_SUITE \
 	ct_config_info_SUITE \
 	ct_groups_test_1_SUITE \
diff --git a/lib/common_test/test/ct_priv_dir_SUITE.erl b/lib/common_test/test/ct_priv_dir_SUITE.erl
new file mode 100644
index 0000000000..bfc579d7f1
--- /dev/null
+++ b/lib/common_test/test/ct_priv_dir_SUITE.erl
@@ -0,0 +1,255 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2009-2011. All Rights Reserved.
+%%
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+%%%-------------------------------------------------------------------
+%%% File: ct_priv_dir_SUITE
+%%%
+%%% Description: 
+%%% Test that it works to use the unique_priv_dir option.
+%%%
+%%%-------------------------------------------------------------------
+-module(ct_priv_dir_SUITE).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+-include_lib("common_test/include/ct_event.hrl").
+
+-define(eh, ct_test_support_eh).
+
+%%--------------------------------------------------------------------
+%% TEST SERVER CALLBACK FUNCTIONS
+%%--------------------------------------------------------------------
+
+%%--------------------------------------------------------------------
+%% Description: Since Common Test starts another Test Server
+%% instance, the tests need to be performed on a separate node (or
+%% there will be clashes with logging processes etc).
+%%--------------------------------------------------------------------
+init_per_suite(Config) ->
+    Config1 = ct_test_support:init_per_suite(Config),
+    Config1.
+
+end_per_suite(Config) ->
+    ct_test_support:end_per_suite(Config).
+
+init_per_testcase(TestCase, Config) ->
+    ct_test_support:init_per_testcase(TestCase, Config).
+
+end_per_testcase(TestCase, Config) ->
+    ct_test_support:end_per_testcase(TestCase, Config).
+
+suite() -> [{ct_hooks,[ts_install_cth]}].
+
+all() -> 
+    [
+     default,
+     unique_auto,
+     unique_manual,
+     spec_default,
+     spec_unique_auto,
+     spec_unique_manual
+    ].
+
+%%--------------------------------------------------------------------
+%% TEST CASES
+%%--------------------------------------------------------------------
+
+%%%-----------------------------------------------------------------
+%%% 
+default(Config) when is_list(Config) -> 
+    DataDir = ?config(data_dir, Config),
+    Suite = filename:join(DataDir, "priv_dir_SUITE"),
+    {Opts,ERPid} = setup([{suite,Suite},{testcase,default},
+			  {label,default}], Config),
+    ok = execute(default, Opts, ERPid, Config).
+
+%%%-----------------------------------------------------------------
+%%% 
+unique_auto(Config) when is_list(Config) -> 
+    DataDir = ?config(data_dir, Config),
+    Suite = filename:join(DataDir, "priv_dir_SUITE"),
+    {Opts,ERPid} = setup([{suite,Suite},{testcase,unique_auto},
+			  {label,unique_auto},
+			  {unique_priv_dir,auto}], Config),
+    ok = execute(unique_auto, Opts, ERPid, Config).
+
+%%%-----------------------------------------------------------------
+%%% 
+unique_manual(Config) when is_list(Config) -> 
+    DataDir = ?config(data_dir, Config),
+    Suite = filename:join(DataDir, "priv_dir_SUITE"),
+    {Opts,ERPid} = setup([{suite,Suite},{testcase,unique_manual},
+			  {label,unique_manual},
+			  {unique_priv_dir,manual}], Config),
+    ok = execute(unique_manual, Opts, ERPid, Config).
+
+%%%-----------------------------------------------------------------
+%%% 
+spec_default(Config) when is_list(Config) -> 
+    DataDir = ?config(data_dir, Config),
+    Spec = filename:join(DataDir, "default.spec"),
+    {Opts,ERPid} = setup([{spec,Spec},
+			  {label,spec_default}], Config),
+    ok = execute(spec_default, Opts, ERPid, Config).
+
+%%%-----------------------------------------------------------------
+%%% 
+spec_unique_auto(Config) when is_list(Config) -> 
+    DataDir = ?config(data_dir, Config),
+    Spec = filename:join(DataDir, "unique_auto.spec"),
+    {Opts,ERPid} = setup([{spec,Spec},
+			  {label,spec_unique_auto}], Config),
+    ok = execute(spec_unique_auto, Opts, ERPid, Config).
+
+%%%-----------------------------------------------------------------
+%%% 
+spec_unique_manual(Config) when is_list(Config) -> 
+    DataDir = ?config(data_dir, Config),
+    Spec = filename:join(DataDir, "unique_manual.spec"),
+    {Opts,ERPid} = setup([{spec,Spec},
+			  {label,spec_unique_manual}], Config),
+    ok = execute(spec_unique_manual, Opts, ERPid, Config).
+
+
+%%%-----------------------------------------------------------------
+%%% HELP FUNCTIONS
+%%%-----------------------------------------------------------------
+
+setup(Test, Config) ->
+    Opts0 = ct_test_support:get_opts(Config),
+    Level = ?config(trace_level, Config),
+    EvHArgs = [{cbm,ct_test_support},{trace_level,Level}],
+    Opts = Opts0 ++ [{event_handler,{?eh,EvHArgs}}|Test],
+    ERPid = ct_test_support:start_event_receiver(Config),
+    {Opts,ERPid}.
+
+execute(Name, Opts, ERPid, Config) ->
+    ok = ct_test_support:run(Opts, Config),
+    Events = ct_test_support:get_events(ERPid, Config),
+
+    ct_test_support:log_events(Name, 
+			       reformat(Events, ?eh),
+			       ?config(priv_dir, Config),
+			       Opts),
+
+    TestEvents = events_to_check(Name),
+    ct_test_support:verify_events(TestEvents, Events, Config).
+
+reformat(Events, EH) ->
+    ct_test_support:reformat(Events, EH).
+
+%%%-----------------------------------------------------------------
+%%% TEST EVENTS
+%%%-----------------------------------------------------------------
+events_to_check(Test) ->
+    %% 2 tests (ct:run_test + script_start) is default
+    events_to_check(Test, 2).
+
+events_to_check(_, 0) ->
+    [];
+events_to_check(Test, N) ->
+    test_events(Test) ++ events_to_check(Test, N-1).
+
+
+test_events(default) ->
+    [
+     {?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,start_info,{1,1,1}},
+     {?eh,tc_start,{priv_dir_SUITE,init_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,init_per_suite,ok}},
+     {?eh,tc_start,{priv_dir_SUITE,default}},
+     {?eh,tc_done,{priv_dir_SUITE,default,ok}},
+     {?eh,test_stats,{1,0,{0,0}}},
+     {?eh,tc_start,{priv_dir_SUITE,end_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}];
+
+test_events(unique_auto) ->
+    [{?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,start_info,{1,1,1}},
+     {?eh,tc_start,{priv_dir_SUITE,init_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,init_per_suite,ok}},
+     {?eh,tc_start,{priv_dir_SUITE,unique_auto}},
+     {?eh,tc_done,{priv_dir_SUITE,unique_auto,ok}},
+     {?eh,test_stats,{1,0,{0,0}}},
+     {?eh,tc_start,{priv_dir_SUITE,end_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}];
+
+test_events(unique_manual) ->
+    [{?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,start_info,{1,1,1}},
+     {?eh,tc_start,{priv_dir_SUITE,init_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,init_per_suite,ok}},
+     {?eh,tc_start,{priv_dir_SUITE,unique_manual}},
+     {?eh,tc_done,{priv_dir_SUITE,unique_manual,ok}},
+     {?eh,test_stats,{1,0,{0,0}}},
+     {?eh,tc_start,{priv_dir_SUITE,end_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}];
+
+test_events(spec_default) ->
+    [{?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,start_info,{1,1,1}},
+     {?eh,tc_start,{priv_dir_SUITE,init_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,init_per_suite,ok}},
+     {?eh,tc_start,{priv_dir_SUITE,default}},
+     {?eh,tc_done,{priv_dir_SUITE,default,ok}},
+     {?eh,test_stats,{1,0,{0,0}}},
+     {?eh,tc_start,{priv_dir_SUITE,end_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}];
+
+test_events(spec_unique_auto) ->
+    [{?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,start_info,{1,1,1}},
+     {?eh,tc_start,{priv_dir_SUITE,init_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,init_per_suite,ok}},
+     {?eh,tc_start,{priv_dir_SUITE,unique_auto}},
+     {?eh,tc_done,{priv_dir_SUITE,unique_auto,ok}},
+     {?eh,test_stats,{1,0,{0,0}}},
+     {?eh,tc_start,{priv_dir_SUITE,end_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}];
+
+test_events(spec_unique_manual) ->
+    [{?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,start_info,{1,1,1}},
+     {?eh,tc_start,{priv_dir_SUITE,init_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,init_per_suite,ok}},
+     {?eh,tc_start,{priv_dir_SUITE,unique_manual}},
+     {?eh,tc_done,{priv_dir_SUITE,unique_manual,ok}},
+     {?eh,test_stats,{1,0,{0,0}}},
+     {?eh,tc_start,{priv_dir_SUITE,end_per_suite}},
+     {?eh,tc_done,{priv_dir_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}].
+
diff --git a/lib/common_test/test/ct_priv_dir_SUITE_data/default.spec b/lib/common_test/test/ct_priv_dir_SUITE_data/default.spec
new file mode 100644
index 0000000000..2f053e792f
--- /dev/null
+++ b/lib/common_test/test/ct_priv_dir_SUITE_data/default.spec
@@ -0,0 +1,3 @@
+{alias, curr, "./"}.
+
+{cases, curr, priv_dir_SUITE, default}.
\ No newline at end of file
diff --git a/lib/common_test/test/ct_priv_dir_SUITE_data/priv_dir_SUITE.erl b/lib/common_test/test/ct_priv_dir_SUITE_data/priv_dir_SUITE.erl
new file mode 100644
index 0000000000..0fe337135b
--- /dev/null
+++ b/lib/common_test/test/ct_priv_dir_SUITE_data/priv_dir_SUITE.erl
@@ -0,0 +1,127 @@
+%%%-------------------------------------------------------------------
+%%% @author Peter Andersson <[email protected]>
+%%% @copyright (C) 2012, Peter Andersson
+%%% @doc
+%%%
+%%% @end
+%%% Created : 23 Jan 2012 by Peter Andersson <[email protected]>
+%%%-------------------------------------------------------------------
+-module(priv_dir_SUITE).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+
+%%--------------------------------------------------------------------
+%% @spec suite() -> Info
+%% Info = [tuple()]
+%% @end
+%%--------------------------------------------------------------------
+suite() ->
+    [{timetrap,{seconds,30}}].
+
+%%--------------------------------------------------------------------
+%% @spec init_per_suite(Config0) ->
+%%     Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+init_per_suite(Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% @spec end_per_suite(Config0) -> void() | {save_config,Config1}
+%% Config0 = Config1 = [tuple()]
+%% @end
+%%--------------------------------------------------------------------
+end_per_suite(_Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% @spec init_per_group(GroupName, Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% GroupName = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+init_per_group(_GroupName, Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% @spec end_per_group(GroupName, Config0) ->
+%%               void() | {save_config,Config1}
+%% GroupName = atom()
+%% Config0 = Config1 = [tuple()]
+%% @end
+%%--------------------------------------------------------------------
+end_per_group(_GroupName, _Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% @spec init_per_testcase(TestCase, Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+init_per_testcase(_TestCase, Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% @spec end_per_testcase(TestCase, Config0) ->
+%%               void() | {save_config,Config1} | {fail,Reason}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+end_per_testcase(_TestCase, _Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% @spec groups() -> [Group]
+%% Group = {GroupName,Properties,GroupsAndTestCases}
+%% GroupName = atom()
+%% Properties = [parallel | sequence | Shuffle | {RepeatType,N}]
+%% GroupsAndTestCases = [Group | {group,GroupName} | TestCase]
+%% TestCase = atom()
+%% Shuffle = shuffle | {shuffle,{integer(),integer(),integer()}}
+%% RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail |
+%%              repeat_until_any_ok | repeat_until_any_fail
+%% N = integer() | forever
+%% @end
+%%--------------------------------------------------------------------
+groups() ->
+    [].
+
+%%--------------------------------------------------------------------
+%% @spec all() -> GroupsAndTestCases | {skip,Reason}
+%% GroupsAndTestCases = [{group,GroupName} | TestCase]
+%% GroupName = atom()
+%% TestCase = atom()
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+all() -> 
+    [].
+
+default(Config) ->
+    PrivDir = proplists:get_value(priv_dir, Config),
+    "log_private" = filename:basename(PrivDir),
+    {ok,_} = file:list_dir(PrivDir).
+
+unique_auto(Config) ->
+    PrivDir = proplists:get_value(priv_dir, Config),
+    ["log_private",_] = string:tokens(filename:basename(PrivDir), "."),
+    {ok,_} = file:list_dir(PrivDir).
+
+unique_manual(Config) ->
+    PrivDir = proplists:get_value(priv_dir, Config),
+    ["log_private",_] = string:tokens(filename:basename(PrivDir), "."),
+    {error,_} = file:list_dir(PrivDir),
+    ok = ct:make_priv_dir(),
+    {ok,_} = file:list_dir(PrivDir).
+    
diff --git a/lib/common_test/test/ct_priv_dir_SUITE_data/unique_auto.spec b/lib/common_test/test/ct_priv_dir_SUITE_data/unique_auto.spec
new file mode 100644
index 0000000000..a64a09ecf0
--- /dev/null
+++ b/lib/common_test/test/ct_priv_dir_SUITE_data/unique_auto.spec
@@ -0,0 +1,5 @@
+{unique_priv_dir, auto}.
+
+{alias, curr, "./"}.
+
+{cases, curr, priv_dir_SUITE, unique_auto}.
\ No newline at end of file
diff --git a/lib/common_test/test/ct_priv_dir_SUITE_data/unique_manual.spec b/lib/common_test/test/ct_priv_dir_SUITE_data/unique_manual.spec
new file mode 100644
index 0000000000..9af9197c18
--- /dev/null
+++ b/lib/common_test/test/ct_priv_dir_SUITE_data/unique_manual.spec
@@ -0,0 +1,5 @@
+{unique_priv_dir, manual}.
+
+{alias, curr, "./"}.
+
+{cases, curr, priv_dir_SUITE, unique_manual}.
\ No newline at end of file