Merge branch 'lukas/common_test/ct_hook_bugs/OTP-9264' into dev

* lukas/common_test/ct_hook_bugs/OTP-9264:
  Fix bug which would make cth's to not be removed when out of scope when adding a cth in suite/0 and crashing in pre_init_per_suite.

3 files changed, 84 insertions, 6 deletions

diff --git a/lib/common_test/src/ct_hooks.erl b/lib/common_test/src/ct_hooks.erl
index 5eddefffce..984e04b90f 100644
--- a/lib/common_test/src/ct_hooks.erl
+++ b/lib/common_test/src/ct_hooks.erl
@@ -122,11 +122,11 @@ end_tc(_Mod, TC, Config, Result, _Return) ->
     call(fun call_generic/3, Result, [post_end_per_testcase, TC, Config],
 	'$ct_no_change').
 
-on_tc_skip(How, {_Suite, Case, Reason}) ->
-    call(fun call_cleanup/3, {How, Reason}, [on_tc_skip, Case]).
+on_tc_skip(How, {Suite, Case, Reason}) ->
+    call(fun call_cleanup/3, {How, Reason}, [on_tc_skip, Suite, Case]).
 
-on_tc_fail(_How, {_Suite, Case, Reason}) ->
-    call(fun call_cleanup/3, Reason, [on_tc_fail, Case]).
+on_tc_fail(_How, {Suite, Case, Reason}) ->
+    call(fun call_cleanup/3, Reason, [on_tc_fail, Suite, Case]).
 
 %% -------------------------------------------------------------------------
 %% Internal Functions
@@ -145,7 +145,7 @@ call_terminate({Mod, State}, _, _) ->
     catch_apply(Mod,terminate,[State], ok),
     {[],{Mod,State}}.
 
-call_cleanup({Mod, State}, Reason, [Function | Args]) ->
+call_cleanup({Mod, State}, Reason, [Function, _Suite | Args]) ->
     NewState = catch_apply(Mod,Function, Args ++ [Reason, State],
 			   State),
     {Reason, {Mod, NewState}}.
@@ -229,6 +229,11 @@ scope([post_init_per_suite, SuiteName|_]) ->
 scope(init) ->
     none.
 
+terminate_if_scope_ends(HookId, [on_tc_skip,_Suite,{end_per_group,Name}], 
+			Hooks) ->
+    terminate_if_scope_ends(HookId, [post_end_per_group, Name], Hooks);
+terminate_if_scope_ends(HookId, [on_tc_skip,Suite,end_per_suite], Hooks) ->
+    terminate_if_scope_ends(HookId, [post_end_per_suite, Suite], Hooks);
 terminate_if_scope_ends(HookId, [Function,Tag|T], Hooks) when T =/= [] ->
     terminate_if_scope_ends(HookId,[Function,Tag],Hooks);
 terminate_if_scope_ends(HookId, Function, Hooks) ->
diff --git a/lib/common_test/test/ct_hooks_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE.erl
index be1c02f163..8574d7aabc 100644
--- a/lib/common_test/test/ct_hooks_SUITE.erl
+++ b/lib/common_test/test/ct_hooks_SUITE.erl
@@ -79,7 +79,8 @@ all(suite) ->
        scope_per_suite_cth, scope_per_group_cth, scope_suite_cth,
        scope_per_suite_state_cth, scope_per_group_state_cth, 
        scope_suite_state_cth,
-       fail_pre_suite_cth, fail_post_suite_cth, skip_pre_suite_cth,
+       fail_pre_suite_cth, double_fail_pre_suite_cth,
+       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
@@ -167,6 +168,11 @@ fail_pre_suite_cth(Config) when is_list(Config) ->
     do_test(fail_pre_suite_cth, "ct_cth_empty_SUITE.erl",
 	    [fail_pre_suite_cth],Config).
 
+double_fail_pre_suite_cth(Config) when is_list(Config) ->
+    do_test(double_fail_pre_suite_cth, "{ct_scope_suite_crash_in_cth_SUITE.erl,"
+	    "ct_scope_suite_cth_SUITE.erl}",
+	    [],Config).
+
 fail_post_suite_cth(Config) when is_list(Config) ->
     do_test(fail_post_suite_cth, "ct_cth_empty_SUITE.erl",
 	    [fail_post_suite_cth],Config).
@@ -646,6 +652,23 @@ test_events(fail_pre_suite_cth) ->
      {?eh,stop_logging,[]}
     ];
 
+test_events(double_fail_pre_suite_cth) ->
+    [
+     {?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,tc_start,{'_',init_per_suite}},
+     {?eh,cth,{'_',init,['_',[]]}},
+     {?eh,cth,{'_',pre_init_per_suite,['_','$proplist',[]]}},
+     {?eh,cth,{'_',post_init_per_suite,['_','$proplist',
+					{fail,"Test failure"},[]]}},
+     {?eh,cth, {empty_cth,terminate,[[]]}},
+
+     {?eh,tc_start,{'_',init_per_suite}},
+     {?eh,cth,{'_',init,['_',[]]}},
+     {?eh,cth, {empty_cth,terminate,[[]]}},
+     {?eh,stop_logging,[]}
+    ];
+
 test_events(fail_post_suite_cth) ->
     [
      {?eh,start_logging,{'DEF','RUNDIR'}},
diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_scope_suite_crash_in_cth_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_scope_suite_crash_in_cth_SUITE.erl
new file mode 100644
index 0000000000..5aa6b0132d
--- /dev/null
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_scope_suite_crash_in_cth_SUITE.erl
@@ -0,0 +1,50 @@
+%%

+%% %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_scope_suite_crash_in_cth_SUITE).

+

+-suite_defaults([{timetrap, {minutes, 10}}]).

+

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

+-compile(export_all).

+

+-include("ct.hrl").

+

+%% Test server callback functions

+suite() ->

+    [{ct_hooks,[fail_pre_suite_cth]}].

+

+init_per_suite(Config) ->

+    Config.

+

+end_per_suite(_Config) ->

+    ok.

+

+init_per_testcase(_TestCase, Config) ->

+    Config.

+

+end_per_testcase(_TestCase, _Config) ->

+    ok.

+

+all() ->

+    [test_case].

+

+%% Test cases starts here.

+test_case(Config) when is_list(Config) ->

+    ok.