選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

1203 行
65 KiB

14年前
14年前
14年前
14年前
14年前
14年前
14年前
14年前
14年前
  1. %% Copyright (c) 2011-2012 Basho Technologies, Inc. All Rights Reserved.
  2. %%
  3. %% This file is provided to you under the Apache License,
  4. %% Version 2.0 (the "License"); you may not use this file
  5. %% except in compliance with the License. You may obtain
  6. %% a copy of the License at
  7. %%
  8. %% http://www.apache.org/licenses/LICENSE-2.0
  9. %%
  10. %% Unless required by applicable law or agreed to in writing,
  11. %% software distributed under the License is distributed on an
  12. %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  13. %% KIND, either express or implied. See the License for the
  14. %% specific language governing permissions and limitations
  15. %% under the License.
  16. -module(lager_test_backend).
  17. -include("lager.hrl").
  18. -behaviour(gen_event).
  19. -export([init/1, handle_call/2, handle_event/2, handle_info/2, terminate/2,
  20. code_change/3]).
  21. -record(state, {level, buffer, ignored}).
  22. -record(test, {attrs, format, args}).
  23. -compile([{parse_transform, lager_transform}]).
  24. -ifdef(TEST).
  25. -include_lib("eunit/include/eunit.hrl").
  26. -export([pop/0, count/0, count_ignored/0, flush/0, print_state/0]).
  27. -endif.
  28. init(Level) ->
  29. {ok, #state{level=lager_util:config_to_mask(Level), buffer=[], ignored=[]}}.
  30. handle_call(count, #state{buffer=Buffer} = State) ->
  31. {ok, length(Buffer), State};
  32. handle_call(count_ignored, #state{ignored=Ignored} = State) ->
  33. {ok, length(Ignored), State};
  34. handle_call(flush, State) ->
  35. {ok, ok, State#state{buffer=[], ignored=[]}};
  36. handle_call(pop, #state{buffer=Buffer} = State) ->
  37. case Buffer of
  38. [] ->
  39. {ok, undefined, State};
  40. [H|T] ->
  41. {ok, H, State#state{buffer=T}}
  42. end;
  43. handle_call(get_loglevel, #state{level=Level} = State) ->
  44. {ok, Level, State};
  45. handle_call({set_loglevel, Level}, State) ->
  46. {ok, ok, State#state{level=lager_util:config_to_mask(Level)}};
  47. handle_call(print_state, State) ->
  48. spawn(fun() -> lager:info("State ~p", [lager:pr(State, ?MODULE)]) end),
  49. timer:sleep(100),
  50. {ok, ok, State};
  51. handle_call(print_bad_state, State) ->
  52. spawn(fun() -> lager:info("State ~p", [lager:pr({state, 1}, ?MODULE)]) end),
  53. timer:sleep(100),
  54. {ok, ok, State};
  55. handle_call(_Request, State) ->
  56. {ok, ok, State}.
  57. handle_event({log, Msg},
  58. #state{level=LogLevel,buffer=Buffer,ignored=Ignored} = State) ->
  59. case lager_util:is_loggable(Msg, LogLevel, ?MODULE) of
  60. true ->
  61. {ok, State#state{buffer=Buffer ++
  62. [{lager_msg:severity_as_int(Msg),
  63. lager_msg:datetime(Msg),
  64. lager_msg:message(Msg), lager_msg:metadata(Msg)}]}};
  65. _ ->
  66. {ok, State#state{ignored=Ignored ++ [ignored]}}
  67. end;
  68. handle_event(_Event, State) ->
  69. {ok, State}.
  70. handle_info(_Info, State) ->
  71. {ok, State}.
  72. terminate(_Reason, _State) ->
  73. ok.
  74. code_change(_OldVsn, State, _Extra) ->
  75. {ok, State}.
  76. -ifdef(TEST).
  77. pop() ->
  78. gen_event:call(lager_event, ?MODULE, pop).
  79. count() ->
  80. gen_event:call(lager_event, ?MODULE, count).
  81. count_ignored() ->
  82. gen_event:call(lager_event, ?MODULE, count_ignored).
  83. flush() ->
  84. gen_event:call(lager_event, ?MODULE, flush).
  85. print_state() ->
  86. gen_event:call(lager_event, ?MODULE, print_state).
  87. print_bad_state() ->
  88. gen_event:call(lager_event, ?MODULE, print_bad_state).
  89. has_line_numbers() ->
  90. %% are we R15 or greater
  91. Rel = erlang:system_info(otp_release),
  92. {match, [Major]} = re:run(Rel, "^R(\\d+)[A|B](|0(\\d))$", [{capture, [1], list}]),
  93. list_to_integer(Major) >= 15.
  94. not_running_test() ->
  95. ?assertEqual({error, lager_not_running}, lager:log(info, self(), "not running")).
  96. lager_test_() ->
  97. {foreach,
  98. fun setup/0,
  99. fun cleanup/1,
  100. [
  101. {"observe that there is nothing up my sleeve",
  102. fun() ->
  103. ?assertEqual(undefined, pop()),
  104. ?assertEqual(0, count())
  105. end
  106. },
  107. {"logging works",
  108. fun() ->
  109. lager:warning("test message"),
  110. ?assertEqual(1, count()),
  111. {Level, _Time, Message, _Metadata} = pop(),
  112. ?assertMatch(Level, lager_util:level_to_num(warning)),
  113. ?assertEqual("test message", Message),
  114. ok
  115. end
  116. },
  117. {"logging with arguments works",
  118. fun() ->
  119. lager:warning("test message ~p", [self()]),
  120. ?assertEqual(1, count()),
  121. {Level, _Time, Message,_Metadata} = pop(),
  122. ?assertMatch(Level, lager_util:level_to_num(warning)),
  123. ?assertEqual(lists:flatten(io_lib:format("test message ~p", [self()])), lists:flatten(Message)),
  124. ok
  125. end
  126. },
  127. {"logging works from inside a begin/end block",
  128. fun() ->
  129. ?assertEqual(0, count()),
  130. begin
  131. lager:warning("test message 2")
  132. end,
  133. ?assertEqual(1, count()),
  134. ok
  135. end
  136. },
  137. {"logging works from inside a list comprehension",
  138. fun() ->
  139. ?assertEqual(0, count()),
  140. [lager:warning("test message") || _N <- lists:seq(1, 10)],
  141. ?assertEqual(10, count()),
  142. ok
  143. end
  144. },
  145. {"logging works from a begin/end block inside a list comprehension",
  146. fun() ->
  147. ?assertEqual(0, count()),
  148. [ begin lager:warning("test message") end || _N <- lists:seq(1, 10)],
  149. ?assertEqual(10, count()),
  150. ok
  151. end
  152. },
  153. {"logging works from a nested list comprehension",
  154. fun() ->
  155. ?assertEqual(0, count()),
  156. [ [lager:warning("test message") || _N <- lists:seq(1, 10)] ||
  157. _I <- lists:seq(1, 10)],
  158. ?assertEqual(100, count()),
  159. ok
  160. end
  161. },
  162. {"variables inplace of literals in logging statements work",
  163. fun() ->
  164. ?assertEqual(0, count()),
  165. Attr = [{a, alpha}, {b, beta}],
  166. Fmt = "format ~p",
  167. Args = [world],
  168. lager:info(Attr, "hello"),
  169. lager:info(Attr, "hello ~p", [world]),
  170. lager:info(Fmt, [world]),
  171. lager:info("hello ~p", Args),
  172. lager:info(Attr, "hello ~p", Args),
  173. lager:info([{d, delta}, {g, gamma}], Fmt, Args),
  174. ?assertEqual(6, count()),
  175. {_Level, _Time, Message, Metadata} = pop(),
  176. ?assertMatch([{a, alpha}, {b, beta}|_], Metadata),
  177. ?assertEqual("hello", lists:flatten(Message)),
  178. {_Level, _Time2, Message2, _Metadata2} = pop(),
  179. ?assertEqual("hello world", lists:flatten(Message2)),
  180. {_Level, _Time3, Message3, _Metadata3} = pop(),
  181. ?assertEqual("format world", lists:flatten(Message3)),
  182. {_Level, _Time4, Message4, _Metadata4} = pop(),
  183. ?assertEqual("hello world", lists:flatten(Message4)),
  184. {_Level, _Time5, Message5, _Metadata5} = pop(),
  185. ?assertEqual("hello world", lists:flatten(Message5)),
  186. {_Level, _Time6, Message6, Metadata6} = pop(),
  187. ?assertMatch([{d, delta}, {g, gamma}|_], Metadata6),
  188. ?assertEqual("format world", lists:flatten(Message6)),
  189. ok
  190. end
  191. },
  192. {"list comprehension inplace of literals in logging statements work",
  193. fun() ->
  194. ?assertEqual(0, count()),
  195. Attr = [{a, alpha}, {b, beta}],
  196. Fmt = "format ~p",
  197. Args = [world],
  198. lager:info([{K, atom_to_list(V)} || {K, V} <- Attr], "hello"),
  199. lager:info([{K, atom_to_list(V)} || {K, V} <- Attr], "hello ~p", [{atom, X} || X <- Args]),
  200. lager:info([X || X <- Fmt], [world]),
  201. lager:info("hello ~p", [{atom, X} || X <- Args]),
  202. lager:info([{K, atom_to_list(V)} || {K, V} <- Attr], "hello ~p", [{atom, X} || X <- Args]),
  203. lager:info([{d, delta}, {g, gamma}], Fmt, [{atom, X} || X <- Args]),
  204. ?assertEqual(6, count()),
  205. {_Level, _Time, Message, Metadata} = pop(),
  206. ?assertMatch([{a, "alpha"}, {b, "beta"}|_], Metadata),
  207. ?assertEqual("hello", lists:flatten(Message)),
  208. {_Level, _Time2, Message2, _Metadata2} = pop(),
  209. ?assertEqual("hello {atom,world}", lists:flatten(Message2)),
  210. {_Level, _Time3, Message3, _Metadata3} = pop(),
  211. ?assertEqual("format world", lists:flatten(Message3)),
  212. {_Level, _Time4, Message4, _Metadata4} = pop(),
  213. ?assertEqual("hello {atom,world}", lists:flatten(Message4)),
  214. {_Level, _Time5, Message5, _Metadata5} = pop(),
  215. ?assertEqual("hello {atom,world}", lists:flatten(Message5)),
  216. {_Level, _Time6, Message6, Metadata6} = pop(),
  217. ?assertMatch([{d, delta}, {g, gamma}|_], Metadata6),
  218. ?assertEqual("format {atom,world}", lists:flatten(Message6)),
  219. ok
  220. end
  221. },
  222. {"function calls inplace of literals in logging statements work",
  223. fun() ->
  224. ?assertEqual(0, count()),
  225. put(attrs, [{a, alpha}, {b, beta}]),
  226. put(format, "format ~p"),
  227. put(args, [world]),
  228. lager:info(get(attrs), "hello"),
  229. lager:info(get(attrs), "hello ~p", get(args)),
  230. lager:info(get(format), [world]),
  231. lager:info("hello ~p", erlang:get(args)),
  232. lager:info(fun() -> get(attrs) end(), "hello ~p", get(args)),
  233. lager:info([{d, delta}, {g, gamma}], get(format), get(args)),
  234. ?assertEqual(6, count()),
  235. {_Level, _Time, Message, Metadata} = pop(),
  236. ?assertMatch([{a, alpha}, {b, beta}|_], Metadata),
  237. ?assertEqual("hello", lists:flatten(Message)),
  238. {_Level, _Time2, Message2, _Metadata2} = pop(),
  239. ?assertEqual("hello world", lists:flatten(Message2)),
  240. {_Level, _Time3, Message3, _Metadata3} = pop(),
  241. ?assertEqual("format world", lists:flatten(Message3)),
  242. {_Level, _Time4, Message4, _Metadata4} = pop(),
  243. ?assertEqual("hello world", lists:flatten(Message4)),
  244. {_Level, _Time5, Message5, _Metadata5} = pop(),
  245. ?assertEqual("hello world", lists:flatten(Message5)),
  246. {_Level, _Time6, Message6, Metadata6} = pop(),
  247. ?assertMatch([{d, delta}, {g, gamma}|_], Metadata6),
  248. ?assertEqual("format world", lists:flatten(Message6)),
  249. ok
  250. end
  251. },
  252. {"record fields inplace of literals in logging statements work",
  253. fun() ->
  254. ?assertEqual(0, count()),
  255. Test = #test{attrs=[{a, alpha}, {b, beta}], format="format ~p", args=[world]},
  256. lager:info(Test#test.attrs, "hello"),
  257. lager:info(Test#test.attrs, "hello ~p", Test#test.args),
  258. lager:info(Test#test.format, [world]),
  259. lager:info("hello ~p", Test#test.args),
  260. lager:info(Test#test.attrs, "hello ~p", Test#test.args),
  261. lager:info([{d, delta}, {g, gamma}], Test#test.format, Test#test.args),
  262. ?assertEqual(6, count()),
  263. {_Level, _Time, Message, Metadata} = pop(),
  264. ?assertMatch([{a, alpha}, {b, beta}|_], Metadata),
  265. ?assertEqual("hello", lists:flatten(Message)),
  266. {_Level, _Time2, Message2, _Metadata2} = pop(),
  267. ?assertEqual("hello world", lists:flatten(Message2)),
  268. {_Level, _Time3, Message3, _Metadata3} = pop(),
  269. ?assertEqual("format world", lists:flatten(Message3)),
  270. {_Level, _Time4, Message4, _Metadata4} = pop(),
  271. ?assertEqual("hello world", lists:flatten(Message4)),
  272. {_Level, _Time5, Message5, _Metadata5} = pop(),
  273. ?assertEqual("hello world", lists:flatten(Message5)),
  274. {_Level, _Time6, Message6, Metadata6} = pop(),
  275. ?assertMatch([{d, delta}, {g, gamma}|_], Metadata6),
  276. ?assertEqual("format world", lists:flatten(Message6)),
  277. ok
  278. end
  279. },
  280. {"log messages below the threshold are ignored",
  281. fun() ->
  282. ?assertEqual(0, count()),
  283. lager:debug("this message will be ignored"),
  284. ?assertEqual(0, count()),
  285. ?assertEqual(0, count_ignored()),
  286. lager_config:set(loglevel, {element(2, lager_util:config_to_mask(debug)), []}),
  287. lager:debug("this message should be ignored"),
  288. ?assertEqual(0, count()),
  289. ?assertEqual(1, count_ignored()),
  290. lager:set_loglevel(?MODULE, debug),
  291. ?assertEqual({?DEBUG bor ?INFO bor ?NOTICE bor ?WARNING bor ?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  292. lager:debug("this message should be logged"),
  293. ?assertEqual(1, count()),
  294. ?assertEqual(1, count_ignored()),
  295. ?assertEqual(debug, lager:get_loglevel(?MODULE)),
  296. ok
  297. end
  298. },
  299. {"tracing works",
  300. fun() ->
  301. lager_config:set(loglevel, {element(2, lager_util:config_to_mask(error)), []}),
  302. ok = lager:info("hello world"),
  303. ?assertEqual(0, count()),
  304. lager:trace(?MODULE, [{module, ?MODULE}], debug),
  305. ?assertMatch({?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, _}, lager_config:get(loglevel)),
  306. %% elegible for tracing
  307. ok = lager:info("hello world"),
  308. %% NOT elegible for tracing
  309. ok = lager:log(info, [{pid, self()}], "hello world"),
  310. ?assertEqual(1, count()),
  311. ok
  312. end
  313. },
  314. {"tracing works with custom attributes",
  315. fun() ->
  316. lager:set_loglevel(?MODULE, error),
  317. ?assertEqual({?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  318. lager_config:set(loglevel, {element(2, lager_util:config_to_mask(error)), []}),
  319. lager:info([{requestid, 6}], "hello world"),
  320. ?assertEqual(0, count()),
  321. lager:trace(?MODULE, [{requestid, 6}, {foo, bar}], debug),
  322. lager:info([{requestid, 6}, {foo, bar}], "hello world"),
  323. ?assertEqual(1, count()),
  324. lager:trace(?MODULE, [{requestid, '*'}], debug),
  325. lager:info([{requestid, 6}], "hello world"),
  326. ?assertEqual(2, count()),
  327. lager:clear_all_traces(),
  328. lager:info([{requestid, 6}], "hello world"),
  329. ?assertEqual(2, count()),
  330. ok
  331. end
  332. },
  333. {"tracing works with custom attributes and event stream processing",
  334. fun() ->
  335. lager:set_loglevel(?MODULE, error),
  336. ?assertEqual({?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  337. lager_config:set(loglevel, {element(2, lager_util:config_to_mask(error)), []}),
  338. lager:info([{requestid, 6}], "hello world"),
  339. ?assertEqual(0, count()),
  340. lager:trace(?MODULE, [{requestid, '>', 5}, {requestid, '<', 7}, {foo, bar}], debug),
  341. lager:info([{requestid, 5}, {foo, bar}], "hello world"),
  342. lager:info([{requestid, 6}, {foo, bar}], "hello world"),
  343. ?assertEqual(1, count()),
  344. lager:clear_all_traces(),
  345. lager:trace(?MODULE, [{requestid, '>', 8}, {foo, bar}]),
  346. lager:info([{foo, bar}], "hello world"),
  347. lager:info([{requestid, 6}], "hello world"),
  348. lager:info([{requestid, 7}], "hello world"),
  349. lager:info([{requestid, 8}], "hello world"),
  350. lager:info([{requestid, 9}, {foo, bar}], "hello world"),
  351. lager:info([{requestid, 10}], "hello world"),
  352. ?assertEqual(2, count()),
  353. lager:trace(?MODULE, [{requestid, '>', 8}]),
  354. lager:info([{foo, bar}], "hello world"),
  355. lager:info([{requestid, 6}], "hello world"),
  356. lager:info([{requestid, 7}], "hello world"),
  357. lager:info([{requestid, 8}], "hello world"),
  358. lager:info([{requestid, 9}, {foo, bar}], "hello world"),
  359. lager:info([{requestid, 10}], "hello world"),
  360. ?assertEqual(4, count()),
  361. lager:trace(?MODULE, [{foo, '=', bar}]),
  362. lager:info([{foo, bar}], "hello world"),
  363. lager:info([{requestid, 6}], "hello world"),
  364. lager:info([{requestid, 7}], "hello world"),
  365. lager:info([{requestid, 8}], "hello world"),
  366. lager:info([{requestid, 9}, {foo, bar}], "hello world"),
  367. lager:info([{requestid, 10}], "hello world"),
  368. ?assertEqual(7, count()),
  369. lager:clear_all_traces(),
  370. lager:info([{requestid, 6}], "hello world"),
  371. ?assertEqual(7, count()),
  372. ok
  373. end
  374. },
  375. {"tracing custom attributes works with event stream processing statistics and reductions",
  376. fun() ->
  377. lager:set_loglevel(?MODULE, error),
  378. ?assertEqual({?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  379. lager_config:set(loglevel, {element(2, lager_util:config_to_mask(error)), []}),
  380. lager:info([{requestid, 6}], "hello world"),
  381. ?assertEqual(0, count()),
  382. lager:trace(?MODULE, [{beta, '*'}]),
  383. lager:trace(?MODULE, [{meta, "data"}]),
  384. lager:info([{meta, "data"}], "hello world"),
  385. lager:info([{beta, 2}], "hello world"),
  386. lager:info([{beta, 2.1}, {foo, bar}], "hello world"),
  387. lager:info([{meta, <<"data">>}], "hello world"),
  388. ?assertEqual(8, ?DEFAULT_TRACER:info(input)),
  389. ?assertEqual(6, ?DEFAULT_TRACER:info(output)),
  390. ?assertEqual(2, ?DEFAULT_TRACER:info(filter)),
  391. lager:clear_all_traces(),
  392. lager:trace(?MODULE, [{meta, "data"}]),
  393. lager:trace(?MODULE, [{beta, '>', 2}, {beta, '<', 2.12}]),
  394. lager:info([{meta, "data"}], "hello world"),
  395. lager:info([{beta, 2}], "hello world"),
  396. lager:info([{beta, 2.1}, {foo, bar}], "hello world"),
  397. lager:info([{meta, <<"data">>}], "hello world"),
  398. ?assertEqual(8, ?DEFAULT_TRACER:info(input)),
  399. ?assertEqual(4, ?DEFAULT_TRACER:info(output)),
  400. ?assertEqual(4, ?DEFAULT_TRACER:info(filter)),
  401. lager:clear_all_traces(),
  402. lager:trace_console([{beta, '>', 2}, {meta, "data"}]),
  403. lager:trace_console([{beta, '>', 2}, {beta, '<', 2.12}]),
  404. Reduced = {all,[{any,[{beta,'<',2.12},{meta,'=',"data"}]},
  405. {beta,'>',2}]},
  406. ?assertEqual(Reduced, ?DEFAULT_TRACER:info('query')),
  407. lager:clear_all_traces(),
  408. lager:info([{requestid, 6}], "hello world"),
  409. ?assertEqual(5, count()),
  410. ok
  411. end
  412. },
  413. {"persistent traces work",
  414. fun() ->
  415. ?assertEqual(0, count()),
  416. lager:debug([{foo, bar}], "hello world"),
  417. ?assertEqual(0, count()),
  418. application:stop(lager),
  419. application:set_env(lager, traces, [{lager_test_backend, [{foo, bar}], debug}]),
  420. application:start(lager),
  421. lager:debug([{foo, bar}], "hello world"),
  422. ?assertEqual(1, count()),
  423. application:unset_env(lager, traces),
  424. ok
  425. end
  426. },
  427. {"tracing honors loglevel",
  428. fun() ->
  429. lager:set_loglevel(?MODULE, error),
  430. ?assertEqual({?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  431. {ok, T} = lager:trace(?MODULE, [{module, ?MODULE}], notice),
  432. ok = lager:info("hello world"),
  433. ?assertEqual(0, count()),
  434. ok = lager:notice("hello world"),
  435. ?assertEqual(1, count()),
  436. lager:stop_trace(T),
  437. ok = lager:notice("hello world"),
  438. ?assertEqual(1, count()),
  439. ok
  440. end
  441. },
  442. {"record printing works",
  443. fun() ->
  444. print_state(),
  445. {Level, _Time, Message, _Metadata} = pop(),
  446. ?assertMatch(Level, lager_util:level_to_num(info)),
  447. {mask, Mask} = lager_util:config_to_mask(info),
  448. ?assertEqual("State #state{level={mask,"++integer_to_list(Mask)++"},buffer=[],ignored=[]}", lists:flatten(Message)),
  449. ok
  450. end
  451. },
  452. {"record printing fails gracefully",
  453. fun() ->
  454. print_bad_state(),
  455. {Level, _Time, Message, _Metadata} = pop(),
  456. ?assertMatch(Level, lager_util:level_to_num(info)),
  457. ?assertEqual("State {state,1}", lists:flatten(Message)),
  458. ok
  459. end
  460. },
  461. {"record printing fails gracefully when no lager_record attribute",
  462. fun() ->
  463. spawn(fun() -> lager:info("State ~p", [lager:pr({state, 1}, lager)]) end),
  464. timer:sleep(100),
  465. {Level, _Time, Message, _Metadata} = pop(),
  466. ?assertMatch(Level, lager_util:level_to_num(info)),
  467. ?assertEqual("State {state,1}", lists:flatten(Message)),
  468. ok
  469. end
  470. },
  471. {"record printing fails gracefully when input is not a tuple",
  472. fun() ->
  473. spawn(fun() -> lager:info("State ~p", [lager:pr(ok, lager)]) end),
  474. timer:sleep(100),
  475. {Level, _Time, Message, _Metadata} = pop(),
  476. ?assertMatch(Level, lager_util:level_to_num(info)),
  477. ?assertEqual("State ok", lists:flatten(Message)),
  478. ok
  479. end
  480. },
  481. {"record printing fails gracefully when module is invalid",
  482. fun() ->
  483. spawn(fun() -> lager:info("State ~p", [lager:pr({state, 1}, not_a_module)]) end),
  484. timer:sleep(100),
  485. {Level, _Time, Message, _Metadata} = pop(),
  486. ?assertMatch(Level, lager_util:level_to_num(info)),
  487. ?assertEqual("State {state,1}", lists:flatten(Message)),
  488. ok
  489. end
  490. },
  491. {"installing a new handler adjusts the global loglevel if necessary",
  492. fun() ->
  493. ?assertEqual({?INFO bor ?NOTICE bor ?WARNING bor ?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  494. supervisor:start_child(lager_handler_watcher_sup, [lager_event, {?MODULE, foo}, debug]),
  495. ?assertEqual({?DEBUG bor ?INFO bor ?NOTICE bor ?WARNING bor ?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  496. ok
  497. end
  498. },
  499. {"metadata in the process dictionary works",
  500. fun() ->
  501. lager:md([{platypus, gravid}, {sloth, hirsute}, {duck, erroneous}]),
  502. lager:info("I sing the animal kingdom electric!"),
  503. {_Level, _Time, _Message, Metadata} = pop(),
  504. ?assertEqual(gravid, proplists:get_value(platypus, Metadata)),
  505. ?assertEqual(hirsute, proplists:get_value(sloth, Metadata)),
  506. ?assertEqual(erroneous, proplists:get_value(duck, Metadata)),
  507. ?assertEqual(undefined, proplists:get_value(eagle, Metadata)),
  508. lager:md([{platypus, gravid}, {sloth, hirsute}, {eagle, superincumbent}]),
  509. lager:info("I sing the animal kingdom dielectric!"),
  510. {_Level2, _Time2, _Message2, Metadata2} = pop(),
  511. ?assertEqual(gravid, proplists:get_value(platypus, Metadata2)),
  512. ?assertEqual(hirsute, proplists:get_value(sloth, Metadata2)),
  513. ?assertEqual(undefined, proplists:get_value(duck, Metadata2)),
  514. ?assertEqual(superincumbent, proplists:get_value(eagle, Metadata2)),
  515. ok
  516. end
  517. },
  518. {"can't store invalid metadata",
  519. fun() ->
  520. ?assertEqual(ok, lager:md([{platypus, gravid}, {sloth, hirsute}, {duck, erroneous}])),
  521. ?assertError(badarg, lager:md({flamboyant, flamingo})),
  522. ?assertError(badarg, lager:md("zookeeper zephyr")),
  523. ok
  524. end
  525. }
  526. ]
  527. }.
  528. setup() ->
  529. error_logger:tty(false),
  530. application:load(lager),
  531. application:set_env(lager, handlers, [{?MODULE, info}]),
  532. application:set_env(lager, error_logger_redirect, false),
  533. application:start(lager),
  534. gen_event:call(lager_event, ?MODULE, flush).
  535. cleanup(_) ->
  536. application:stop(lager),
  537. error_logger:tty(true).
  538. crash(Type) ->
  539. spawn(fun() -> gen_server:call(crash, Type) end),
  540. timer:sleep(100),
  541. _ = gen_event:which_handlers(error_logger),
  542. ok.
  543. test_body(Expected, Actual) ->
  544. case has_line_numbers() of
  545. true ->
  546. FileLine = string:substr(Actual, length(Expected)+1),
  547. Body = string:substr(Actual, 1, length(Expected)),
  548. ?assertEqual(Expected, Body),
  549. case string:substr(FileLine, 1, 6) of
  550. [] ->
  551. %% sometimes there's no line information...
  552. ?assert(true);
  553. " line " ->
  554. ?assert(true);
  555. Other ->
  556. ?debugFmt("unexpected trailing data ~p", [Other]),
  557. ?assert(false)
  558. end;
  559. false ->
  560. ?assertEqual(Expected, Actual)
  561. end.
  562. error_logger_redirect_crash_test_() ->
  563. TestBody=fun(Name,CrashReason,Expected) -> {Name,
  564. fun() ->
  565. Pid = whereis(crash),
  566. crash(CrashReason),
  567. {Level, _, Msg,Metadata} = pop(),
  568. test_body(Expected, lists:flatten(Msg)),
  569. ?assertEqual(Pid,proplists:get_value(pid,Metadata)),
  570. ?assertEqual(lager_util:level_to_num(error),Level)
  571. end
  572. }
  573. end,
  574. {foreach,
  575. fun() ->
  576. error_logger:tty(false),
  577. application:load(lager),
  578. application:set_env(lager, error_logger_redirect, true),
  579. application:set_env(lager, handlers, [{?MODULE, error}]),
  580. application:start(lager),
  581. crash:start()
  582. end,
  583. fun(_) ->
  584. application:stop(lager),
  585. case whereis(crash) of
  586. undefined -> ok;
  587. Pid -> exit(Pid, kill)
  588. end,
  589. error_logger:tty(true)
  590. end,
  591. [
  592. {"again, there is nothing up my sleeve",
  593. fun() ->
  594. ?assertEqual(undefined, pop()),
  595. ?assertEqual(0, count())
  596. end
  597. },
  598. TestBody("bad return value",bad_return,"gen_server crash terminated with reason: bad return value: bleh"),
  599. TestBody("bad return value with string",bad_return_string,"gen_server crash terminated with reason: bad return value: {tuple,{tuple,\"string\"}}"),
  600. TestBody("bad return uncaught throw",throw,"gen_server crash terminated with reason: bad return value: a_ball"),
  601. TestBody("case clause",case_clause,"gen_server crash terminated with reason: no case clause matching {} in crash:handle_call/3"),
  602. TestBody("case clause string",case_clause_string,"gen_server crash terminated with reason: no case clause matching \"crash\" in crash:handle_call/3"),
  603. TestBody("function clause",function_clause,"gen_server crash terminated with reason: no function clause matching crash:function({})"),
  604. TestBody("if clause",if_clause,"gen_server crash terminated with reason: no true branch found while evaluating if expression in crash:handle_call/3"),
  605. TestBody("try clause",try_clause,"gen_server crash terminated with reason: no try clause matching [] in crash:handle_call/3"),
  606. TestBody("undefined function",undef,"gen_server crash terminated with reason: call to undefined function crash:booger/0 from crash:handle_call/3"),
  607. TestBody("bad math",badarith,"gen_server crash terminated with reason: bad arithmetic expression in crash:handle_call/3"),
  608. TestBody("bad match",badmatch,"gen_server crash terminated with reason: no match of right hand value {} in crash:handle_call/3"),
  609. TestBody("bad arity",badarity,"gen_server crash terminated with reason: fun called with wrong arity of 1 instead of 3 in crash:handle_call/3"),
  610. TestBody("bad arg1",badarg1,"gen_server crash terminated with reason: bad argument in crash:handle_call/3"),
  611. TestBody("bad arg2",badarg2,"gen_server crash terminated with reason: bad argument in call to erlang:iolist_to_binary([\"foo\",bar]) in crash:handle_call/3"),
  612. TestBody("bad record",badrecord,"gen_server crash terminated with reason: bad record state in crash:handle_call/3"),
  613. TestBody("noproc",noproc,"gen_server crash terminated with reason: no such process or port in call to gen_event:call(foo, bar, baz)"),
  614. TestBody("badfun",badfun,"gen_server crash terminated with reason: bad function booger in crash:handle_call/3")
  615. ]
  616. }.
  617. error_logger_redirect_test_() ->
  618. {foreach,
  619. fun() ->
  620. error_logger:tty(false),
  621. application:load(lager),
  622. application:set_env(lager, error_logger_redirect, true),
  623. application:set_env(lager, handlers, [{?MODULE, info}]),
  624. application:start(lager),
  625. lager:log(error, self(), "flush flush"),
  626. timer:sleep(100),
  627. gen_event:call(lager_event, ?MODULE, flush)
  628. end,
  629. fun(_) ->
  630. application:stop(lager),
  631. error_logger:tty(true)
  632. end,
  633. [
  634. {"error reports are printed",
  635. fun() ->
  636. sync_error_logger:error_report([{this, is}, a, {silly, format}]),
  637. _ = gen_event:which_handlers(error_logger),
  638. {Level, _, Msg,Metadata} = pop(),
  639. ?assertEqual(lager_util:level_to_num(error),Level),
  640. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  641. Expected = "this: is, a, silly: format",
  642. ?assertEqual(Expected, lists:flatten(Msg))
  643. end
  644. },
  645. {"string error reports are printed",
  646. fun() ->
  647. sync_error_logger:error_report("this is less silly"),
  648. _ = gen_event:which_handlers(error_logger),
  649. {Level, _, Msg,Metadata} = pop(),
  650. ?assertEqual(lager_util:level_to_num(error),Level),
  651. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  652. Expected = "this is less silly",
  653. ?assertEqual(Expected, lists:flatten(Msg))
  654. end
  655. },
  656. {"error messages are printed",
  657. fun() ->
  658. sync_error_logger:error_msg("doom, doom has come upon you all"),
  659. _ = gen_event:which_handlers(error_logger),
  660. {Level, _, Msg,Metadata} = pop(),
  661. ?assertEqual(lager_util:level_to_num(error),Level),
  662. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  663. Expected = "doom, doom has come upon you all",
  664. ?assertEqual(Expected, lists:flatten(Msg))
  665. end
  666. },
  667. {"error messages are truncated at 4096 characters",
  668. fun() ->
  669. sync_error_logger:error_msg("doom, doom has come upon you all ~p", [string:copies("doom", 10000)]),
  670. _ = gen_event:which_handlers(error_logger),
  671. {_, _, Msg,_Metadata} = pop(),
  672. ?assert(length(lists:flatten(Msg)) < 5100)
  673. end
  674. },
  675. {"info reports are printed",
  676. fun() ->
  677. sync_error_logger:info_report([{this, is}, a, {silly, format}]),
  678. _ = gen_event:which_handlers(error_logger),
  679. {Level, _, Msg,Metadata} = pop(),
  680. ?assertEqual(lager_util:level_to_num(info),Level),
  681. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  682. Expected = "this: is, a, silly: format",
  683. ?assertEqual(Expected, lists:flatten(Msg))
  684. end
  685. },
  686. {"info reports are truncated at 4096 characters",
  687. fun() ->
  688. sync_error_logger:info_report([[{this, is}, a, {silly, format}] || _ <- lists:seq(0, 600)]),
  689. _ = gen_event:which_handlers(error_logger),
  690. {Level, _, Msg,Metadata} = pop(),
  691. ?assertEqual(lager_util:level_to_num(info),Level),
  692. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  693. ?assert(length(lists:flatten(Msg)) < 5000)
  694. end
  695. },
  696. {"single term info reports are printed",
  697. fun() ->
  698. sync_error_logger:info_report({foolish, bees}),
  699. _ = gen_event:which_handlers(error_logger),
  700. {Level, _, Msg,Metadata} = pop(),
  701. ?assertEqual(lager_util:level_to_num(info),Level),
  702. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  703. ?assertEqual("{foolish,bees}", lists:flatten(Msg))
  704. end
  705. },
  706. {"single term error reports are printed",
  707. fun() ->
  708. sync_error_logger:error_report({foolish, bees}),
  709. _ = gen_event:which_handlers(error_logger),
  710. {Level, _, Msg,Metadata} = pop(),
  711. ?assertEqual(lager_util:level_to_num(error),Level),
  712. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  713. ?assertEqual("{foolish,bees}", lists:flatten(Msg))
  714. end
  715. },
  716. {"string info reports are printed",
  717. fun() ->
  718. sync_error_logger:info_report("this is less silly"),
  719. _ = gen_event:which_handlers(error_logger),
  720. {Level, _, Msg,Metadata} = pop(),
  721. ?assertEqual(lager_util:level_to_num(info),Level),
  722. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  723. ?assertEqual("this is less silly", lists:flatten(Msg))
  724. end
  725. },
  726. {"string info reports are truncated at 4096 characters",
  727. fun() ->
  728. sync_error_logger:info_report(string:copies("this is less silly", 1000)),
  729. _ = gen_event:which_handlers(error_logger),
  730. {Level, _, Msg,Metadata} = pop(),
  731. ?assertEqual(lager_util:level_to_num(info),Level),
  732. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  733. ?assert(length(lists:flatten(Msg)) < 5100)
  734. end
  735. },
  736. {"strings in a mixed report are printed as strings",
  737. fun() ->
  738. sync_error_logger:info_report(["this is less silly", {than, "this"}]),
  739. _ = gen_event:which_handlers(error_logger),
  740. {Level, _, Msg,Metadata} = pop(),
  741. ?assertEqual(lager_util:level_to_num(info),Level),
  742. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  743. ?assertEqual("\"this is less silly\", than: \"this\"", lists:flatten(Msg))
  744. end
  745. },
  746. {"info messages are printed",
  747. fun() ->
  748. sync_error_logger:info_msg("doom, doom has come upon you all"),
  749. _ = gen_event:which_handlers(error_logger),
  750. {Level, _, Msg,Metadata} = pop(),
  751. ?assertEqual(lager_util:level_to_num(info),Level),
  752. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  753. ?assertEqual("doom, doom has come upon you all", lists:flatten(Msg))
  754. end
  755. },
  756. {"info messages are truncated at 4096 characters",
  757. fun() ->
  758. sync_error_logger:info_msg("doom, doom has come upon you all ~p", [string:copies("doom", 10000)]),
  759. _ = gen_event:which_handlers(error_logger),
  760. {Level, _, Msg,Metadata} = pop(),
  761. ?assertEqual(lager_util:level_to_num(info),Level),
  762. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  763. ?assert(length(lists:flatten(Msg)) < 5100)
  764. end
  765. },
  766. {"warning messages are printed at the correct level",
  767. fun() ->
  768. sync_error_logger:warning_msg("doom, doom has come upon you all"),
  769. Map = error_logger:warning_map(),
  770. _ = gen_event:which_handlers(error_logger),
  771. {Level, _, Msg,Metadata} = pop(),
  772. ?assertEqual(lager_util:level_to_num(Map),Level),
  773. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  774. ?assertEqual("doom, doom has come upon you all", lists:flatten(Msg))
  775. end
  776. },
  777. {"warning reports are printed at the correct level",
  778. fun() ->
  779. sync_error_logger:warning_report([{i, like}, pie]),
  780. Map = error_logger:warning_map(),
  781. _ = gen_event:which_handlers(error_logger),
  782. {Level, _, Msg,Metadata} = pop(),
  783. ?assertEqual(lager_util:level_to_num(Map),Level),
  784. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  785. ?assertEqual("i: like, pie", lists:flatten(Msg))
  786. end
  787. },
  788. {"single term warning reports are printed at the correct level",
  789. fun() ->
  790. sync_error_logger:warning_report({foolish, bees}),
  791. Map = error_logger:warning_map(),
  792. _ = gen_event:which_handlers(error_logger),
  793. {Level, _, Msg,Metadata} = pop(),
  794. ?assertEqual(lager_util:level_to_num(Map),Level),
  795. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  796. ?assertEqual("{foolish,bees}", lists:flatten(Msg))
  797. end
  798. },
  799. {"application stop reports",
  800. fun() ->
  801. sync_error_logger:info_report([{application, foo}, {exited, quittin_time}, {type, lazy}]),
  802. _ = gen_event:which_handlers(error_logger),
  803. {Level, _, Msg,Metadata} = pop(),
  804. ?assertEqual(lager_util:level_to_num(info),Level),
  805. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  806. ?assertEqual("Application foo exited with reason: quittin_time", lists:flatten(Msg))
  807. end
  808. },
  809. {"supervisor reports",
  810. fun() ->
  811. sync_error_logger:error_report(supervisor_report, [{errorContext, france}, {offender, [{name, mini_steve}, {mfargs, {a, b, [c]}}, {pid, bleh}]}, {reason, fired}, {supervisor, {local, steve}}]),
  812. _ = gen_event:which_handlers(error_logger),
  813. {Level, _, Msg,Metadata} = pop(),
  814. ?assertEqual(lager_util:level_to_num(error),Level),
  815. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  816. ?assertEqual("Supervisor steve had child mini_steve started with a:b(c) at bleh exit with reason fired in context france", lists:flatten(Msg))
  817. end
  818. },
  819. {"supervisor reports with real error",
  820. fun() ->
  821. sync_error_logger:error_report(supervisor_report, [{errorContext, france}, {offender, [{name, mini_steve}, {mfargs, {a, b, [c]}}, {pid, bleh}]}, {reason, {function_clause,[{crash,handle_info,[foo]}]}}, {supervisor, {local, steve}}]),
  822. _ = gen_event:which_handlers(error_logger),
  823. {Level, _, Msg,Metadata} = pop(),
  824. ?assertEqual(lager_util:level_to_num(error),Level),
  825. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  826. ?assertEqual("Supervisor steve had child mini_steve started with a:b(c) at bleh exit with reason no function clause matching crash:handle_info(foo) in context france", lists:flatten(Msg))
  827. end
  828. },
  829. {"supervisor reports with real error and pid",
  830. fun() ->
  831. sync_error_logger:error_report(supervisor_report, [{errorContext, france}, {offender, [{name, mini_steve}, {mfargs, {a, b, [c]}}, {pid, bleh}]}, {reason, {function_clause,[{crash,handle_info,[foo]}]}}, {supervisor, somepid}]),
  832. _ = gen_event:which_handlers(error_logger),
  833. {Level, _, Msg,Metadata} = pop(),
  834. ?assertEqual(lager_util:level_to_num(error),Level),
  835. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  836. ?assertEqual("Supervisor somepid had child mini_steve started with a:b(c) at bleh exit with reason no function clause matching crash:handle_info(foo) in context france", lists:flatten(Msg))
  837. end
  838. },
  839. {"supervisor_bridge reports",
  840. fun() ->
  841. sync_error_logger:error_report(supervisor_report, [{errorContext, france}, {offender, [{mod, mini_steve}, {pid, bleh}]}, {reason, fired}, {supervisor, {local, steve}}]),
  842. _ = gen_event:which_handlers(error_logger),
  843. {Level, _, Msg,Metadata} = pop(),
  844. ?assertEqual(lager_util:level_to_num(error),Level),
  845. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  846. ?assertEqual("Supervisor steve had child at module mini_steve at bleh exit with reason fired in context france", lists:flatten(Msg))
  847. end
  848. },
  849. {"application progress report",
  850. fun() ->
  851. sync_error_logger:info_report(progress, [{application, foo}, {started_at, node()}]),
  852. _ = gen_event:which_handlers(error_logger),
  853. {Level, _, Msg,Metadata} = pop(),
  854. ?assertEqual(lager_util:level_to_num(info),Level),
  855. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  856. Expected = lists:flatten(io_lib:format("Application foo started on node ~w", [node()])),
  857. ?assertEqual(Expected, lists:flatten(Msg))
  858. end
  859. },
  860. {"supervisor progress report",
  861. fun() ->
  862. lager:set_loglevel(?MODULE, debug),
  863. ?assertEqual({?DEBUG bor ?INFO bor ?NOTICE bor ?WARNING bor ?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  864. sync_error_logger:info_report(progress, [{supervisor, {local, foo}}, {started, [{mfargs, {foo, bar, 1}}, {pid, baz}]}]),
  865. _ = gen_event:which_handlers(error_logger),
  866. {Level, _, Msg,Metadata} = pop(),
  867. ?assertEqual(lager_util:level_to_num(debug),Level),
  868. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  869. ?assertEqual("Supervisor foo started foo:bar/1 at pid baz", lists:flatten(Msg))
  870. end
  871. },
  872. {"supervisor progress report with pid",
  873. fun() ->
  874. lager:set_loglevel(?MODULE, debug),
  875. ?assertEqual({?DEBUG bor ?INFO bor ?NOTICE bor ?WARNING bor ?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  876. sync_error_logger:info_report(progress, [{supervisor, somepid}, {started, [{mfargs, {foo, bar, 1}}, {pid, baz}]}]),
  877. _ = gen_event:which_handlers(error_logger),
  878. {Level, _, Msg,Metadata} = pop(),
  879. ?assertEqual(lager_util:level_to_num(debug),Level),
  880. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  881. ?assertEqual("Supervisor somepid started foo:bar/1 at pid baz", lists:flatten(Msg))
  882. end
  883. },
  884. {"crash report for emfile",
  885. fun() ->
  886. sync_error_logger:error_report(crash_report, [[{pid, self()}, {registered_name, []}, {error_info, {error, emfile, [{stack, trace, 1}]}}], []]),
  887. _ = gen_event:which_handlers(error_logger),
  888. {Level, _, Msg,Metadata} = pop(),
  889. ?assertEqual(lager_util:level_to_num(error),Level),
  890. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  891. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~w with 0 neighbours crashed with reason: maximum number of file descriptors exhausted, check ulimit -n", [self()])),
  892. ?assertEqual(Expected, lists:flatten(Msg))
  893. end
  894. },
  895. {"crash report for system process limit",
  896. fun() ->
  897. sync_error_logger:error_report(crash_report, [[{pid, self()}, {registered_name, []}, {error_info, {error, system_limit, [{erlang, spawn, 1}]}}], []]),
  898. _ = gen_event:which_handlers(error_logger),
  899. {Level, _, Msg,Metadata} = pop(),
  900. ?assertEqual(lager_util:level_to_num(error),Level),
  901. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  902. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~w with 0 neighbours crashed with reason: system limit: maximum number of processes exceeded", [self()])),
  903. ?assertEqual(Expected, lists:flatten(Msg))
  904. end
  905. },
  906. {"crash report for system process limit2",
  907. fun() ->
  908. sync_error_logger:error_report(crash_report, [[{pid, self()}, {registered_name, []}, {error_info, {error, system_limit, [{erlang, spawn_opt, 1}]}}], []]),
  909. _ = gen_event:which_handlers(error_logger),
  910. {Level, _, Msg,Metadata} = pop(),
  911. ?assertEqual(lager_util:level_to_num(error),Level),
  912. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  913. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~w with 0 neighbours crashed with reason: system limit: maximum number of processes exceeded", [self()])),
  914. ?assertEqual(Expected, lists:flatten(Msg))
  915. end
  916. },
  917. {"crash report for system port limit",
  918. fun() ->
  919. sync_error_logger:error_report(crash_report, [[{pid, self()}, {registered_name, []}, {error_info, {error, system_limit, [{erlang, open_port, 1}]}}], []]),
  920. _ = gen_event:which_handlers(error_logger),
  921. {Level, _, Msg,Metadata} = pop(),
  922. ?assertEqual(lager_util:level_to_num(error),Level),
  923. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  924. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~w with 0 neighbours crashed with reason: system limit: maximum number of ports exceeded", [self()])),
  925. ?assertEqual(Expected, lists:flatten(Msg))
  926. end
  927. },
  928. {"crash report for system port limit",
  929. fun() ->
  930. sync_error_logger:error_report(crash_report, [[{pid, self()}, {registered_name, []}, {error_info, {error, system_limit, [{erlang, list_to_atom, 1}]}}], []]),
  931. _ = gen_event:which_handlers(error_logger),
  932. {Level, _, Msg,Metadata} = pop(),
  933. ?assertEqual(lager_util:level_to_num(error),Level),
  934. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  935. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~w with 0 neighbours crashed with reason: system limit: tried to create an atom larger than 255, or maximum atom count exceeded", [self()])),
  936. ?assertEqual(Expected, lists:flatten(Msg))
  937. end
  938. },
  939. {"crash report for system ets table limit",
  940. fun() ->
  941. sync_error_logger:error_report(crash_report, [[{pid, self()}, {registered_name, test}, {error_info, {error, system_limit, [{ets,new,[segment_offsets,[ordered_set,public]]},{mi_segment,open_write,1},{mi_buffer_converter,handle_cast,2},{gen_server,handle_msg,5},{proc_lib,init_p_do_apply,3}]}}], []]),
  942. _ = gen_event:which_handlers(error_logger),
  943. {Level, _, Msg,Metadata} = pop(),
  944. ?assertEqual(lager_util:level_to_num(error),Level),
  945. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  946. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~w with 0 neighbours crashed with reason: system limit: maximum number of ETS tables exceeded", [test])),
  947. ?assertEqual(Expected, lists:flatten(Msg))
  948. end
  949. },
  950. {"crash report for unknown system limit should be truncated at 500 characters",
  951. fun() ->
  952. sync_error_logger:error_report(crash_report, [[{pid, self()}, {error_info, {error, system_limit, [{wtf,boom,[string:copies("aaaa", 4096)]}]}}], []]),
  953. _ = gen_event:which_handlers(error_logger),
  954. {_, _, Msg,_Metadata} = pop(),
  955. ?assert(length(lists:flatten(Msg)) > 550),
  956. ?assert(length(lists:flatten(Msg)) < 600)
  957. end
  958. },
  959. {"crash reports for 'special processes' should be handled right - function_clause",
  960. fun() ->
  961. {ok, Pid} = special_process:start(),
  962. unlink(Pid),
  963. Pid ! function_clause,
  964. timer:sleep(500),
  965. _ = gen_event:which_handlers(error_logger),
  966. {_, _, Msg, _Metadata} = pop(),
  967. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~p with 0 neighbours crashed with reason: no function clause matching special_process:foo(bar)",
  968. [Pid])),
  969. test_body(Expected, lists:flatten(Msg))
  970. end
  971. },
  972. {"crash reports for 'special processes' should be handled right - case_clause",
  973. fun() ->
  974. {ok, Pid} = special_process:start(),
  975. unlink(Pid),
  976. Pid ! {case_clause, wtf},
  977. timer:sleep(500),
  978. _ = gen_event:which_handlers(error_logger),
  979. {_, _, Msg, _Metadata} = pop(),
  980. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~p with 0 neighbours crashed with reason: no case clause matching wtf in special_process:loop/0",
  981. [Pid])),
  982. test_body(Expected, lists:flatten(Msg))
  983. end
  984. },
  985. {"crash reports for 'special processes' should be handled right - exit",
  986. fun() ->
  987. {ok, Pid} = special_process:start(),
  988. unlink(Pid),
  989. Pid ! exit,
  990. timer:sleep(500),
  991. _ = gen_event:which_handlers(error_logger),
  992. {_, _, Msg, _Metadata} = pop(),
  993. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~p with 0 neighbours exited with reason: byebye in special_process:loop/0",
  994. [Pid])),
  995. test_body(Expected, lists:flatten(Msg))
  996. end
  997. },
  998. {"crash reports for 'special processes' should be handled right - error",
  999. fun() ->
  1000. {ok, Pid} = special_process:start(),
  1001. unlink(Pid),
  1002. Pid ! error,
  1003. timer:sleep(500),
  1004. _ = gen_event:which_handlers(error_logger),
  1005. {_, _, Msg, _Metadata} = pop(),
  1006. Expected = lists:flatten(io_lib:format("CRASH REPORT Process ~p with 0 neighbours crashed with reason: mybad in special_process:loop/0",
  1007. [Pid])),
  1008. test_body(Expected, lists:flatten(Msg))
  1009. end
  1010. },
  1011. {"webmachine error reports",
  1012. fun() ->
  1013. Path = "/cgi-bin/phpmyadmin",
  1014. Reason = {error,{error,{badmatch,{error,timeout}},
  1015. [{myapp,dostuff,2,[{file,"src/myapp.erl"},{line,123}]},
  1016. {webmachine_resource,resource_call,3,[{file,"src/webmachine_resource.erl"},{line,169}]}]}},
  1017. sync_error_logger:error_msg("webmachine error: path=~p~n~p~n", [Path, Reason]),
  1018. _ = gen_event:which_handlers(error_logger),
  1019. {Level, _, Msg,Metadata} = pop(),
  1020. ?assertEqual(lager_util:level_to_num(error),Level),
  1021. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  1022. ?assertEqual("Webmachine error at path \"/cgi-bin/phpmyadmin\" : no match of right hand value {error,timeout} in myapp:dostuff/2 line 123", lists:flatten(Msg))
  1023. end
  1024. },
  1025. {"Cowboy error reports, 8 arg version",
  1026. fun() ->
  1027. Stack = [{my_handler,init, 3,[{file,"src/my_handler.erl"},{line,123}]},
  1028. {cowboy_handler,handler_init,4,[{file,"src/cowboy_handler.erl"},{line,169}]}],
  1029. sync_error_logger:error_msg(
  1030. "** Cowboy handler ~p terminating in ~p/~p~n"
  1031. " for the reason ~p:~p~n"
  1032. "** Options were ~p~n"
  1033. "** Request was ~p~n"
  1034. "** Stacktrace: ~p~n~n",
  1035. [my_handler, init, 3, error, {badmatch, {error, timeout}}, [],
  1036. "Request", Stack]),
  1037. _ = gen_event:which_handlers(error_logger),
  1038. {Level, _, Msg,Metadata} = pop(),
  1039. ?assertEqual(lager_util:level_to_num(error),Level),
  1040. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  1041. ?assertEqual("Cowboy handler my_handler terminated in my_handler:init/3 with reason: no match of right hand value {error,timeout} in my_handler:init/3 line 123", lists:flatten(Msg))
  1042. end
  1043. },
  1044. {"Cowboy error reports, 10 arg version",
  1045. fun() ->
  1046. Stack = [{my_handler,somecallback, 3,[{file,"src/my_handler.erl"},{line,123}]},
  1047. {cowboy_handler,handler_init,4,[{file,"src/cowboy_handler.erl"},{line,169}]}],
  1048. sync_error_logger:error_msg(
  1049. "** Cowboy handler ~p terminating in ~p/~p~n"
  1050. " for the reason ~p:~p~n** Message was ~p~n"
  1051. "** Options were ~p~n** Handler state was ~p~n"
  1052. "** Request was ~p~n** Stacktrace: ~p~n~n",
  1053. [my_handler, somecallback, 3, error, {badmatch, {error, timeout}}, hello, [],
  1054. {}, "Request", Stack]),
  1055. _ = gen_event:which_handlers(error_logger),
  1056. {Level, _, Msg,Metadata} = pop(),
  1057. ?assertEqual(lager_util:level_to_num(error),Level),
  1058. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  1059. ?assertEqual("Cowboy handler my_handler terminated in my_handler:somecallback/3 with reason: no match of right hand value {error,timeout} in my_handler:somecallback/3 line 123", lists:flatten(Msg))
  1060. end
  1061. },
  1062. {"Cowboy error reports, 5 arg version",
  1063. fun() ->
  1064. sync_error_logger:error_msg(
  1065. "** Cowboy handler ~p terminating; "
  1066. "function ~p/~p was not exported~n"
  1067. "** Request was ~p~n** State was ~p~n~n",
  1068. [my_handler, to_json, 2, "Request", {}]),
  1069. _ = gen_event:which_handlers(error_logger),
  1070. {Level, _, Msg,Metadata} = pop(),
  1071. ?assertEqual(lager_util:level_to_num(error),Level),
  1072. ?assertEqual(self(),proplists:get_value(pid,Metadata)),
  1073. ?assertEqual("Cowboy handler my_handler terminated with reason: call to undefined function my_handler:to_json/2", lists:flatten(Msg))
  1074. end
  1075. },
  1076. {"messages should not be generated if they don't satisfy the threshold",
  1077. fun() ->
  1078. lager:set_loglevel(?MODULE, error),
  1079. ?assertEqual({?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  1080. sync_error_logger:info_report([hello, world]),
  1081. _ = gen_event:which_handlers(error_logger),
  1082. ?assertEqual(0, count()),
  1083. ?assertEqual(0, count_ignored()),
  1084. lager:set_loglevel(?MODULE, info),
  1085. ?assertEqual({?INFO bor ?NOTICE bor ?WARNING bor ?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  1086. sync_error_logger:info_report([hello, world]),
  1087. _ = gen_event:which_handlers(error_logger),
  1088. ?assertEqual(1, count()),
  1089. ?assertEqual(0, count_ignored()),
  1090. lager:set_loglevel(?MODULE, error),
  1091. ?assertEqual({?ERROR bor ?CRITICAL bor ?ALERT bor ?EMERGENCY, []}, lager_config:get(loglevel)),
  1092. lager_config:set(loglevel, {element(2, lager_util:config_to_mask(debug)), []}),
  1093. sync_error_logger:info_report([hello, world]),
  1094. _ = gen_event:which_handlers(error_logger),
  1095. ?assertEqual(1, count()),
  1096. ?assertEqual(1, count_ignored())
  1097. end
  1098. }
  1099. ]
  1100. }.
  1101. safe_format_test() ->
  1102. ?assertEqual("foo bar", lists:flatten(lager:safe_format("~p ~p", [foo, bar], 1024))),
  1103. ?assertEqual("FORMAT ERROR: \"~p ~p ~p\" [foo,bar]", lists:flatten(lager:safe_format("~p ~p ~p", [foo, bar], 1024))),
  1104. ok.
  1105. async_threshold_test_() ->
  1106. {foreach,
  1107. fun() ->
  1108. error_logger:tty(false),
  1109. application:load(lager),
  1110. application:set_env(lager, error_logger_redirect, false),
  1111. application:set_env(lager, async_threshold, 10),
  1112. application:set_env(lager, handlers, [{?MODULE, info}]),
  1113. application:start(lager)
  1114. end,
  1115. fun(_) ->
  1116. application:unset_env(lager, async_threshold),
  1117. application:stop(lager),
  1118. error_logger:tty(true)
  1119. end,
  1120. [
  1121. {"async threshold works",
  1122. fun() ->
  1123. %% we start out async
  1124. ?assertEqual(true, lager_config:get(async)),
  1125. %% put a ton of things in the queue
  1126. Workers = [spawn_monitor(fun() -> [lager:info("hello world") || _ <- lists:seq(1, 1000)] end) || _ <- lists:seq(1, 15)],
  1127. %% serialize on mailbox
  1128. _ = gen_event:which_handlers(lager_event),
  1129. timer:sleep(500),
  1130. %% there should be a ton of outstanding messages now, so async is false
  1131. ?assertEqual(false, lager_config:get(async)),
  1132. %% wait for all the workers to return, meaning that all the messages have been logged (since we're in sync mode)
  1133. collect_workers(Workers),
  1134. %% serialize ont the mailbox again
  1135. _ = gen_event:which_handlers(lager_event),
  1136. %% just in case...
  1137. timer:sleep(100),
  1138. %% async is true again now that the mailbox has drained
  1139. ?assertEqual(true, lager_config:get(async)),
  1140. ok
  1141. end
  1142. }
  1143. ]
  1144. }.
  1145. collect_workers([]) ->
  1146. ok;
  1147. collect_workers(Workers) ->
  1148. receive
  1149. {'DOWN', Ref, _, _, _} ->
  1150. collect_workers(lists:keydelete(Ref, 2, Workers))
  1151. end.
  1152. -endif.