Merge branch 'maint'

* maint:
  dialyzer: Add a testcase
  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

4 files changed, 463 insertions, 14 deletions

diff --git a/lib/stdlib/test/Makefile b/lib/stdlib/test/Makefile
index d4ab674486..e366c2b755 100644
--- a/lib/stdlib/test/Makefile
+++ b/lib/stdlib/test/Makefile
@@ -30,6 +30,7 @@ MODULES= \
 	erl_lint_SUITE \
 	erl_pp_SUITE \
 	erl_scan_SUITE \
+	error_logger_h_SUITE \
 	escript_SUITE \
 	ets_SUITE \
 	ets_tough_SUITE \
diff --git a/lib/stdlib/test/error_logger_h_SUITE.erl b/lib/stdlib/test/error_logger_h_SUITE.erl
new file mode 100644
index 0000000000..b0b9c717a1
--- /dev/null
+++ b/lib/stdlib/test/error_logger_h_SUITE.erl
@@ -0,0 +1,400 @@
+%%
+%% %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(error_logger_h_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([logfile/1,logfile_truncated/1,tty/1,tty_truncated/1]).
+
+%% Event handler exports.
+-export([init/1,handle_event/2,terminate/2]).
+
+-include_lib("test_server/include/test_server.hrl").
+
+suite() -> [{ct_hooks,[ts_install_cth]}].
+
+all() ->
+    [logfile,logfile_truncated,tty,tty_truncated].
+
+groups() ->
+    [].
+
+init_per_suite(Config) ->
+    Config.
+
+end_per_suite(_Config) ->
+    ok.
+
+init_per_group(_GroupName, Config) ->
+    Config.
+
+end_per_group(_GroupName, Config) ->
+    Config.
+
+logfile(Config) ->
+    PrivDir = ?config(priv_dir, Config),
+    LogDir = filename:join(PrivDir, ?MODULE),
+    Log = filename:join(LogDir, "logfile.log"),
+    ok = filelib:ensure_dir(Log),
+
+    Ev = event_templates(),
+
+    do_one_logfile(Log, Ev, unlimited),
+
+    Pa = "-pa " ++ filename:dirname(code:which(?MODULE)),
+    {ok,Node} = start_node(logfile, Pa),
+    error_logger:logfile({open,Log}),
+    ok = rpc:call(Node, erlang, apply, [fun gen_events/1,[Ev]]),
+    AtNode = iolist_to_binary(["** at node ",atom_to_list(Node)," **"]),
+    error_logger:logfile(close),
+    analyse_events(Log, Ev, [AtNode], unlimited),
+
+    test_server:stop_node(Node),
+
+    cleanup(Log),
+    ok.
+
+logfile_truncated(Config) ->
+    PrivDir = ?config(priv_dir, Config),
+    LogDir = filename:join(PrivDir, ?MODULE),
+    Log = filename:join(LogDir, "logfile_truncated.log"),
+    ok = filelib:ensure_dir(Log),
+
+    Ev = event_templates(),
+
+    Depth = 20,
+    application:set_env(kernel, error_logger_format_depth, Depth),
+    try
+	do_one_logfile(Log, Ev, Depth)
+    after
+	application:unset_env(kernel, error_logger_format_depth)
+    end,
+
+    cleanup(Log),
+    ok.
+
+do_one_logfile(Log, Ev, Depth) ->
+    error_logger:logfile({open,Log}),
+    gen_events(Ev),
+    error_logger:logfile(close),
+    analyse_events(Log, Ev, [], Depth).
+
+tty(Config) ->
+    PrivDir = ?config(priv_dir, Config),
+    LogDir = filename:join(PrivDir, ?MODULE),
+    Log = filename:join(LogDir, "tty.log"),
+    ok = filelib:ensure_dir(Log),
+
+    Ev = event_templates(),
+
+    do_one_tty(Log, Ev, unlimited),
+
+    Pa = "-pa " ++ filename:dirname(code:which(?MODULE)),
+    {ok,Node} = start_node(logfile, Pa),
+    tty_log_open(Log),
+    ok = rpc:call(Node, erlang, apply, [fun gen_events/1,[Ev]]),
+    tty_log_close(),
+    AtNode = iolist_to_binary(["** at node ",atom_to_list(Node)," **"]),
+    analyse_events(Log, Ev, [AtNode], unlimited),
+
+    test_server:stop_node(Node),
+
+    cleanup(Log),
+    ok.
+
+tty_truncated(Config) ->
+    PrivDir = ?config(priv_dir, Config),
+    LogDir = filename:join(PrivDir, ?MODULE),
+    Log = filename:join(LogDir, "tty_truncated.log"),
+    ok = filelib:ensure_dir(Log),
+
+    Ev = event_templates(),
+
+    Depth = 20,
+    application:set_env(kernel, error_logger_format_depth, Depth),
+    try
+       do_one_tty(Log, Ev, Depth)
+    after
+	application:unset_env(kernel, error_logger_format_depth)
+    end,
+
+    cleanup(Log),
+    ok.
+
+do_one_tty(Log, Ev, Depth) ->
+    tty_log_open(Log),
+    gen_events(Ev),
+    tty_log_close(),
+    analyse_events(Log, Ev, [], Depth).
+
+tty_log_open(Log) ->
+    {ok,Fd} = file:open(Log, [write]),
+    Depth = case application:get_env(kernel, error_logger_format_depth) of
+		{ok,D} -> D;
+		_ -> unlimited
+	    end,
+    error_logger:add_report_handler(?MODULE, {Fd,Depth}),
+    Fd.
+
+tty_log_close() ->
+    error_logger:delete_report_handler(?MODULE),
+    ok.
+
+event_templates() ->
+    [{error_msg,["Pure error string\n",[]]},
+     {error_msg,["Pure error string with error ~p\n",[]]},
+     {error_msg,["Error string with ~p\n", [format]]},
+     {error_msg,["Error string with bad format ~p\n", []]},
+
+     {error_report,[error_atom]},
+     {error_report,["error string"]},
+     {error_report,[[{error_tag,value},error_value]]},
+
+     {info_msg,["Pure info string\n",[]]},
+     {info_msg,["Pure info string with error ~p\n",[]]},
+     {info_msg,["Pure string with ~p\n", [format]]},
+     {info_msg,["Pure string with bad format ~p\n", []]},
+
+     {info_report,[info_atom]},
+     {info_report,["info string"]},
+     {info_report,[[{info_tag,value},info_value]]},
+
+     {warning_msg,["Pure warning string\n",[]]},
+     {warning_msg,["Pure warning string with error ~p\n",[]]},
+     {warning_msg,["Warning string with ~p\n", [format]]},
+     {warning_msg,["Warning string with bad format ~p\n", []]},
+
+     {warning_report,[warning_atom]},
+     {warning_report,["warning string"]},
+     {warning_report,[[{warning_tag,value},warning_value]]},
+
+     %% Bigger terms.
+     {error_msg,["fairly big: ~p\n",[lists:seq(1, 128)]]},
+     {error_report,[list_to_tuple(lists:seq(1, 100))]},
+     {error_report,[lists:seq(32, 126)]},
+     {error_report,[[{tag,lists:seq(1, 64)}]]}
+    ].
+
+gen_events(Ev) ->
+    io:format("node = ~p\n", [node()]),
+    io:format("group leader = ~p\n", [group_leader()]),
+    io:format("~p\n", [gen_event:which_handlers(error_logger)]),
+    call_error_logger(Ev),
+
+    {Pid,Ref} = spawn_monitor(fun() -> error(ouch) end),
+    receive
+	{'DOWN',Ref,process,Pid,_} ->
+	    ok
+    end,
+
+    %% The following calls with a custom type will be ignored.
+    error_logger:error_report(ignored, value),
+    error_logger:warning_report(ignored, value),
+    error_logger:info_report(ignored, value),
+    receive after 100 -> ok end,
+    ok.
+
+analyse_events(Log, Ev, AtNode, Depth) ->
+    {ok,Bin} = file:read_file(Log),
+
+    io:format("*** Contents of log file ***\n\n~s\n", [Bin]),
+
+    Lines = binary:split(Bin, <<"\n">>, [global,trim_all]),
+    io:format("~p\n", [Lines]),
+
+    Rest = match_output(Ev, Lines, AtNode, Depth),
+    io:format("~p\n", [Rest]),
+
+    [] = match_emulator_error(Rest),
+    ok.
+
+
+call_error_logger([{F,Args}|T]) ->
+    apply(error_logger, F, Args),
+    call_error_logger(T);
+call_error_logger([]) -> ok.
+
+
+match_emulator_error([Head,Second,Third,_|Lines]) ->
+    match_head(<<"ERROR">>, Head),
+    {match,[{0,_}]} = re:run(Second,
+			   "^Error in process <\\d+[.]\\d+[.]\\d+> on "
+			   "node [^ ]* with exit value:"),
+    {match,[{0,_}]} = re:run(Third, "^[{]ouch,"),
+    Lines.
+
+match_output([Item|T], Lines0, AtNode, Depth) ->
+    try match_item(Item, Lines0, AtNode, Depth) of
+	Lines ->
+	    match_output(T, Lines, AtNode, Depth)
+    catch
+	C:E ->
+	    Stk = erlang:get_stacktrace(),
+	    io:format("ITEM: ~p", [Item]),
+	    io:format("LINES: ~p", [Lines0]),
+	    erlang:raise(C, E, Stk)
+    end;
+match_output([], Lines, _, _) -> Lines.
+
+match_item(Item, Lines, AtNode, Depth) ->
+    case item_type(Item) of
+	{msg,Head,Args} ->
+	    match_format(Head, Args, Lines, AtNode, Depth);
+	{report,Head,Args} ->
+	    match_term(Head, Args, Lines, AtNode, Depth)
+    end.
+
+item_type({error_msg,Args}) ->
+    {msg,<<"ERROR">>,Args};
+item_type({info_msg,Args}) ->
+    {msg,<<"INFO">>,Args};
+item_type({warning_msg,Args}) ->
+    {msg,<<"WARNING">>,Args};
+item_type({error_report,Args}) ->
+    {report,<<"ERROR">>,Args};
+item_type({info_report,Args}) ->
+    {report,<<"INFO">>,Args};
+item_type({warning_report,Args}) ->
+    {report,<<"WARNING">>,Args}.
+
+match_format(Tag, [Format,Args], [Head|Lines], AtNode, Depth) ->
+    match_head(Tag, Head),
+    Bin = try dl_format(Depth, Format, Args) of
+	      Str ->
+		  iolist_to_binary(Str)
+    catch
+	_:_ ->
+	    S = dl_format(Depth, "ERROR: ~p - ~p~n", [Format,Args]),
+	    iolist_to_binary(S)
+    end,
+    Expected0 = binary:split(Bin, <<"\n">>, [global,trim]),
+    Expected = Expected0 ++ AtNode,
+    match_term_lines(Expected, Lines).
+
+match_term(Tag, [Arg], [Head|Lines], AtNode, Depth) ->
+    match_head(Tag, Head),
+    Expected0 = match_term_get_expected(Arg, Depth),
+    Expected = Expected0 ++ AtNode,
+    match_term_lines(Expected, Lines).
+
+match_term_get_expected(List, Depth) when is_list(List) ->
+    Bin = try iolist_to_binary(dl_format(Depth, "~s\n", [List])) of
+	      Bin0 -> Bin0
+	  catch
+	      _:_ ->
+		  iolist_to_binary(format_rep(List, Depth))
+	  end,
+    binary:split(Bin, <<"\n">>, [global,trim]);
+match_term_get_expected(Term, Depth) ->
+    S = dl_format(Depth, "~p\n", [Term]),
+    Bin = iolist_to_binary(S),
+    binary:split(Bin, <<"\n">>, [global,trim]).
+
+format_rep([{Tag,Data}|Rep], Depth) ->
+    [dl_format(Depth, "    ~p: ~p\n", [Tag,Data])|
+     format_rep(Rep, Depth)];
+format_rep([Other|Rep], Depth) ->
+    [dl_format(Depth, "    ~p\n", [Other])|
+     format_rep(Rep, Depth)];
+format_rep([], _Depth) -> [].
+
+match_term_lines([Line|T], [Line|Lines]) ->
+    match_term_lines(T, Lines);
+match_term_lines([], Lines) -> Lines.
+
+match_head(Tag, Head) ->
+    Re = <<"^=",Tag/binary,
+	   " REPORT==== \\d\\d?-[A-Z][a-z][a-z]-\\d{4}::"
+	   "\\d\\d:\\d\\d:\\d\\d ===$">>,
+    {match,_} = re:run(Head, Re).
+
+start_node(Name, Args) ->
+    case test_server:start_node(Name, slave, [{args,Args}]) of
+	{ok,Node} ->
+	    {ok,Node};
+	Error  ->
+	    test_server:fail(Error)
+    end.
+
+cleanup(File) ->
+    %% The point of this test case is not to test file operations.
+    %% Therefore ignore any failures.
+    case file:delete(File) of
+	ok ->
+	    ok;
+	{error,Error1} ->
+	    io:format("file:delete(~s) failed with error ~p",
+		      [File,Error1])
+    end,
+    Dir = filename:dirname(File),
+    case file:del_dir(Dir) of
+	ok ->
+	    ok;
+	{error,Error2} ->
+	    io:format("file:del_dir(~s) failed with error ~p",
+		      [Dir,Error2])
+    end,
+    ok.
+
+
+%% Depth-limited io_lib:format. Intentionally implemented here instead
+%% of using io_lib:scan_format/2 to avoid using the same implementation
+%% as in the error_logger handlers.
+
+dl_format(unlimited, Format, Args) ->
+    io_lib:format(Format, Args);
+dl_format(Depth, Format0, Args0) ->
+    {Format,Args} = dl_format_1(Format0, Args0, Depth, [], []),
+    io_lib:format(Format, Args).
+
+dl_format_1("~p"++Fs, [A|As], Depth, Facc, Acc) ->
+    dl_format_1(Fs, As, Depth, [$P,$~|Facc], [Depth,A|Acc]);
+dl_format_1("~w"++Fs, [A|As], Depth, Facc, Acc) ->
+    dl_format_1(Fs, As, Depth, [$W,$~|Facc], [Depth,A|Acc]);
+dl_format_1("~s"++Fs, [A|As], Depth, Facc, Acc) ->
+    dl_format_1(Fs, As, Depth, [$s,$~|Facc], [A|Acc]);
+dl_format_1([F|Fs], As, Depth, Facc, Aacc) ->
+    dl_format_1(Fs, As, Depth, [F|Facc], Aacc);
+dl_format_1([], [], _, Facc, Aacc) ->
+    {lists:reverse(Facc),lists:reverse(Aacc)}.
+
+%%%
+%%% Our own event handler. There is no way to intercept the output
+%%% from error_logger_tty_h, but we can use the same code by
+%%% calling error_logger_tty_h:write_event/2.
+%%%
+
+init({_,_}=St) ->
+    {ok,St}.
+
+handle_event(Event, {Fd,Depth}=St) ->
+    case error_logger_tty_h:write_event(tag_event(Event), io_lib, Depth) of
+	ok ->
+	    ok;
+	Str when is_list(Str) ->
+	    io:put_chars(Fd, Str)
+    end,
+    {ok,St}.
+
+terminate(_Reason, {Fd,_}) ->
+    ok = file:close(Fd),
+    [].
+
+tag_event(Event) ->
+    {erlang:universaltime(),Event}.
diff --git a/lib/stdlib/test/proc_lib_SUITE.erl b/lib/stdlib/test/proc_lib_SUITE.erl
index 36f009eec6..3a8fa74d36 100644
--- a/lib/stdlib/test/proc_lib_SUITE.erl
+++ b/lib/stdlib/test/proc_lib_SUITE.erl
@@ -28,7 +28,7 @@
 	 init_per_group/2,end_per_group/2, 
 	 crash/1, sync_start_nolink/1, sync_start_link/1,
          spawn_opt/1, sp1/0, sp2/0, sp3/1, sp4/2, sp5/1,
-	 hibernate/1, stop/1]).
+	 hibernate/1, stop/1, t_format/1]).
 -export([ otp_6345/1, init_dont_hang/1]).
 
 -export([hib_loop/1, awaken/1]).
@@ -51,7 +51,7 @@ suite() -> [{ct_hooks,[ts_install_cth]}].
 
 all() -> 
     [crash, {group, sync_start}, spawn_opt, hibernate,
-     {group, tickets}, stop].
+     {group, tickets}, stop, t_format].
 
 groups() -> 
     [{tickets, [], [otp_6345, init_dont_hang]},
@@ -149,7 +149,11 @@ crash(Config) when is_list(Config) ->
 	    ?line ?t:fail({unexpected_message,Any})
 	after 2000 ->
 		ok
-	end.
+	end,
+
+    error_logger:delete_report_handler(?MODULE),
+    ok.
+
 
 
 sync_start_nolink(Config) when is_list(Config) ->
@@ -301,6 +305,7 @@ hibernate(Config) when is_list(Config) ->
     ?line {value,{initial_call,{?MODULE,hib_loop,[_]}}} =
 	lists:keysearch(initial_call, 1, Report),
 
+    error_logger:delete_report_handler(?MODULE),
     ok.
 
 hib_loop(LoopData) ->
@@ -452,6 +457,51 @@ system_terminate(crash,_Parent,_Deb,_State) ->
 system_terminate(Reason,_Parent,_Deb,_State) ->
     exit(Reason).
 
+
+t_format(_Config) ->
+    error_logger:tty(false),
+    try
+	t_format()
+    after
+	error_logger:tty(true)
+    end,
+    ok.
+
+t_format() ->
+    error_logger:add_report_handler(?MODULE, self()),
+    Pid = proc_lib:spawn(fun t_format_looper/0),
+    HugeData = gb_sets:from_list(lists:seq(1, 100)),
+    Pid ! {die,HugeData},
+    Report = receive
+		 {crash_report, Pid, Report0} -> Report0
+	     end,
+    Usz = do_test_format(Report, unlimited),
+    Tsz = do_test_format(Report, 20),
+
+    if
+	Tsz >= Usz ->
+	    ?t:fail();
+	true ->
+	    ok
+    end,
+
+    ok.
+
+do_test_format(Report, Depth) ->
+    io:format("*** Depth = ~p", [Depth]),
+    S0 = proc_lib:format(Report, latin1, Depth),
+    S = lists:flatten(S0),
+    io:put_chars(S),
+    length(S).
+
+t_format_looper() ->
+    receive
+	{die,Data} ->
+	    exit(Data);
+	_ ->
+	    t_format_looper()
+    end.
+
 %%-----------------------------------------------------------------
 %% The error_logger handler used.
 %%-----------------------------------------------------------------
diff --git a/lib/stdlib/test/zip_SUITE.erl b/lib/stdlib/test/zip_SUITE.erl
index 9d48d092cf..c275053691 100644
--- a/lib/stdlib/test/zip_SUITE.erl
+++ b/lib/stdlib/test/zip_SUITE.erl
@@ -556,9 +556,10 @@ unzip_to_binary(doc) ->
 unzip_to_binary(Config) when is_list(Config) ->
     DataDir = ?config(data_dir, Config),
     PrivDir = ?config(priv_dir, Config),
+    WorkDir = filename:join(PrivDir, "unzip_to_binary"),
+    _ = file:make_dir(WorkDir),
 
-    delete_all_in(PrivDir),
-    file:set_cwd(PrivDir),
+    ok = file:set_cwd(WorkDir),
     Long = filename:join(DataDir, "abc.zip"),
 
     %% Unzip a zip file into a binary
@@ -569,7 +570,7 @@ unzip_to_binary(Config) when is_list(Config) ->
                   end, FBList),
 
     %% Make sure no files created in cwd
-    {ok,[]} = file:list_dir(PrivDir),
+    {ok,[]} = file:list_dir(WorkDir),
 
     ok.
 
@@ -578,8 +579,10 @@ zip_to_binary(doc) ->
 zip_to_binary(Config) when is_list(Config) ->
     DataDir = ?config(data_dir, Config),
     PrivDir = ?config(priv_dir, Config),
-    delete_all_in(PrivDir),
-    file:set_cwd(PrivDir),
+    WorkDir = filename:join(PrivDir, "zip_to_binary"),
+    _ = file:make_dir(WorkDir),
+
+    file:set_cwd(WorkDir),
     FileName = "abc.txt",
     ZipName = "t.zip",
     FilePath = filename:join(DataDir, FileName),
@@ -589,7 +592,7 @@ zip_to_binary(Config) when is_list(Config) ->
     {ok, {ZipName, ZipB}} = zip:zip(ZipName, [FileName], [memory]),
 
     %% Make sure no files created in cwd
-    {ok,[FileName]} = file:list_dir(PrivDir),
+    {ok,[FileName]} = file:list_dir(WorkDir),
 
     %% Zip to a file
     {ok, ZipName} = zip:zip(ZipName, [FileName]),
@@ -696,11 +699,6 @@ do_delete_files([Item|Rest], Cnt) ->
     end,
     do_delete_files(Rest, Cnt + DelCnt).
 
-delete_all_in(Dir) ->
-    {ok, Files} = file:list_dir(Dir),
-    delete_files(lists:map(fun(F) -> filename:join(Dir,F) end,
-                           Files)).
-
 compress_control(doc) ->
     ["Test control of which files that should be compressed"];
 compress_control(suite) -> [];