[ct] Add Suite argument to hook callback functions

An extra argument, Suite, is added as the first argument to each of
the following hook callback functions:

  - pre_init_per_group
  - post_init_per_group
  - pre_end_per_group
  - post_end_per_group
  - pre_init_per_testcase
  - post_init_per_testcase
  - pre_end_per_testcase
  - post_end_per_testcase
  - on_tc_fail
  - on_tc_skip

For backwards compatibility, if the new function is not exported from
a hook callback module, common_test will fall back to the old
interface and call the function without the Suite argument.

The reason for adding the new argument is that if a test suite is
skipped by a 'skip_suites' statement in the test specification, then
there will be no call to pre/post_init_per_suite, and thus the hook
has no other way of knowing which Suite is skipped when it gets the
on_tc_skip callback. The other callbacks are updated for symmetry.

1 files changed, 86 insertions, 55 deletions

diff --git a/lib/common_test/src/ct_hooks.erl b/lib/common_test/src/ct_hooks.erl
index c9a4abb5ee..60d1ea2b1c 100644
--- a/lib/common_test/src/ct_hooks.erl
+++ b/lib/common_test/src/ct_hooks.erl
@@ -92,15 +92,17 @@ init_tc(Mod, end_per_suite, Config) ->
     call(fun call_generic/3, Config, [pre_end_per_suite, Mod]);
 init_tc(Mod, {init_per_group, GroupName, Properties}, Config) ->
     maybe_start_locker(Mod, GroupName, Properties),
-    call(fun call_generic/3, Config, [pre_init_per_group, GroupName]);
-init_tc(_Mod, {end_per_group, GroupName, _}, Config) ->
-    call(fun call_generic/3, Config, [pre_end_per_group, GroupName]);
-init_tc(_Mod, {init_per_testcase,TC}, Config) ->
-    call(fun call_generic/3, Config, [pre_init_per_testcase, TC]);
-init_tc(_Mod, {end_per_testcase,TC}, Config) ->
-    call(fun call_generic/3, Config, [pre_end_per_testcase, TC]);
-init_tc(_Mod, TC = error_in_suite, Config) ->
-    call(fun call_generic/3, Config, [pre_init_per_testcase, TC]).
+    call(fun call_generic_fallback/3, Config,
+         [pre_init_per_group, Mod, GroupName]);
+init_tc(Mod, {end_per_group, GroupName, _}, Config) ->
+    call(fun call_generic_fallback/3, Config,
+         [pre_end_per_group, Mod, GroupName]);
+init_tc(Mod, {init_per_testcase,TC}, Config) ->
+    call(fun call_generic_fallback/3, Config, [pre_init_per_testcase, Mod, TC]);
+init_tc(Mod, {end_per_testcase,TC}, Config) ->
+    call(fun call_generic_fallback/3, Config, [pre_end_per_testcase, Mod, TC]);
+init_tc(Mod, TC = error_in_suite, Config) ->
+    call(fun call_generic_fallback/3, Config, [pre_init_per_testcase, Mod, TC]).
 
 %% @doc Called as each test case is completed. This includes all configuration
 %% tests.
@@ -126,23 +128,23 @@ end_tc(Mod, init_per_suite, Config, _Result, Return) ->
 end_tc(Mod, end_per_suite, Config, Result, _Return) ->
     call(fun call_generic/3, Result, [post_end_per_suite, Mod, Config],
 	'$ct_no_change');
-end_tc(_Mod, {init_per_group, GroupName, _}, Config, _Result, Return) ->
-    call(fun call_generic/3, Return, [post_init_per_group, GroupName, Config],
-	 '$ct_no_change');
+end_tc(Mod, {init_per_group, GroupName, _}, Config, _Result, Return) ->
+    call(fun call_generic_fallback/3, Return,
+         [post_init_per_group, Mod, GroupName, Config], '$ct_no_change');
 end_tc(Mod, {end_per_group, GroupName, Properties}, Config, Result, _Return) ->
-    Res = call(fun call_generic/3, Result,
-	       [post_end_per_group, GroupName, Config], '$ct_no_change'),
+    Res = call(fun call_generic_fallback/3, Result,
+	       [post_end_per_group, Mod, GroupName, Config], '$ct_no_change'),
     maybe_stop_locker(Mod, GroupName, Properties),
     Res;
-end_tc(_Mod, {init_per_testcase,TC}, Config, Result, _Return) ->
-    call(fun call_generic/3, Result, [post_init_per_testcase, TC, Config],
-	'$ct_no_change');
-end_tc(_Mod, {end_per_testcase,TC}, Config, Result, _Return) ->
-    call(fun call_generic/3, Result, [post_end_per_testcase, TC, Config],
-	 '$ct_no_change');
-end_tc(_Mod, TC = error_in_suite, Config, Result, _Return) ->
-    call(fun call_generic/3, Result, [post_end_per_testcase, TC, Config],
-	'$ct_no_change').
+end_tc(Mod, {init_per_testcase,TC}, Config, Result, _Return) ->
+    call(fun call_generic_fallback/3, Result,
+         [post_init_per_testcase, Mod, TC, Config], '$ct_no_change');
+end_tc(Mod, {end_per_testcase,TC}, Config, Result, _Return) ->
+    call(fun call_generic_fallback/3, Result,
+         [post_end_per_testcase, Mod, TC, Config], '$ct_no_change');
+end_tc(Mod, TC = error_in_suite, Config, Result, _Return) ->
+    call(fun call_generic_fallback/3, Result,
+         [post_end_per_testcase, Mod, TC, Config], '$ct_no_change').
 
 
 %% Case = TestCase | {TestCase,GroupName}
@@ -181,15 +183,21 @@ call_terminate(#ct_hook_config{ module = Mod, state = State} = Hook, _, _) ->
     {[],Hook}.
 
 call_cleanup(#ct_hook_config{ module = Mod, state = State} = Hook,
-	     Reason, [Function, _Suite | Args]) ->
+	     Reason, [Function | Args]) ->
     NewState = catch_apply(Mod,Function, Args ++ [Reason, State],
-			   State),
+			   State, true),
     {Reason, Hook#ct_hook_config{ state = NewState } }.
 
-call_generic(#ct_hook_config{ module = Mod, state = State} = Hook,
-	     Value, [Function | Args]) ->
+call_generic(Hook, Value, Meta) ->
+    do_call_generic(Hook, Value, Meta, false).
+
+call_generic_fallback(Hook, Value, Meta) ->
+    do_call_generic(Hook, Value, Meta, true).
+
+do_call_generic(#ct_hook_config{ module = Mod, state = State} = Hook,
+                Value, [Function | Args], Fallback) ->
     {NewValue, NewState} = catch_apply(Mod, Function, Args ++ [Value, State],
-				       {Value,State}),
+				       {Value,State}, Fallback),
     {NewValue, Hook#ct_hook_config{ state = NewState } }.
 
 %% Generic call function
@@ -257,15 +265,15 @@ remove(Key,List) when is_list(List) ->
 remove(_, Else) ->
     Else.
 
-%% Translate scopes, i.e. init_per_group,group1 -> end_per_group,group1 etc
-scope([pre_init_per_testcase, TC|_]) ->
-    [post_init_per_testcase, TC];
-scope([pre_end_per_testcase, TC|_]) ->
-    [post_end_per_testcase, TC];
-scope([pre_init_per_group, GroupName|_]) ->
-    [post_end_per_group, GroupName];
-scope([post_init_per_group, GroupName|_]) ->
-    [post_end_per_group, GroupName];
+%% Translate scopes, i.e. is_tuplenit_per_group,group1 -> end_per_group,group1 etc
+scope([pre_init_per_testcase, SuiteName, TC|_]) ->
+    [post_init_per_testcase, SuiteName, TC];
+scope([pre_end_per_testcase, SuiteName, TC|_]) ->
+    [post_end_per_testcase, SuiteName, TC];
+scope([pre_init_per_group, SuiteName, GroupName|_]) ->
+    [post_end_per_group, SuiteName, GroupName];
+scope([post_init_per_group, SuiteName, GroupName|_]) ->
+    [post_end_per_group, SuiteName, GroupName];
 scope([pre_init_per_suite, SuiteName|_]) ->
     [post_end_per_suite, SuiteName];
 scope([post_init_per_suite, SuiteName|_]) ->
@@ -273,14 +281,29 @@ scope([post_init_per_suite, SuiteName|_]) ->
 scope(init) ->
     none.
 
-terminate_if_scope_ends(HookId, [on_tc_skip,_Suite,{end_per_group,Name}], 
+strip_config([post_init_per_testcase, SuiteName, TC|_]) ->
+    [post_init_per_testcase, SuiteName, TC];
+strip_config([post_end_per_testcase, SuiteName, TC|_]) ->
+    [post_end_per_testcase, SuiteName, TC];
+strip_config([post_init_per_group, SuiteName, GroupName|_]) ->
+    [post_init_per_group, SuiteName, GroupName];
+strip_config([post_end_per_group, SuiteName, GroupName|_]) ->
+    [post_end_per_group, SuiteName, GroupName];
+strip_config([post_init_per_suite, SuiteName|_]) ->
+    [post_init_per_suite, SuiteName];
+strip_config([post_end_per_suite, SuiteName|_]) ->
+    [post_end_per_suite, SuiteName];
+strip_config(Other) ->
+    Other.
+
+
+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, [post_end_per_group, Suite, 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) ->
+terminate_if_scope_ends(HookId, Function0, Hooks) ->
+    Function = strip_config(Function0),
     case lists:keyfind(HookId, #ct_hook_config.id, Hooks) of
         #ct_hook_config{ id = HookId, scope = Function} = Hook ->
             terminate([Hook]),
@@ -384,21 +407,29 @@ pos(Id,[_|Rest],Num) ->
 
 
 catch_apply(M,F,A, Default) ->
+    catch_apply(M,F,A,Default,false).
+catch_apply(M,F,A, Default, Fallback) ->
+    not erlang:module_loaded(M) andalso (catch M:module_info()),
+    case erlang:function_exported(M,F,length(A)) of
+        false when Fallback ->
+            catch_apply(M,F,tl(A),Default,false);
+        false ->
+            Default;
+        true ->
+            catch_apply(M,F,A)
+    end.
+
+catch_apply(M,F,A) ->
     try
-	erlang:apply(M,F,A)
+        erlang:apply(M,F,A)
     catch _:Reason ->
-	    case erlang:get_stacktrace() of
-		%% Return the default if it was the CTH module which did not have the function.
-		[{M,F,A,_}|_] when Reason == undef ->
-		    Default;
-		Trace ->
-		    ct_logs:log("Suite Hook","Call to CTH failed: ~w:~p",
-				[error,{Reason,Trace}]),
-		    throw({error_in_cth_call,
-			   lists:flatten(
-			     io_lib:format("~w:~w/~w CTH call failed",
-					   [M,F,length(A)]))})
-	    end
+            Trace = erlang:get_stacktrace(),
+            ct_logs:log("Suite Hook","Call to CTH failed: ~w:~p",
+                            [error,{Reason,Trace}]),
+            throw({error_in_cth_call,
+                   lists:flatten(
+                     io_lib:format("~w:~w/~w CTH call failed",
+                                   [M,F,length(A)]))})
     end.