From cd0f2a81ebdd3b510821eef69ff3eafed8c41fb8 Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Mon, 16 Feb 2015 23:54:17 +0100
Subject: Make it possible to print in the test case log from on_tc_* hook
 funcs

OTP-12468
---
 lib/common_test/src/ct_framework.erl |  6 ++++++
 lib/common_test/src/ct_logs.erl      | 31 ++++++++++++++++++++++++++++++-
 2 files changed, 36 insertions(+), 1 deletion(-)

(limited to 'lib/common_test/src')

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).
 %%%
@@ -277,6 +278,26 @@ end_tc(TCPid) ->
     %% possible exit signals from ct_logs before end_tc returns ok 
     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
 %%%
@@ -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);
-- 
cgit v1.2.3