Merge branch 'dev' into major

* dev:
  Add documentation for cth_log_redirect and built-in hooks
  Correct wrong match from lists:keyfind
  Update cth_log_redirect to wait for all error_logger events before ending test
  Force logging to framework log for parallel tests
  Add ct_log:ct_log funcion
  Add a hook for redirecting SASL and error_logger messages
  Add -enable_builtin_hooks <bool> config option
  Export write_events and add option to return a string

10 files changed, 276 insertions, 47 deletions

diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml
index dbb4310040..3b9620d0f2 100644
--- a/lib/common_test/doc/src/ct_hooks_chapter.xml
+++ b/lib/common_test/doc/src/ct_hooks_chapter.xml
@@ -405,6 +405,38 @@ terminate(State) ->
     ok.</code>
   </section>
 
+  <marker id="builtin_cths"/>
+  <section>
+    <title>Built-in CTHs</title>
+    <p>Common Test is delivered with a couple of general purpose CTHs that
+    can be enabled by the user to provide some generic testing functionality.
+    Some of these are enabled by default when starting running common_test,
+    they can be disabled by setting <c>enable_builtin_hooks</c> to
+    <c>false</c> on the command line or in the test specification. In the
+    table below there is a list of all current CTHs which are delivered with
+    Common Test.</p>
+
+    <table>
+      <row>
+	<cell><em>CTH Name</em></cell>
+	<cell><em>Is Built-in</em></cell>
+	<cell><em>Description</em></cell>
+      </row>
+      <row>
+	<cell>cth_log_redirect</cell>
+	<cell>yes</cell>
+	<cell>Captures all error_logger and SASL logging events and prints them
+	to the current test case log. If an event can not be associated with a
+	testcase it will be printed in the common test framework log. This will
+	happen for testcases which are run in parallel and events which occur
+	inbetween testcases. You can configure the level of
+	<seealso marker="sasl:sasl_app">SASL</seealso> events report
+	using the normal SASL mechanisms. </cell>
+      </row>
+    </table>
+
+  </section>
+
 </chapter>
 
 
diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index e668568795..816aa5b1eb 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -150,6 +150,8 @@
         <seealso marker="event_handler_chapter#event_handling">event handlers</seealso> including start arguments.</item>
       <item><c><![CDATA[-ct_hooks <ct_hooks>]]></c>, to install
         <seealso marker="ct_hooks_chapter#installing">Common Test Hooks</seealso> including start arguments.</item>
+      <item><c><![CDATA[-enable_builtin_hooks <bool>]]></c>, to enable/disable
+        <seealso marker="ct_hooks_chapter#builtin_cths">Built-in Common Test Hooks</seealso>. Default is <c>true</c>.</item>
       <item><c><![CDATA[-include]]></c>, specifies include directories (see above).</item>
       <item><c><![CDATA[-no_auto_compile]]></c>, disables the automatic test suite compilation feature (see above).</item>
       <item><c><![CDATA[-multiply_timetraps <n>]]></c>, extends <seealso marker="write_test_chapter#timetraps">timetrap
@@ -450,6 +452,8 @@
 
       {ct_hooks, CTHModules}.
       {ct_hooks, NodeRefs, CTHModules}.
+
+      {enable_builtin_hooks, Bool}.
     </pre>
       <p>Test terms:</p>
     <pre>
@@ -631,7 +635,11 @@
       <p>The minor log file contain full details of every single test
 	case, each one in a separate file. This way the files should
 	be easy to compare with previous test runs, even if the set of
-	test cases change.</p>
+	test cases change. If SASL is running those logs will also be
+        printed there by the
+	<seealso marker="common_test:ct_hooks_chapter#builtin_cths">
+	  cth_log_redirect built-in hook</seealso>.
+        </p>
       
       <p>Which information goes where is user configurable via the
 	test server controller. Three threshold values determine what
diff --git a/lib/common_test/src/Makefile b/lib/common_test/src/Makefile
index 5b23558a96..125aa828fb 100644
--- a/lib/common_test/src/Makefile
+++ b/lib/common_test/src/Makefile
@@ -68,7 +68,8 @@ MODULES= \
 	ct_config_xml \
 	ct_slave \
         ct_hooks\
-        ct_hooks_lock
+        ct_hooks_lock\
+	cth_log_redirect
 
 TARGET_MODULES= $(MODULES:%=$(EBIN)/%)
 BEAM_FILES= $(MODULES:%=$(EBIN)/%.$(EMULATOR))
diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl
index 66da3ef742..3a96190256 100644
--- a/lib/common_test/src/ct.erl
+++ b/lib/common_test/src/ct.erl
@@ -149,7 +149,7 @@ run(TestDirs) ->
 %%%               {repeat,N} | {duration,DurTime} | {until,StopTime} |
 %%%               {force_stop,Bool} | {decrypt,DecryptKeyOrFile} |
 %%%               {refresh_logs,LogDir} | {basic_html,Bool} | 
-%%%               {ct_hooks, CTHs}
+%%%               {ct_hooks, CTHs} | {enable_builtin_hooks,Bool}
 %%%   TestDirs = [string()] | string()
 %%%   Suites = [string()] | string()
 %%%   Cases = [atom()] | atom()
diff --git a/lib/common_test/src/ct_hooks.erl b/lib/common_test/src/ct_hooks.erl
index d5b585a831..ffafc582cf 100644
--- a/lib/common_test/src/ct_hooks.erl
+++ b/lib/common_test/src/ct_hooks.erl
@@ -34,6 +34,12 @@
 %% If you change this, remember to update ct_util:look -> stop clause as well.
 -define(config_name, ct_hooks).
 
+%% All of the hooks which are to be started by default. Remove by issuing
+%% -enable_builtin_hooks false to when starting common test.
+-define(BUILTIN_HOOKS,[#ct_hook_config{ module = cth_log_redirect,
+					opts = [],
+					prio = ctfirst }]).
+
 -record(ct_hook_config, {id, module, prio, scope, opts = [], state = []}).
 
 %% -------------------------------------------------------------------------
@@ -44,7 +50,8 @@
 -spec init(State :: term()) -> ok |
 			       {error, Reason :: term()}.
 init(Opts) ->
-    call(get_new_hooks(Opts, undefined), ok, init, []).
+    call(get_new_hooks(Opts, undefined) ++ get_builtin_hooks(Opts),
+	 ok, init, []).
 		      
 
 %% @doc Called after all suites are done.
@@ -283,6 +290,14 @@ get_new_hooks(Config) when is_list(Config) ->
 get_new_hooks(_Config) ->
     [].
 
+get_builtin_hooks(Opts) ->
+    case proplists:get_value(enable_builtin_hooks,Opts) of
+	false ->
+	    [];
+	_Else ->
+	    [{HookConf, call_id, undefined} || HookConf <- ?BUILTIN_HOOKS]
+    end.
+
 save_suite_data_async(Hooks) ->
     ct_util:save_suite_data_async(?config_name, Hooks).
 
@@ -290,7 +305,7 @@ get_hooks() ->
     lists:keysort(#ct_hook_config.prio,ct_util:read_suite_data(?config_name)).
 
 %% Sort all calls in this order:
-%% call_id < call_init < Hook Priority 1 < .. < Hook Priority N
+%% call_id < call_init < ctfirst < Priority 1 < .. < Priority N < ctlast
 %% If Hook Priority is equal, check when it has been installed and
 %% sort on that instead.
 resort(Calls, Hooks) ->
@@ -311,6 +326,14 @@ resort(Calls, Hooks) ->
 		      %% If priorities are equal, we check the position in the
 		      %% hooks list
 		      pos(Id1,Hooks) < pos(Id2,Hooks);
+		  P1 == ctfirst ->
+		      true;
+		  P2 == ctfirst ->
+		      false;
+		  P1 == ctlast ->
+		      false;
+		  P2 == ctlast ->
+		      true;
 		  true ->
 		      P1 < P2
 	      end
diff --git a/lib/common_test/src/ct_logs.erl b/lib/common_test/src/ct_logs.erl
index b839521e24..6a90441d53 100644
--- a/lib/common_test/src/ct_logs.erl
+++ b/lib/common_test/src/ct_logs.erl
@@ -36,7 +36,7 @@
 -export([make_all_suites_index/1,make_all_runs_index/1]).
 
 %% Logging stuff directly from testcase
--export([tc_log/3,tc_print/3,tc_pal/3,
+-export([tc_log/3,tc_print/3,tc_pal/3,ct_log/3,
 	 basic_html/0]).
 
 %% Simulate logger process for use without ct environment running
@@ -360,6 +360,23 @@ tc_pal(Category,Format,Args) ->
     ok.
 
 
+%%%-----------------------------------------------------------------
+%%% @spec tc_pal(Category,Format,Args) -> ok
+%%%      Category = atom()
+%%%      Format = string()
+%%%      Args = list()
+%%%
+%%% @doc Print and log to the ct framework log
+%%%
+%%% <p>This function is called by internal ct functions to
+%%% force logging to the ct framework log</p>
+ct_log(Category,Format,Args) ->
+    cast({ct_log,[{div_header(Category),[]},
+		  {Format,Args},
+		  {div_footer(),[]}]}),
+    ok.
+
+
 %%%=================================================================
 %%% Internal functions
 int_header() ->
@@ -516,7 +533,12 @@ logger_loop(State) ->
 	{clear_stylesheet,_} when State#logger_state.stylesheet == undefined ->
 	    logger_loop(State);
 	{clear_stylesheet,_} ->
-	    logger_loop(State#logger_state{stylesheet=undefined});	   
+	    logger_loop(State#logger_state{stylesheet=undefined});
+	{ct_log, List} ->
+	    Fd = State#logger_state.ct_log_fd,
+	    [begin io:format(Fd,Str,Args),io:nl(Fd) end ||
+				{Str,Args} <- List],
+	    logger_loop(State);
 	stop ->
 	    io:format(State#logger_state.ct_log_fd,
 		      int_header()++int_footer(),
diff --git a/lib/common_test/src/ct_run.erl b/lib/common_test/src/ct_run.erl
index 877ec9c7dd..0715b8abf8 100644
--- a/lib/common_test/src/ct_run.erl
+++ b/lib/common_test/src/ct_run.erl
@@ -55,6 +55,7 @@
 	       config = [],
 	       event_handlers = [],
 	       ct_hooks = [],
+	       enable_builtin_hooks = true,
 	       include = [],
 	       silent_connections,
 	       stylesheet,
@@ -173,6 +174,10 @@ script_start1(Parent, Args) ->
 			    end, false, Args),
     EvHandlers = event_handler_args2opts(Args),
     CTHooks = ct_hooks_args2opts(Args),
+    EnableBuiltinHooks = get_start_opt(enable_builtin_hooks,
+				       fun([CT]) -> list_to_atom(CT);
+					  ([]) -> true
+				       end, true, Args),
 
     %% check flags and set corresponding application env variables
 
@@ -237,6 +242,7 @@ script_start1(Parent, Args) ->
    StartOpts = #opts{label = Label, vts = Vts, shell = Shell, cover = Cover,
 		     logdir = LogDir, event_handlers = EvHandlers,
 		     ct_hooks = CTHooks,
+		     enable_builtin_hooks = EnableBuiltinHooks,
 		     include = IncludeDirs,
 		     silent_connections = SilentConns,
 		     stylesheet = Stylesheet,
@@ -311,6 +317,11 @@ script_start2(StartOpts = #opts{vts = undefined,
 			AllCTHooks = merge_vals(
 					[StartOpts#opts.ct_hooks,
 					 SpecStartOpts#opts.ct_hooks]),
+
+			EnableBuiltinHooks =
+			    choose_val(
+			      StartOpts#opts.enable_builtin_hooks,
+			      SpecStartOpts#opts.enable_builtin_hooks),
 			
 			AllInclude = merge_vals([StartOpts#opts.include,
 						 SpecStartOpts#opts.include]),
@@ -323,6 +334,8 @@ script_start2(StartOpts = #opts{vts = undefined,
 					   config = SpecStartOpts#opts.config,
 					   event_handlers = AllEvHs,
 					   ct_hooks = AllCTHooks,
+					   enable_builtin_hooks =
+					       EnableBuiltinHooks,
 					   include = AllInclude,
 					   multiply_timetraps = MultTT,
 					   scale_timetraps = ScaleTT}}
@@ -339,9 +352,7 @@ script_start2(StartOpts = #opts{vts = undefined,
 	{[],_} ->
 	    {error,no_testspec_specified};
 	{undefined,_} ->   % no testspec used
-	    case check_and_install_configfiles(InitConfig, TheLogDir,
-					       Opts#opts.event_handlers,
-					       Opts#opts.ct_hooks) of
+	    case check_and_install_configfiles(InitConfig, TheLogDir, Opts) of
 		ok ->      % go on read tests from start flags
 		    script_start3(Opts#opts{config=InitConfig,
 					    logdir=TheLogDir}, Args);
@@ -351,9 +362,7 @@ script_start2(StartOpts = #opts{vts = undefined,
 	{_,_} ->           % testspec used
 	    %% merge config from start flags with config from testspec
 	    AllConfig = merge_vals([InitConfig, Opts#opts.config]),
-	    case check_and_install_configfiles(AllConfig, TheLogDir,
-					       Opts#opts.event_handlers,
-					       Opts#opts.ct_hooks) of
+	    case check_and_install_configfiles(AllConfig, TheLogDir, Opts) of
 		ok ->      % read tests from spec
 		    {Run,Skip} = ct_testspec:prepare_tests(Terms, node()),
 		    do_run(Run, Skip, Opts#opts{config=AllConfig,
@@ -367,9 +376,7 @@ script_start2(StartOpts, Args) ->
     %% read config/userconfig from start flags
     InitConfig = ct_config:prepare_config_list(Args),
     LogDir = which(logdir, StartOpts#opts.logdir),
-    case check_and_install_configfiles(InitConfig, LogDir,
-				       StartOpts#opts.event_handlers,
-				       StartOpts#opts.ct_hooks) of
+    case check_and_install_configfiles(InitConfig, LogDir, StartOpts) of
 	ok ->      % go on read tests from start flags
 	    script_start3(StartOpts#opts{config=InitConfig,
 					 logdir=LogDir}, Args);
@@ -377,12 +384,17 @@ script_start2(StartOpts, Args) ->
 	    Error
     end.
 
-check_and_install_configfiles(Configs, LogDir, EvHandlers, CTHooks) ->
+check_and_install_configfiles(
+  Configs, LogDir, #opts{
+	     event_handlers = EvHandlers,
+	     ct_hooks = CTHooks,
+	     enable_builtin_hooks = EnableBuiltinHooks} ) ->
     case ct_config:check_config_files(Configs) of
 	false ->
 	    install([{config,Configs},
 		     {event_handler,EvHandlers},
-		     {ct_hooks,CTHooks}], LogDir);
+		     {ct_hooks,CTHooks},
+		     {enable_builtin_hooks,EnableBuiltinHooks}], LogDir);
 	{value,{error,{nofile,File}}} ->
 	    {error,{cant_read_config_file,File}};
 	{value,{error,{wrong_config,Message}}}->
@@ -451,18 +463,19 @@ script_start4(#opts{vts = true, config = Config, event_handlers = EvHandlers,
 script_start4(#opts{label = Label, shell = true, config = Config,
 		    event_handlers = EvHandlers,
 		    ct_hooks = CTHooks,
+		    enable_builtin_hooks = EnableBuiltinHooks,
 		    logdir = LogDir, testspecs = Specs}, _Args) ->
     %% label - used by ct_logs
     application:set_env(common_test, test_label, Label),
 
-    InstallOpts = [{config,Config},{event_handler,EvHandlers},
-		   {ct_hooks, CTHooks}],
     if Config == [] ->
 	    ok;
        true ->
 	    io:format("\nInstalling: ~p\n\n", [Config])
     end,
-    case install(InstallOpts) of
+    case install([{config,Config},{event_handler,EvHandlers},
+		  {ct_hooks, CTHooks},
+		  {enable_builtin_hooks,EnableBuiltinHooks}]) of
 	ok ->
 	    ct_util:start(interactive, LogDir),
 	    log_ts_names(Specs),
@@ -682,6 +695,11 @@ run_test1(StartOpts) ->
 
     %% CT Hooks
     CTHooks = get_start_opt(ct_hooks, value, [], StartOpts),
+    EnableBuiltinHooks = get_start_opt(enable_builtin_hooks,
+				       fun(EBH) when EBH == true;
+						     EBH == false ->
+					       EBH
+				       end, true, StartOpts),
 
     %% silent connections
     SilentConns = get_start_opt(silent_connections,
@@ -754,6 +772,7 @@ run_test1(StartOpts) ->
 		 cover = Cover, step = Step, logdir = LogDir, config = CfgFiles,
 		 event_handlers = EvHandlers,
 		 ct_hooks = CTHooks,
+		 enable_builtin_hooks = EnableBuiltinHooks,
 		 include = Include,
 		 silent_connections = SilentConns,
 		 stylesheet = Stylesheet,
@@ -808,24 +827,28 @@ run_spec_file(Relaxed,
 
 	    AllCTHooks = merge_vals([Opts#opts.ct_hooks,
 				      SpecOpts#opts.ct_hooks]),
+	    EnableBuiltinHooks = choose_val(Opts#opts.enable_builtin_hooks,
+					    SpecOpts#opts.enable_builtin_hooks),
 	    
 	    application:set_env(common_test, include, AllInclude),
 
-	    case check_and_install_configfiles(AllConfig,
-					       which(logdir,LogDir),
-					       AllEvHs,
-					       AllCTHooks) of
+	    Opts1 = Opts#opts{label = Label,
+			      cover = Cover,
+			      logdir = which(logdir, LogDir),
+			      config = AllConfig,
+			      event_handlers = AllEvHs,
+			      include = AllInclude,
+			      testspecs = AbsSpecs,
+			      multiply_timetraps = MultTT,
+			      scale_timetraps = ScaleTT,
+			      ct_hooks = AllCTHooks,
+			      enable_builtin_hooks = EnableBuiltinHooks
+			     },
+
+	    case check_and_install_configfiles(AllConfig,Opts1#opts.logdir,
+					       Opts1) of
 		ok ->
-		    Opts1 = Opts#opts{label = Label,
-				      cover = Cover,
-				      logdir = which(logdir, LogDir),
-				      config = AllConfig,
-				      event_handlers = AllEvHs,
-				      include = AllInclude,
-				      testspecs = AbsSpecs,
-				      multiply_timetraps = MultTT,
-				      scale_timetraps = ScaleTT,
-				      ct_hooks = AllCTHooks},
+
 		    {Run,Skip} = ct_testspec:prepare_tests(TS, node()),
 		    reformat_result(catch do_run(Run, Skip, Opts1, StartOpts));
 		{error,GCFReason} ->
@@ -834,13 +857,10 @@ run_spec_file(Relaxed,
     end.
 
 run_prepared(Run, Skip, Opts = #opts{logdir = LogDir,
-				     config = CfgFiles,
-				     event_handlers = EvHandlers,
-				     ct_hooks = CTHooks},
+				     config = CfgFiles },
 	     StartOpts) ->
     LogDir1 = which(logdir, LogDir),
-    case check_and_install_configfiles(CfgFiles, LogDir1,
-				       EvHandlers, CTHooks) of
+    case check_and_install_configfiles(CfgFiles, LogDir1, Opts) of
 	ok ->
 	    reformat_result(catch do_run(Run, Skip, Opts#opts{logdir = LogDir1},
 					 StartOpts));
@@ -872,7 +892,8 @@ check_config_file(Callback, File)->
 run_dir(Opts = #opts{logdir = LogDir,
 		     config = CfgFiles,
 		     event_handlers = EvHandlers,
-		     ct_hooks = CTHook }, StartOpts) ->
+		     ct_hooks = CTHook,
+		     enable_builtin_hooks = EnableBuiltinHooks }, StartOpts) ->
     LogDir1 = which(logdir, LogDir),
     Opts1 = Opts#opts{logdir = LogDir1},
     AbsCfgFiles =
@@ -895,7 +916,8 @@ run_dir(Opts = #opts{logdir = LogDir,
 		  end, CfgFiles),
     case install([{config,AbsCfgFiles},
 		  {event_handler,EvHandlers},
-		  {ct_hooks, CTHook}], LogDir1) of
+		  {ct_hooks, CTHook},
+		  {enable_builtin_hooks,EnableBuiltinHooks}], LogDir1) of
 	ok -> ok;
 	{error,IReason} -> exit(IReason)
     end,
@@ -999,9 +1021,8 @@ run_testspec1(TestSpec) ->
 		end,
 	    application:set_env(common_test, include, AllInclude),
 	    LogDir1 = which(logdir,Opts#opts.logdir),
-	    case check_and_install_configfiles(Opts#opts.config, LogDir1,
-					       Opts#opts.event_handlers,
-					       Opts#opts.ct_hooks) of
+	    case check_and_install_configfiles(
+		   Opts#opts.config, LogDir1, Opts) of
 		ok ->
 		    Opts1 = Opts#opts{testspecs = [],
 				      logdir = LogDir1,
@@ -1020,6 +1041,7 @@ get_data_for_node(#testspec{label = Labels,
 			    userconfig = UsrCfgs,
 			    event_handler = EvHs,
 			    ct_hooks = CTHooks,
+			    enable_builtin_hooks = EnableBuiltinHooks,
 			    include = Incl,
 			    multiply_timetraps = MTs,
 			    scale_timetraps = STs}, Node) ->
@@ -1042,6 +1064,7 @@ get_data_for_node(#testspec{label = Labels,
 	  config = ConfigFiles,
 	  event_handlers = EvHandlers,
 	  ct_hooks = FiltCTHooks,
+	  enable_builtin_hooks = EnableBuiltinHooks,
 	  include = Include,
 	  multiply_timetraps = MT,
 	  scale_timetraps = ST}.
@@ -2067,8 +2090,11 @@ get_start_opt(Key, IfExists, IfNotExists, Args) ->
     end.
 
 ct_hooks_args2opts(Args) ->
-    ct_hooks_args2opts(
-      proplists:get_value(ct_hooks, Args, []),[]).
+    lists:foldl(fun({ct_hooks,Hooks}, Acc) ->
+			ct_hooks_args2opts(Hooks,Acc);
+		   (_,Acc) ->
+			Acc
+		end,[],Args).
 
 ct_hooks_args2opts([CTH,Arg,Prio,"and"| Rest],Acc) ->
     ct_hooks_args2opts(Rest,[{list_to_atom(CTH),
diff --git a/lib/common_test/src/ct_testspec.erl b/lib/common_test/src/ct_testspec.erl
index d845358bb2..96971ccfc7 100644
--- a/lib/common_test/src/ct_testspec.erl
+++ b/lib/common_test/src/ct_testspec.erl
@@ -646,6 +646,10 @@ add_tests([{ct_hooks, _Node, []}|Ts], Spec) ->
 add_tests([{ct_hooks, Hooks}|Ts], Spec) ->
     add_tests([{ct_hooks, all_nodes, Hooks}|Ts], Spec);
 
+%% -- enable_builtin_hooks --
+add_tests([{enable_builtin_hooks,Bool}|Ts],Spec) ->
+    add_tests(Ts, Spec#testspec{ enable_builtin_hooks = Bool });
+
 %% --- include ---
 add_tests([{include,all_nodes,InclDirs}|Ts],Spec) ->
     Tests = lists:map(fun(N) -> {include,N,InclDirs} end, list_nodes(Spec)),
@@ -1104,6 +1108,7 @@ valid_terms() ->
      {event_handler,4},
      {ct_hooks,2},
      {ct_hooks,3},
+     {enable_builtin_hooks,1},
      {multiply_timetraps,2},
      {multiply_timetraps,3},
      {scale_timetraps,2},
diff --git a/lib/common_test/src/ct_util.hrl b/lib/common_test/src/ct_util.hrl
index 556f88c84d..dbe9d9b4e6 100644
--- a/lib/common_test/src/ct_util.hrl
+++ b/lib/common_test/src/ct_util.hrl
@@ -37,6 +37,7 @@
 		   userconfig=[],
 		   event_handler=[],
 		   ct_hooks=[],
+		   enable_builtin_hooks=true,
 		   include=[],
 		   multiply_timetraps=[],
 		   scale_timetraps=[],
diff --git a/lib/common_test/src/cth_log_redirect.erl b/lib/common_test/src/cth_log_redirect.erl
new file mode 100644
index 0000000000..14663b7738
--- /dev/null
+++ b/lib/common_test/src/cth_log_redirect.erl
@@ -0,0 +1,111 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 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(cth_log_redirect).
+
+%%% @doc Common Test Framework functions handling test specifications.
+%%%
+%%% <p>This module redirects sasl and error logger info to common test log.</p>
+%%% @end
+
+
+%% CTH Callbacks
+-export([id/1, init/2, post_init_per_group/4, pre_end_per_group/3,
+	 post_end_per_testcase/4]).
+
+%% Event handler Callbacks
+-export([init/1,
+	 handle_event/2, handle_call/2, handle_info/2,
+	 terminate/2]).
+
+id(_Opts) ->
+    ?MODULE.
+
+init(?MODULE, _Opts) ->
+    error_logger:add_report_handler(?MODULE),
+    tc_log.
+
+post_init_per_group(Group, Config, Result, tc_log) ->
+    case lists:member(parallel,proplists:get_value(
+				 tc_group_properties,Config,[])) of
+	true ->
+	    {Result, {set_log_func(ct_log),Group}};
+	false ->
+	    {Result, tc_log}
+    end;
+post_init_per_group(_Group, _Config, Result, State) ->
+    {Result, State}.
+
+post_end_per_testcase(_TC, _Config, Result, State) ->
+    %% Make sure that the event queue is flushed
+    %% before ending this test case.
+    gen_event:call(error_logger, ?MODULE, flush),
+    {Result, State}.
+
+pre_end_per_group(Group, Config, {ct_log, Group}) ->
+    {Config, set_log_func(tc_log)};
+pre_end_per_group(_Group, Config, State) ->
+    {Config, State}.
+
+
+%% Copied and modified from sasl_report_tty_h.erl
+init(_Type) ->
+    {ok, tc_log}.
+
+handle_event({_Type, GL, _Msg}, State) when node(GL) /= node() ->
+    {ok, State};
+handle_event(Event, LogFunc) ->
+    case lists:keyfind(sasl, 1, application:which_applications()) of
+	false ->
+	    sasl_not_started;
+	_Else ->
+	    {ok, ErrLogType} = application:get_env(sasl, errlog_type),
+	    SReport = sasl_report:format_report(group_leader(), ErrLogType,
+						tag_event(Event)),
+	    if is_list(SReport) ->
+		    ct_logs:LogFunc(sasl, SReport, []);
+	       true -> %% Report is an atom if no logging is to be done
+		    ignore
+	    end
+    end,
+    EReport = error_logger_tty_h:write_event(
+		tag_event(Event),io_lib),
+    if is_list(EReport) ->
+	    ct_logs:LogFunc(error_logger, EReport, []);
+       true -> %% Report is an atom if no logging is to be done
+	    ignore
+    end,
+    {ok, LogFunc}.
+
+
+handle_info(_,State) -> {ok, State}.
+
+handle_call(flush,State) ->
+    {ok, ok, State};
+handle_call({set_logfunc,NewLogFunc},_) ->
+    {ok, NewLogFunc, NewLogFunc};
+handle_call(_Query, _State) -> {error, bad_query}.
+
+terminate(_Reason, _Type) ->
+    [].
+
+tag_event(Event) ->
+    {calendar:local_time(), Event}.
+
+set_log_func(Func) ->
+    gen_event:call(error_logger, ?MODULE, {set_logfunc, Func}).