Merge branch 'bjorn/error-loggers/OTP-12864' into maint

* bjorn/error-loggers/OTP-12864:
  Add documentation
  Introduce sasl_report_SUITE
  Teach sasl_report to limit crash reports
  proc_lib: Add format/3
  Teach error_logger_tty_h to truncate big messages
  error_logger_tty_h: Refactor and modernize code
  Teach error_logger_file_h to truncate big messages
  error_logger_file_h: Refactor and modernize code
  Remove unused code in error logger handlers
  Add error_logger_h_SUITE
  sasl_SUITE: Add a rudimentary test of the utc_log configuration
  sasl_SUITE: Correct the log_file/1 test case
  proc_lib_SUITE: Remove added report handlers
  zip_SUITE: Don't trust priv_dir to be empty

1 files changed, 141 insertions, 0 deletions

diff --git a/lib/sasl/test/sasl_report_SUITE.erl b/lib/sasl/test/sasl_report_SUITE.erl
new file mode 100644
index 0000000000..940234f152
--- /dev/null
+++ b/lib/sasl/test/sasl_report_SUITE.erl
@@ -0,0 +1,141 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2015. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% %CopyrightEnd%
+%%
+-module(sasl_report_SUITE).
+-export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1,
+	 init_per_group/2,end_per_group/2]).
+-export([gen_server_crash/1]).
+
+-export([crash_me/0,start_link/0,init/1,handle_cast/2,terminate/2]).
+
+-include_lib("test_server/include/test_server.hrl").
+
+suite() -> [{ct_hooks,[ts_install_cth]}].
+
+all() ->
+    [gen_server_crash].
+
+groups() ->
+    [].
+
+init_per_suite(Config) ->
+    Config.
+
+end_per_suite(_Config) ->
+    ok.
+
+init_per_group(_GroupName, Config) ->
+    Config.
+
+end_per_group(_GroupName, Config) ->
+    Config.
+
+gen_server_crash(Config) ->
+    try
+	do_gen_server_crash(Config)
+    after
+	error_logger:tty(true),
+	ok = application:unset_env(sasl, sasl_error_logger),
+	ok = application:unset_env(kernel, error_logger_format_depth),
+	error_logger:add_report_handler(cth_log_redirect)
+    end,
+    ok.
+
+do_gen_server_crash(Config) ->
+    PrivDir = ?config(priv_dir, Config),
+    LogDir = filename:join(PrivDir, ?MODULE),
+    KernelLog = filename:join(LogDir, "kernel.log"),
+    SaslLog = filename:join(LogDir, "sasl.log"),
+    ok = filelib:ensure_dir(SaslLog),
+
+    error_logger:delete_report_handler(cth_log_redirect),
+    error_logger:tty(false),
+    application:stop(sasl),
+    ok = application:set_env(sasl, sasl_error_logger, {file,SaslLog},
+			     [{persistent,true}]),
+    application:set_env(kernel, error_logger_format_depth, 30),
+    error_logger:logfile({open,KernelLog}),
+    application:start(sasl),
+    io:format("~p\n", [gen_event:which_handlers(error_logger)]),
+
+    crash_me(),
+
+    error_logger:logfile(close),
+
+    check_file(KernelLog, 70000, 150000),
+    check_file(SaslLog, 50000, 100000),
+
+    ok.
+
+check_file(File, Min, Max) ->
+    {ok,Bin} = file:read_file(File),
+    Base = filename:basename(File),
+    io:format("*** Contents of ~s ***\n", [Base]),
+    io:put_chars([Bin,"\n"]),
+    Sz = byte_size(Bin),
+    io:format("Size: ~p (allowed range is ~p..~p)\n",
+	      [Sz,Min,Max]),
+    if
+	Sz < Min ->
+	    %% Truncated? Other problem?
+	    ?t:fail({too_short,Base});
+	Sz > Max ->
+	    %% Truncation doesn't work?
+	    ?t:fail({too_big,Base});
+	true ->
+	    ok
+    end.
+
+%%%
+%%% gen_server that crashes.
+%%%
+
+crash_me() ->
+    {ok,SuperPid} = supervisor:start_link(sasl_report_suite_supervisor, []),
+    [{Id,Pid,_,_}] = supervisor:which_children(SuperPid),
+    HugeData = gb_sets:from_list(lists:seq(1, 100000)),
+    gen_server:cast(Pid, HugeData),
+    Ref = monitor(process, Pid),
+    receive
+	{'DOWN',Ref,process,Pid,_} ->
+	    supervisor:terminate_child(SuperPid, Id),
+	    unlink(SuperPid),
+	    exit(SuperPid, kill),
+	    ok
+    end.
+
+start_link() ->
+    gen_server:start_link(?MODULE, [], []).
+
+init(_) ->
+    St = <<0:100000/unit:8>>,
+    {ok,St}.
+
+handle_cast(Big, St) ->
+    Seq = lists:seq(1, 10000),
+    self() ! Seq,
+    self() ! Seq,
+    self() ! Seq,
+    self() ! Seq,
+    self() ! Seq,
+    x = Big,
+    {noreply,St}.
+
+terminate(_, _) ->
+    ok.