Merge remote branch 'origin/peppe/common_test/otp-10022' into maint

* origin/peppe/common_test/otp-10022:
  Fix problem with wrong data_dir sent to hooks if init_per_* is missing

3 files changed, 219 insertions, 1 deletions

diff --git a/lib/common_test/test/ct_hooks_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE.erl
index efe57a7d0b..27fb7a4ef3 100644
--- a/lib/common_test/test/ct_hooks_SUITE.erl
+++ b/lib/common_test/test/ct_hooks_SUITE.erl
@@ -83,7 +83,8 @@ all(suite) ->
        fail_post_suite_cth, skip_pre_suite_cth,
        skip_post_suite_cth, recover_post_suite_cth, update_config_cth,
        state_update_cth, options_cth, same_id_cth, 
-       fail_n_skip_with_minimal_cth, prio_cth, no_config
+       fail_n_skip_with_minimal_cth, prio_cth, no_config,
+       data_dir
       ]
     ).
 
@@ -217,6 +218,12 @@ no_config(Config) when is_list(Config) ->
     do_test(no_config, "ct_no_config_SUITE.erl",
 	    [verify_config_cth],Config).
 
+data_dir(Config) when is_list(Config) ->
+    do_test(data_dir, "ct_data_dir_SUITE.erl",
+	    [verify_data_dir_cth],Config).
+
+    
+
 %%%-----------------------------------------------------------------
 %%% HELP FUNCTIONS
 %%%-----------------------------------------------------------------
@@ -1131,6 +1138,55 @@ test_events(no_config) ->
      {?eh,stop_logging,[]}
     ];
 
+test_events(data_dir) ->
+    [
+     {?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,cth,{empty_cth,init,[verify_data_dir_cth,[]]}},
+     {?eh,start_info,{1,1,2}},
+     {?eh,tc_start,{ct_framework,init_per_suite}},
+     {?eh,cth,{empty_cth,pre_init_per_suite,
+	       [ct_data_dir_SUITE,'$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+     {?eh,cth,{empty_cth,post_init_per_suite,
+	       [ct_data_dir_SUITE,'$proplist','$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+     {?eh,tc_done,{ct_framework,init_per_suite,ok}},
+     {?eh,tc_start,{ct_data_dir_SUITE,test_case_1}},
+     {?eh,cth,{empty_cth,pre_init_per_testcase,
+	       [test_case_1,'$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+     {?eh,cth,{empty_cth,post_end_per_testcase,
+	       [test_case_1,'$proplist',ok,[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+     {?eh,tc_done,{ct_data_dir_SUITE,test_case_1,ok}},
+     {?eh,test_stats,{1,0,{0,0}}},
+     [{?eh,tc_start,{ct_framework,{init_per_group,test_group,'$proplist'}}},
+      {?eh,cth,{empty_cth,pre_init_per_group,
+		[test_group,'$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+      {?eh,cth,{empty_cth,post_init_per_group,
+		[test_group,'$proplist','$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+      {?eh,tc_done,{ct_framework,
+		    {init_per_group,test_group,'$proplist'},ok}},
+      {?eh,tc_start,{ct_data_dir_SUITE,test_case_2}},
+      {?eh,cth,{empty_cth,pre_init_per_testcase,
+		[test_case_2,'$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+      {?eh,cth,{empty_cth,post_end_per_testcase,
+		[test_case_2,'$proplist',ok,[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+      {?eh,tc_done,{ct_data_dir_SUITE,test_case_2,ok}},
+      {?eh,test_stats,{2,0,{0,0}}},
+      {?eh,tc_start,{ct_framework,{end_per_group,test_group,'$proplist'}}},
+      {?eh,cth,{empty_cth,pre_end_per_group,
+		[test_group,'$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+      {?eh,cth,{empty_cth,post_end_per_group,
+		[test_group,'$proplist',ok,[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+      {?eh,tc_done,{ct_framework,{end_per_group,test_group,'$proplist'},ok}}],
+     {?eh,tc_start,{ct_framework,end_per_suite}},
+     {?eh,cth,{empty_cth,pre_end_per_suite,
+	       [ct_data_dir_SUITE,'$proplist',[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+     {?eh,cth,{empty_cth,post_end_per_suite,
+	       [ct_data_dir_SUITE,'$proplist',ok,[{data_dir_name,"ct_data_dir_SUITE_data"}]]}},
+     {?eh,tc_done,{ct_framework,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}
+    ];
+
 test_events(ok) ->
     ok.
 
diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_data_dir_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_data_dir_SUITE.erl
new file mode 100644
index 0000000000..b4a9079939
--- /dev/null
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_data_dir_SUITE.erl
@@ -0,0 +1,67 @@
+%%

+%% %CopyrightBegin%

+%%

+%% Copyright Ericsson AB 2010-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%

+%%

+

+-module(ct_data_dir_SUITE).

+

+%% Note: This directive should only be used in test suites.

+-compile(export_all).

+

+-include("ct.hrl").

+

+-define(data_dir_name, atom_to_list(?MODULE)++"_data").

+

+suite() ->

+    [{timetrap, {seconds,1}},

+     {ct_hooks, [verify_data_dir_cth]}].

+

+all() ->

+    [test_case_1, {group,test_group}].

+

+groups() ->

+    [{test_group,[],[test_case_2]}].

+

+init_per_testcase(_, Config) ->

+    check_dirs(Config),

+    Config.

+

+end_per_testcase(_, Config) ->

+    check_dirs(Config),

+    ok.

+

+test_case_1(Config) ->

+    check_dirs(Config),

+    ok.

+

+test_case_2(Config) ->

+    check_dirs(Config),

+    ok.

+

+check_dirs(Config) ->

+    %% check priv_dir

+    PrivDir = proplists:get_value(priv_dir, Config),

+    "log_private" = filename:basename(PrivDir),

+    {ok,_} = file:list_dir(PrivDir),

+    

+    %% check data_dir

+    DataDir = proplists:get_value(data_dir, Config),

+    DataDirName = ?data_dir_name,

+    DataDirName = filename:basename(DataDir),

+    ok.

+    

+

diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/verify_data_dir_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/verify_data_dir_cth.erl
new file mode 100644
index 0000000000..28cbc94c90
--- /dev/null
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/verify_data_dir_cth.erl
@@ -0,0 +1,95 @@
+%%

+%% %CopyrightBegin%

+%%

+%% Copyright Ericsson AB 2010-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%

+%%

+

+-module(verify_data_dir_cth).

+

+-include_lib("common_test/src/ct_util.hrl").

+

+%% CT Hooks

+-compile(export_all).

+

+-define(val(K, L), proplists:get_value(K, L)).

+

+check_dirs(State,Config) ->

+    DataDirName = ?val(data_dir_name, State),

+    %% check priv_dir

+    PrivDir = proplists:get_value(priv_dir, Config),

+    "log_private" = filename:basename(PrivDir),

+    {ok,_} = file:list_dir(PrivDir),

+    

+    %% check data_dir

+    DataDir = proplists:get_value(data_dir, Config),

+    DataDirName = filename:basename(DataDir),

+    ok.

+

+id(_Opts) ->

+    ?MODULE.

+

+init(Id, _Opts) ->

+    {ok, _State} = empty_cth:init(Id, []),

+    {ok, [{data_dir_name,"ct_data_dir_SUITE_data"}]}.

+

+pre_init_per_suite(Suite,Config,State) ->

+    check_dirs(State,Config),

+    empty_cth:pre_init_per_suite(Suite,Config,State).

+

+post_init_per_suite(Suite,Config,Return,State) ->

+    check_dirs(State,Return),

+    empty_cth:post_init_per_suite(Suite,Config,Return,State).

+

+pre_end_per_suite(Suite,Config,State) ->

+    check_dirs(State,Config),

+    empty_cth:pre_end_per_suite(Suite,Config,State).

+

+post_end_per_suite(Suite,Config,Return,State) ->

+    check_dirs(State,Config),

+    empty_cth:post_end_per_suite(Suite,Config,Return,State).

+

+pre_init_per_group(Group,Config,State) ->

+    check_dirs(State,Config),

+    empty_cth:pre_init_per_group(Group,Config,State).

+

+post_init_per_group(Group,Config,Return,State) ->

+    check_dirs(State,Return),

+    empty_cth:post_init_per_group(Group,Config,Return,State).

+

+pre_end_per_group(Group,Config,State) ->

+    check_dirs(State,Config),

+    empty_cth:pre_end_per_group(Group,Config,State).

+

+post_end_per_group(Group,Config,Return,State) ->

+    check_dirs(State,Config),

+    empty_cth:post_end_per_group(Group,Config,Return,State).

+

+pre_init_per_testcase(TC,Config,State) ->

+    check_dirs(State,Config),

+    empty_cth:pre_init_per_testcase(TC,Config,State).

+

+post_end_per_testcase(TC,Config,Return,State) ->

+    check_dirs(State,Config),

+    empty_cth:post_end_per_testcase(TC,Config,Return,State).

+

+on_tc_fail(TC, Reason, State) ->

+    empty_cth:on_tc_fail(TC,Reason,State).

+

+on_tc_skip(TC, Reason, State) ->

+    empty_cth:on_tc_skip(TC,Reason,State).

+

+terminate(State) ->

+    empty_cth:terminate(State).