Merge remote-tracking branch 'origin/peppe/common_test/on_tc_fail_log' into maint

* origin/peppe/common_test/on_tc_fail_log:
  Modify some tests to verify that new functionality works
  Make it possible to print in the test case log from on_tc_* hook funcs

OTP-12468

3 files changed, 51 insertions, 1 deletions

diff --git a/lib/common_test/src/ct_framework.erl b/lib/common_test/src/ct_framework.erl
index e8ea7992b4..ec525784ec 100644
--- a/lib/common_test/src/ct_framework.erl
+++ b/lib/common_test/src/ct_framework.erl
@@ -1268,6 +1268,11 @@ report(What,Data) ->
 	    Data1 = if GrName == undefined -> {Suite,Func,Result};
 		       true                -> Data
 	    end,
+	    %% Register the group leader for the process calling the report
+	    %% function, making it possible for a hook function to print
+	    %% in the test case log file
+	    ReportingPid = self(),
+	    ct_logs:register_groupleader(ReportingPid, group_leader()),
 	    case Result of
 		{failed, _} ->
 		    ct_hooks:on_tc_fail(What, Data1);
@@ -1282,6 +1287,7 @@ report(What,Data) ->
 		_Else ->
 		    ok
 	    end,
+	    ct_logs:unregister_groupleader(ReportingPid),
 	    case {Func,Result} of
 		{init_per_suite,_} ->
 		    ok;
diff --git a/lib/common_test/src/ct_logs.erl b/lib/common_test/src/ct_logs.erl
index 7037cdca73..23332ad268 100644
--- a/lib/common_test/src/ct_logs.erl
+++ b/lib/common_test/src/ct_logs.erl
@@ -29,6 +29,7 @@
 -module(ct_logs).
 
 -export([init/2, close/2, init_tc/1, end_tc/1]).
+-export([register_groupleader/2, unregister_groupleader/1]).
 -export([get_log_dir/0, get_log_dir/1]).
 -export([log/3, start_log/1, cont_log/2, end_log/0]).
 -export([set_stylesheet/2, clear_stylesheet/1]).
@@ -267,7 +268,7 @@ init_tc(RefreshLog) ->
     ok.
 
 %%%-----------------------------------------------------------------
-%%% @spec end_tc(TCPid) -> ok | {error,Reason}
+%%% @spec end_tc(TCPid) -> ok
 %%%
 %%% @doc Test case clean up (tool-internal use only).
 %%%
@@ -278,6 +279,26 @@ end_tc(TCPid) ->
     call({end_tc,TCPid}).
 
 %%%-----------------------------------------------------------------
+%%% @spec register_groupleader(Pid,GroupLeader) -> ok
+%%%
+%%% @doc To enable logging to a group leader (tool-internal use only).
+%%%
+%%% <p>This function is called by ct_framework:report/2</p>
+register_groupleader(Pid,GroupLeader) ->
+    call({register_groupleader,Pid,GroupLeader}),
+    ok.
+
+%%%-----------------------------------------------------------------
+%%% @spec unregister_groupleader(Pid) -> ok
+%%%
+%%% @doc To disable logging to a group leader (tool-internal use only).
+%%%
+%%% <p>This function is called by ct_framework:report/2</p>
+unregister_groupleader(Pid) ->
+    call({unregister_groupleader,Pid}),
+    ok.
+
+%%%-----------------------------------------------------------------
 %%% @spec log(Heading,Format,Args) -> ok
 %%%
 %%% @doc Log internal activity (tool-internal use only).
@@ -764,6 +785,14 @@ logger_loop(State) ->
 	    return(From,ok),
 	    logger_loop(State#logger_state{tc_groupleaders =
 					       rm_tc_gl(TCPid,State)});
+	{{register_groupleader,Pid,GL},From} ->
+	    GLs = add_tc_gl(Pid,GL,State),
+	    return(From,ok),
+	    logger_loop(State#logger_state{tc_groupleaders = GLs});
+	{{unregister_groupleader,Pid},From} ->
+	    return(From,ok),
+	    logger_loop(State#logger_state{tc_groupleaders =
+					       rm_tc_gl(Pid,State)});
 	{{get_log_dir,true},From} ->
 	    return(From,{ok,State#logger_state.log_dir}),
 	    logger_loop(State);
diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
index 6caac7e447..77783fccf5 100644
--- a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
@@ -75,6 +75,7 @@
 init(Id, Opts) ->
     gen_event:notify(?CT_EVMGR_REF, #event{ name = cth, node = node(),
 					    data = {?MODULE, init, [Id, Opts]}}),
+    ct:log("~w:init called", [?MODULE]),
     {ok,Opts}.
 
 %% @doc The ID is used to uniquly identify an CTH instance, if two CTH's 
@@ -85,6 +86,7 @@ init(Id, Opts) ->
 id(Opts) ->
     gen_event:notify(?CT_EVMGR_REF, #event{ name = cth, node = node(),
 					    data = {?MODULE, id, [Opts]}}),
+    ct:log("~w:id called", [?MODULE]),
     now().
 
 %% @doc Called before init_per_suite is called. Note that this callback is
@@ -100,6 +102,7 @@ pre_init_per_suite(Suite,Config,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, pre_init_per_suite,
 				     [Suite,Config,State]}}),
+    ct:log("~w:pre_init_per_suite(~w) called", [?MODULE,Suite]),
     {Config, State}.
 
 %% @doc Called after init_per_suite.
@@ -114,6 +117,7 @@ post_init_per_suite(Suite,Config,Return,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, post_init_per_suite,
 				     [Suite,Config,Return,State]}}),
+    ct:log("~w:post_init_per_suite(~w) called", [?MODULE,Suite]),
     {Return, State}.
 
 %% @doc Called before end_per_suite. The config/state can be changed here,
@@ -127,6 +131,7 @@ pre_end_per_suite(Suite,Config,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, pre_end_per_suite,
 				     [Suite,Config,State]}}),
+    ct:log("~w:pre_end_per_suite(~w) called", [?MODULE,Suite]),
     {Config, State}.
 
 %% @doc Called after end_per_suite. Note that the config cannot be
@@ -141,6 +146,7 @@ post_end_per_suite(Suite,Config,Return,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, post_end_per_suite,
 				     [Suite,Config,Return,State]}}),
+    ct:log("~w:post_end_per_suite(~w) called", [?MODULE,Suite]),
     {Return, State}.
 
 %% @doc Called before each init_per_group.
@@ -154,6 +160,7 @@ pre_init_per_group(Group,Config,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, pre_init_per_group,
 				     [Group,Config,State]}}),
+    ct:log("~w:pre_init_per_group(~w) called", [?MODULE,Group]),
     {Config, State}.
 
 %% @doc Called after each init_per_group.
@@ -168,6 +175,7 @@ post_init_per_group(Group,Config,Return,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, post_init_per_group,
 				     [Group,Config,Return,State]}}),
+    ct:log("~w:post_init_per_group(~w) called", [?MODULE,Group]),
     {Return, State}.
 
 %% @doc Called after each end_per_group. The config/state can be changed here,
@@ -181,6 +189,7 @@ pre_end_per_group(Group,Config,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, pre_end_per_group,
 				     [Group,Config,State]}}),
+    ct:log("~w:pre_end_per_group(~w) called", [?MODULE,Group]),
     {Config, State}.
 
 %% @doc Called after each end_per_group. Note that the config cannot be
@@ -195,6 +204,7 @@ post_end_per_group(Group,Config,Return,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, post_end_per_group,
 				     [Group,Config,Return,State]}}),
+    ct:log("~w:post_end_per_group(~w) called", [?MODULE,Group]),
     {Return, State}.
 
 %% @doc Called before each test case.
@@ -208,6 +218,7 @@ pre_init_per_testcase(TC,Config,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, pre_init_per_testcase,
 				     [TC,Config,State]}}),
+    ct:log("~w:pre_init_per_testcase(~w) called", [?MODULE,TC]),
     {Config, State}.
 
 %% @doc Called after each test case. Note that the config cannot be
@@ -222,6 +233,7 @@ post_end_per_testcase(TC,Config,Return,State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, post_end_per_testcase,
 				     [TC,Config,Return,State]}}),
+    ct:log("~w:post_end_per_testcase(~w) called", [?MODULE,TC]),
     {Return, State}.
 
 %% @doc Called after post_init_per_suite, post_end_per_suite, post_init_per_group,
@@ -237,6 +249,7 @@ on_tc_fail(TC, Reason, State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, on_tc_fail,
 				     [TC,Reason,State]}}),
+    ct:log("~w:on_tc_fail(~w) called", [?MODULE,TC]),
     State.
 
 %% @doc Called when a test case is skipped by either user action
@@ -253,6 +266,7 @@ on_tc_skip(TC, Reason, State) ->
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, on_tc_skip,
 				     [TC,Reason,State]}}),
+    ct:log("~w:on_tc_skip(~w) called", [?MODULE,TC]),
     State.
 
 %% @doc Called when the scope of the CTH is done, this depends on
@@ -274,4 +288,5 @@ terminate(State) ->
     gen_event:notify(
       ?CT_EVMGR_REF, #event{ name = cth, node = node(),
 			     data = {?MODULE, terminate, [State]}}),
+    ct:log("~w:terminate called", [?MODULE]),
     ok.