Merge remote branch 'origin/peppe/common_test/cth_log_error' into maint

* origin/peppe/common_test/cth_log_error:
  Fix error in builtin hook calling non-existing function

OTP-11238

3 files changed, 172 insertions, 5 deletions

diff --git a/lib/common_test/src/cth_log_redirect.erl b/lib/common_test/src/cth_log_redirect.erl
index 958b7a94c7..83fc879967 100644
--- a/lib/common_test/src/cth_log_redirect.erl
+++ b/lib/common_test/src/cth_log_redirect.erl
@@ -46,7 +46,7 @@ post_init_per_group(Group, Config, Result, tc_log_async) ->
     case lists:member(parallel,proplists:get_value(
 				 tc_group_properties,Config,[])) of
 	true ->
-	    {Result, {set_log_func(ct_log),Group}};
+	    {Result, {set_log_func(tc_log),Group}};
 	false ->
 	    {Result, tc_log_async}
     end;
@@ -59,7 +59,7 @@ post_end_per_testcase(_TC, _Config, Result, State) ->
     gen_event:call(error_logger, ?MODULE, flush, 300000),
     {Result, State}.
 
-pre_end_per_group(Group, Config, {ct_log, Group}) ->
+pre_end_per_group(Group, Config, {tc_log, Group}) ->
     {Config, set_log_func(tc_log_async)};
 pre_end_per_group(_Group, Config, State) ->
     {Config, State}.
diff --git a/lib/common_test/test/ct_hooks_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE.erl
index 796a0832d7..596bfe3ff0 100644
--- a/lib/common_test/test/ct_hooks_SUITE.erl
+++ b/lib/common_test/test/ct_hooks_SUITE.erl
@@ -84,7 +84,7 @@ all(suite) ->
        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, prio_cth, no_config,
-       data_dir
+       data_dir, cth_log
       ]
     ).
 
@@ -222,7 +222,32 @@ data_dir(Config) when is_list(Config) ->
     do_test(data_dir, "ct_data_dir_SUITE.erl",
 	    [verify_data_dir_cth],Config).
 
-    
+cth_log(Config) when is_list(Config) ->    
+    %% test that cth_log_redirect writes properly to
+    %% unexpected I/O log
+    StartOpts = do_test(cth_log, "cth_log_SUITE.erl", [], Config),
+    Logdir = proplists:get_value(logdir, StartOpts),
+    UnexpIoLogs =
+	filelib:wildcard(
+	  filename:join(Logdir,
+			"ct_run*/cth.tests*/run*/unexpected_io.log.html")),
+    lists:foreach(
+      fun(UnexpIoLog) ->
+	      {ok,Bin} = file:read_file(UnexpIoLog),
+	      Ts = string:tokens(binary_to_list(Bin),[$\n]),
+	      Matches = lists:foldl(fun([$=,$E,$R,$R,$O,$R|_],  N) ->
+					    N+1;
+				       ([$L,$o,$g,$g,$e,$r|_],  N) ->
+					    N+1;
+				       (_, N) -> N
+				    end, 0, Ts),
+	      ct:pal("~p matches in ~tp", [Matches,UnexpIoLog]),
+	      if Matches > 10 -> ok;
+		 true -> exit({no_unexpected_io_found,UnexpIoLog})
+	      end
+      end, UnexpIoLogs),
+    ok.
+
 
 %%%-----------------------------------------------------------------
 %%% HELP FUNCTIONS
@@ -251,7 +276,8 @@ do_test(Tag, SuiteWildCard, CTHs, Config, Res, EC) ->
 			       Opts),
 
     TestEvents = events_to_check(Tag, EC),
-    ok = ct_test_support:verify_events(TestEvents, Events, Config).
+    ok = ct_test_support:verify_events(TestEvents, Events, Config),
+    Opts.
 
 setup(Test, Config) ->
     Opts0 = ct_test_support:get_opts(Config),
@@ -1187,6 +1213,23 @@ test_events(data_dir) ->
      {?eh,stop_logging,[]}
     ];
 
+test_events(cth_log) ->
+    [{?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,tc_start,{cth_log_SUITE,init_per_suite}},
+
+     {parallel,
+      [{?eh,tc_start,{ct_framework,{init_per_group,g1,[parallel]}}},
+       {?eh,tc_done,{ct_framework,{init_per_group,g1,[parallel]},ok}},
+       {?eh,test_stats,{30,0,{0,0}}},
+       {?eh,tc_start,{ct_framework,{end_per_group,g1,[parallel]}}},
+       {?eh,tc_done,{ct_framework,{end_per_group,g1,[parallel]},ok}}]},
+       
+     {?eh,tc_done,{cth_log_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}
+    ];
+
 test_events(ok) ->
     ok.
 
diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/cth_log_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/cth_log_SUITE.erl
new file mode 100644
index 0000000000..18dd07e87e
--- /dev/null
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/cth_log_SUITE.erl
@@ -0,0 +1,124 @@
+%%
+%% %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(cth_log_SUITE).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+
+%%--------------------------------------------------------------------
+%% @spec suite() -> Info
+%% Info = [tuple()]
+%% @end
+%%--------------------------------------------------------------------
+suite() ->
+    [{timetrap,{seconds,30}}].
+
+%%--------------------------------------------------------------------
+%% @spec init_per_suite(Config0) ->
+%%     Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+init_per_suite(Config) ->
+    Gen = spawn(fun() -> gen() end),
+    [{gen,Gen}|Config].
+
+%%--------------------------------------------------------------------
+%% @spec end_per_suite(Config0) -> void() | {save_config,Config1}
+%% Config0 = Config1 = [tuple()]
+%% @end
+%%--------------------------------------------------------------------
+end_per_suite(Config) ->
+    Gen = proplists:get_value(gen, Config),
+    exit(Gen, kill),
+    timer:sleep(100),
+    ok.
+
+%%--------------------------------------------------------------------
+%% @spec init_per_testcase(TestCase, Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+init_per_testcase(_TestCase, Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% @spec end_per_testcase(TestCase, Config0) ->
+%%               void() | {save_config,Config1} | {fail,Reason}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+end_per_testcase(_TestCase, _Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% @spec groups() -> [Group]
+%% Group = {GroupName,Properties,GroupsAndTestCases}
+%% GroupName = atom()
+%% Properties = [parallel | sequence | Shuffle | {RepeatType,N}]
+%% GroupsAndTestCases = [Group | {group,GroupName} | TestCase]
+%% TestCase = atom()
+%% Shuffle = shuffle | {shuffle,{integer(),integer(),integer()}}
+%% RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail |
+%%              repeat_until_any_ok | repeat_until_any_fail
+%% N = integer() | forever
+%% @end
+%%--------------------------------------------------------------------
+groups() ->
+    [{g1,[parallel,{repeat,10}],[tc1,tc2,tc3]}].
+
+%%--------------------------------------------------------------------
+%% @spec all() -> GroupsAndTestCases | {skip,Reason}
+%% GroupsAndTestCases = [{group,GroupName} | TestCase]
+%% GroupName = atom()
+%% TestCase = atom()
+%% Reason = term()
+%% @end
+%%--------------------------------------------------------------------
+all() -> 
+    [{group,g1}].
+
+tc1(_) ->
+    ct:sleep(100),
+    ok.
+tc2(_) ->
+    ct:sleep(100),
+    ok.
+tc3(_) ->
+    ct:sleep(100),
+    ok.
+
+%%%-----------------------------------------------------------------
+
+gen() ->
+    gen_loop(1).
+
+gen_loop(N) ->
+    ct:log("Logger iteration: ~p", [N]),
+    error_logger:error_report(N),
+    ct:sleep(200),
+    gen_loop(N+1).