You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
473 lines
20 KiB
473 lines
20 KiB
%% Copyright (c) 2011 Basho Technologies, Inc. All Rights Reserved.
|
|
%%
|
|
%% This file is provided to you 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.
|
|
|
|
-module(lager_test_backend).
|
|
|
|
-behaviour(gen_event).
|
|
|
|
-export([init/1, handle_call/2, handle_event/2, handle_info/2, terminate/2,
|
|
code_change/3]).
|
|
|
|
-record(state, {level, buffer, ignored}).
|
|
-compile([{parse_transform, lager_transform}]).
|
|
|
|
-ifdef(TEST).
|
|
-include_lib("eunit/include/eunit.hrl").
|
|
-endif.
|
|
|
|
init([Level]) ->
|
|
{ok, #state{level=lager_util:level_to_num(Level), buffer=[], ignored=[]}}.
|
|
|
|
handle_call(count, #state{buffer=Buffer} = State) ->
|
|
{ok, length(Buffer), State};
|
|
handle_call(count_ignored, #state{ignored=Ignored} = State) ->
|
|
{ok, length(Ignored), State};
|
|
handle_call(flush, State) ->
|
|
{ok, ok, State#state{buffer=[], ignored=[]}};
|
|
handle_call(pop, #state{buffer=Buffer} = State) ->
|
|
case Buffer of
|
|
[] ->
|
|
{ok, undefined, State};
|
|
[H|T] ->
|
|
{ok, H, State#state{buffer=T}}
|
|
end;
|
|
handle_call(get_loglevel, #state{level=Level} = State) ->
|
|
{ok, Level, State};
|
|
handle_call({set_loglevel, Level}, State) ->
|
|
{ok, ok, State#state{level=lager_util:level_to_num(Level)}};
|
|
handle_call(_Request, State) ->
|
|
{ok, ok, State}.
|
|
|
|
handle_event({log, Level, Time, Message}, #state{level=LogLevel,
|
|
buffer=Buffer} = State) when Level >= LogLevel ->
|
|
{ok, State#state{buffer=Buffer ++ [{Level, Time, Message}]}};
|
|
handle_event({log, _Level, _Time, _Message}, #state{ignored=Ignored} = State) ->
|
|
{ok, State#state{ignored=Ignored ++ [ignored]}};
|
|
handle_event(_Event, State) ->
|
|
{ok, State}.
|
|
|
|
handle_info(_Info, State) ->
|
|
{ok, State}.
|
|
|
|
terminate(_Reason, _State) ->
|
|
ok.
|
|
|
|
code_change(_OldVsn, State, _Extra) ->
|
|
{ok, State}.
|
|
|
|
-ifdef(TEST).
|
|
|
|
pop() ->
|
|
gen_event:call(lager_event, ?MODULE, pop).
|
|
|
|
count() ->
|
|
gen_event:call(lager_event, ?MODULE, count).
|
|
|
|
count_ignored() ->
|
|
gen_event:call(lager_event, ?MODULE, count_ignored).
|
|
|
|
lager_test_() ->
|
|
{foreach,
|
|
fun setup/0,
|
|
fun cleanup/1,
|
|
[
|
|
{"observe that there is nothing up my sleeve",
|
|
fun() ->
|
|
?assertEqual(undefined, pop()),
|
|
?assertEqual(0, count())
|
|
end
|
|
},
|
|
{"logging works",
|
|
fun() ->
|
|
lager:warning("test message"),
|
|
?assertEqual(1, count()),
|
|
{Level, _Time, Message} = pop(),
|
|
?assertMatch(Level, lager_util:level_to_num(warning)),
|
|
[LevelStr, _LocStr, MsgStr] = re:split(Message, " ", [{return, list}, {parts, 3}]),
|
|
?assertEqual("[warning]", LevelStr),
|
|
?assertEqual("test message", MsgStr),
|
|
ok
|
|
end
|
|
},
|
|
{"logging with arguments works",
|
|
fun() ->
|
|
lager:warning("test message ~p", [self()]),
|
|
?assertEqual(1, count()),
|
|
{Level, _Time, Message} = pop(),
|
|
?assertMatch(Level, lager_util:level_to_num(warning)),
|
|
[LevelStr, _LocStr, MsgStr] = re:split(Message, " ", [{return, list}, {parts, 3}]),
|
|
?assertEqual("[warning]", LevelStr),
|
|
?assertEqual(lists:flatten(io_lib:format("test message ~p", [self()])), MsgStr),
|
|
ok
|
|
end
|
|
},
|
|
{"logging works from inside a begin/end block",
|
|
fun() ->
|
|
?assertEqual(0, count()),
|
|
begin
|
|
lager:warning("test message 2")
|
|
end,
|
|
?assertEqual(1, count()),
|
|
ok
|
|
end
|
|
},
|
|
{"logging works from inside a list comprehension",
|
|
fun() ->
|
|
?assertEqual(0, count()),
|
|
[lager:warning("test message") || _N <- lists:seq(1, 10)],
|
|
?assertEqual(10, count()),
|
|
ok
|
|
end
|
|
},
|
|
{"logging works from a begin/end block inside a list comprehension",
|
|
fun() ->
|
|
?assertEqual(0, count()),
|
|
[ begin lager:warning("test message") end || _N <- lists:seq(1, 10)],
|
|
?assertEqual(10, count()),
|
|
ok
|
|
end
|
|
},
|
|
{"logging works from a nested list comprehension",
|
|
fun() ->
|
|
?assertEqual(0, count()),
|
|
[ [lager:warning("test message") || _N <- lists:seq(1, 10)] ||
|
|
_I <- lists:seq(1, 10)],
|
|
?assertEqual(100, count()),
|
|
ok
|
|
end
|
|
},
|
|
{"log messages below the threshold are ignored",
|
|
fun() ->
|
|
?assertEqual(0, count()),
|
|
lager:debug("this message will be ignored"),
|
|
?assertEqual(0, count()),
|
|
?assertEqual(0, count_ignored()),
|
|
lager_mochiglobal:put(loglevel, 0),
|
|
lager:debug("this message should be ignored"),
|
|
?assertEqual(0, count()),
|
|
?assertEqual(1, count_ignored()),
|
|
lager:set_loglevel(?MODULE, debug),
|
|
lager:debug("this message should be logged"),
|
|
?assertEqual(1, count()),
|
|
?assertEqual(1, count_ignored()),
|
|
?assertEqual(debug, lager:get_loglevel(?MODULE)),
|
|
ok
|
|
end
|
|
}
|
|
]
|
|
}.
|
|
|
|
setup() ->
|
|
application:load(lager),
|
|
application:set_env(lager, handlers, [{?MODULE, [info]}]),
|
|
application:start(lager).
|
|
|
|
cleanup(_) ->
|
|
application:stop(lager),
|
|
application:unload(lager).
|
|
|
|
|
|
crash(Type) ->
|
|
spawn(fun() -> gen_server:call(crash, Type) end),
|
|
timer:sleep(100).
|
|
|
|
error_logger_redirect_crash_test_() ->
|
|
{foreach,
|
|
fun() ->
|
|
application:load(lager),
|
|
application:set_env(lager, error_logger_redirect, true),
|
|
application:set_env(lager, handlers, [{?MODULE, [error]}]),
|
|
application:start(lager),
|
|
crash:start()
|
|
end,
|
|
|
|
fun(_) ->
|
|
application:stop(lager),
|
|
application:unload(lager),
|
|
case whereis(crash) of
|
|
undefined -> ok;
|
|
Pid -> exit(Pid, kill)
|
|
end
|
|
end,
|
|
[
|
|
{"again, there is nothing up my sleeve",
|
|
fun() ->
|
|
?assertEqual(undefined, pop()),
|
|
?assertEqual(0, count())
|
|
end
|
|
},
|
|
{"bad return value",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(bad_return),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: bad return value: bleh", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"case clause",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(case_clause),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: no case clause matching {} in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"function clause",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(function_clause),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: no function clause matching crash:function({})", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"if clause",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(if_clause),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: no true branch found while evaluating if expression in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"try clause",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(try_clause),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: no try clause matching [] in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"undefined function",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(undef),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: call to undefined function crash:booger/0 from crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"bad math",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(badarith),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: bad arithmetic expression in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"bad match",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(badmatch),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: no match of right hand value {} in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"bad arity",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(badarity),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: fun called with wrong arity of 1 instead of 3 in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"bad arg1",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(badarg1),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: bad argument in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"bad arg2",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(badarg2),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: bad argument in call to erlang:iolist_to_binary([[102,111,111],bar]) in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"noproc",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(noproc),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: no such process or port in call to gen_event:call(foo, bar, baz)", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"badfun",
|
|
fun() ->
|
|
Pid = whereis(crash),
|
|
crash(badfun),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w gen_server crash terminated with reason: bad function booger in crash:handle_call/3", [Pid])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
}
|
|
|
|
]
|
|
}.
|
|
|
|
error_logger_redirect_test_() ->
|
|
{foreach,
|
|
fun() ->
|
|
application:load(lager),
|
|
application:set_env(lager, error_logger_redirect, true),
|
|
application:set_env(lager, handlers, [{?MODULE, [info]}]),
|
|
application:start(lager),
|
|
timer:sleep(100),
|
|
gen_event:call(lager_event, ?MODULE, flush)
|
|
end,
|
|
|
|
fun(_) ->
|
|
application:stop(lager),
|
|
application:unload(lager)
|
|
end,
|
|
[
|
|
{"error reports are printed",
|
|
fun() ->
|
|
error_logger:error_report([{this, is}, a, {silly, format}]),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w this: is a silly: format", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"string error reports are printed",
|
|
fun() ->
|
|
error_logger:error_report("this is less silly"),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w this is less silly", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"error messages are printed",
|
|
fun() ->
|
|
error_logger:error_msg("doom, doom has come upon you all"),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w doom, doom has come upon you all", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"info reports are printed",
|
|
fun() ->
|
|
error_logger:info_report([{this, is}, a, {silly, format}]),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[info] ~w this: is a silly: format", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"string info reports are printed",
|
|
fun() ->
|
|
error_logger:info_report("this is less silly"),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[info] ~w this is less silly", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"error messages are printed",
|
|
fun() ->
|
|
error_logger:info_msg("doom, doom has come upon you all"),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[info] ~w doom, doom has come upon you all", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"application stop reports",
|
|
fun() ->
|
|
error_logger:info_report([{application, foo}, {exited, quittin_time}, {type, lazy}]),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[info] ~w Application foo exited with reason: quittin_time", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"supervisor reports",
|
|
fun() ->
|
|
error_logger:error_report(supervisor_report, [{errorContext, france}, {offender, [{name, mini_steve}, {mfargs, {a, b, [c]}}, {pid, bleh}]}, {reason, fired}, {supervisor, {local, steve}}]),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w Supervisor steve had child mini_steve started with a:b(c) at bleh exit with reason fired in context france", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"supervisor_bridge reports",
|
|
fun() ->
|
|
error_logger:error_report(supervisor_report, [{errorContext, france}, {offender, [{mod, mini_steve}, {pid, bleh}]}, {reason, fired}, {supervisor, {local, steve}}]),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[error] ~w Supervisor steve had child at module mini_steve at bleh exit with reason fired in context france", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"application progress report",
|
|
fun() ->
|
|
error_logger:info_report(progress, [{application, foo}, {started_at, node()}]),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[info] ~w Application foo started on node ~w", [self(), node()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"supervisor progress report",
|
|
fun() ->
|
|
error_logger:info_report(progress, [{supervisor, {local, foo}}, {started, [{mfargs, {foo, bar, 1}}, {pid, baz}]}]),
|
|
timer:sleep(100),
|
|
{_, _, Msg} = pop(),
|
|
Expected = lists:flatten(io_lib:format("[info] ~w Supervisor foo started foo:bar/1 at pid baz", [self()])),
|
|
?assertEqual(Expected, lists:flatten(Msg))
|
|
end
|
|
},
|
|
{"messages should not be generated if they don't satisfy the threshold",
|
|
fun() ->
|
|
lager:set_loglevel(?MODULE, error),
|
|
error_logger:info_report([hello, world]),
|
|
timer:sleep(100),
|
|
?assertEqual(0, count()),
|
|
?assertEqual(0, count_ignored()),
|
|
lager:set_loglevel(?MODULE, info),
|
|
error_logger:info_report([hello, world]),
|
|
timer:sleep(100),
|
|
?assertEqual(1, count()),
|
|
?assertEqual(0, count_ignored()),
|
|
lager:set_loglevel(?MODULE, error),
|
|
lager_mochiglobal:put(loglevel, 0),
|
|
error_logger:info_report([hello, world]),
|
|
timer:sleep(100),
|
|
?assertEqual(1, count()),
|
|
?assertEqual(1, count_ignored())
|
|
end
|
|
}
|
|
]
|
|
}.
|
|
|
|
-endif.
|
|
|
|
|