lager/src/lager_file_backend.erl

%% -------------------------------------------------------------------
%%
%% Copyright (c) 2011-2017 Basho Technologies, Inc.
%%
%% 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.
%%
%% -------------------------------------------------------------------

%% @doc File backend for lager, with multiple file support.
%% Multiple files are supported, each with the path and the loglevel being
%% configurable. The configuration paramter for this backend is a list of
%% key-value 2-tuples. See the init() function for the available options.
%% This backend supports external and internal log
%% rotation and will re-open handles to files if the inode changes. It will
%% also rotate the files itself if the size of the file exceeds the
%% `size' and keep `count' rotated files. `date' is
%% an alternate rotation trigger, based on time. See the README for
%% documentation.
%% For performance, the file backend does delayed writes, although it will
%% sync at specific log levels, configured via the `sync_on' option. By default
%% the error level or above will trigger a sync.

-module(lager_file_backend).

-include("lager.hrl").

-behaviour(gen_event).

-ifdef(TEST).
-include_lib("eunit/include/eunit.hrl").
-include_lib("kernel/include/file.hrl").
-compile([{parse_transform, lager_transform}]).
-endif.

-export([init/1, handle_call/2, handle_event/2, handle_info/2, terminate/2,
        code_change/3]).

-export([config_to_id/1]).

-define(DEFAULT_LOG_LEVEL, info).
-define(DEFAULT_ROTATION_SIZE, 10485760). %% 10mb
-define(DEFAULT_ROTATION_DATE, "$D0"). %% midnight
-define(DEFAULT_ROTATION_COUNT, 5).
-define(DEFAULT_SYNC_LEVEL, error).
-define(DEFAULT_SYNC_INTERVAL, 1000).
-define(DEFAULT_SYNC_SIZE, 1024*64). %% 64kb
-define(DEFAULT_CHECK_INTERVAL, 1000).

-record(state, {
        name :: string(),
        level :: {'mask', integer()},
        fd :: file:io_device() | undefined,
        inode :: integer() | undefined,
        flap=false :: boolean(),
        size = 0 :: integer(),
        date :: undefined | string(),
        count = 10 :: integer(),
        shaper :: lager_shaper(),
        formatter :: atom(),
        formatter_config :: any(),
        sync_on :: {'mask', integer()},
        check_interval = ?DEFAULT_CHECK_INTERVAL :: non_neg_integer(),
        sync_interval = ?DEFAULT_SYNC_INTERVAL :: non_neg_integer(),
        sync_size = ?DEFAULT_SYNC_SIZE :: non_neg_integer(),
        last_check = os:timestamp() :: erlang:timestamp()
    }).

-type option() :: {file, string()} | {level, lager:log_level()} |
                  {size, non_neg_integer()} | {date, string()} |
                  {count, non_neg_integer()} | {high_water_mark, non_neg_integer()} |
                  {sync_interval, non_neg_integer()} |
                  {sync_size, non_neg_integer()} | {sync_on, lager:log_level()} |
                  {check_interval, non_neg_integer()} | {formatter, atom()} |
                  {formatter_config, term()}.

-spec init([option(),...]) -> {ok, #state{}} | {error, {fatal,bad_config}}.
init({FileName, LogLevel}) when is_list(FileName), is_atom(LogLevel) ->
    %% backwards compatibility hack
    init([{file, FileName}, {level, LogLevel}]);
init({FileName, LogLevel, Size, Date, Count}) when is_list(FileName), is_atom(LogLevel) ->
    %% backwards compatibility hack
    init([{file, FileName}, {level, LogLevel}, {size, Size}, {date, Date}, {count, Count}]);
init([{FileName, LogLevel, Size, Date, Count}, {Formatter,FormatterConfig}]) when is_list(FileName), is_atom(LogLevel), is_atom(Formatter) ->
    %% backwards compatibility hack
    init([{file, FileName}, {level, LogLevel}, {size, Size}, {date, Date}, {count, Count}, {formatter, Formatter}, {formatter_config, FormatterConfig}]);
init([LogFile,{Formatter}]) ->
    %% backwards compatibility hack
    init([LogFile,{Formatter,[]}]);
init([{FileName, LogLevel}, {Formatter,FormatterConfig}]) when is_list(FileName), is_atom(LogLevel), is_atom(Formatter) ->
    %% backwards compatibility hack
    init([{file, FileName}, {level, LogLevel}, {formatter, Formatter}, {formatter_config, FormatterConfig}]);
init(LogFileConfig) when is_list(LogFileConfig) ->
    case validate_logfile_proplist(LogFileConfig) of
        false ->
            %% falied to validate config
            {error, {fatal, bad_config}};
        Config ->
            %% probabably a better way to do this, but whatever
            [RelName, Level, Date, Size, Count, HighWaterMark, Flush, SyncInterval, SyncSize, SyncOn, CheckInterval, Formatter, FormatterConfig] =
              [proplists:get_value(Key, Config) || Key <- [file, level, date, size, count, high_water_mark, flush_queue, sync_interval, sync_size, sync_on, check_interval, formatter, formatter_config]],
            FlushThr = proplists:get_value(flush_threshold, Config, 0),
            Name = lager_util:expand_path(RelName),
            schedule_rotation(Name, Date),
            Shaper = lager_util:maybe_flush(Flush, #lager_shaper{hwm=HighWaterMark, flush_threshold = FlushThr, id=Name}),
            State0 = #state{name=Name, level=Level, size=Size, date=Date, count=Count, shaper=Shaper, formatter=Formatter,
                formatter_config=FormatterConfig, sync_on=SyncOn, sync_interval=SyncInterval, sync_size=SyncSize,
                check_interval=CheckInterval},
            State = case lager_util:open_logfile(Name, {SyncSize, SyncInterval}) of
                {ok, {FD, Inode, _}} ->
                    State0#state{fd=FD, inode=Inode};
                {error, Reason} ->
                    ?INT_LOG(error, "Failed to open log file ~s with error ~s", [Name, file:format_error(Reason)]),
                    State0#state{flap=true}
            end,
            {ok, State}
    end.

%% @private
handle_call({set_loglevel, Level}, #state{name=Ident} = State) ->
    case validate_loglevel(Level) of
        false ->
            {ok, {error, bad_loglevel}, State};
        Levels ->
            ?INT_LOG(notice, "Changed loglevel of ~s to ~p", [Ident, Level]),
            {ok, ok, State#state{level=Levels}}
    end;
handle_call(get_loglevel, #state{level=Level} = State) ->
    {ok, Level, State};
handle_call({set_loghwm, Hwm}, #state{shaper=Shaper, name=Name} = State) ->
    case validate_logfile_proplist([{file, Name}, {high_water_mark, Hwm}]) of
        false ->
            {ok, {error, bad_log_hwm}, State};
        _ ->
            NewShaper = Shaper#lager_shaper{hwm=Hwm},
            ?INT_LOG(notice, "Changed loghwm of ~s to ~p", [Name, Hwm]),
            {ok, {last_loghwm, Shaper#lager_shaper.hwm}, State#state{shaper=NewShaper}}
    end;
handle_call(rotate, State = #state{name=File}) ->
    {ok, NewState} = handle_info({rotate, File}, State),
    {ok, ok, NewState};
handle_call(_Request, State) ->
    {ok, ok, State}.

%% @private
handle_event({log, Message},
    #state{name=Name, level=L, shaper=Shaper, formatter=Formatter,formatter_config=FormatConfig} = State) ->
    case lager_util:is_loggable(Message,L,{lager_file_backend, Name}) of
        true ->
            case lager_util:check_hwm(Shaper) of
                {true, Drop, #lager_shaper{hwm=Hwm} = NewShaper} ->
                    NewState = case Drop > 0 of
                        true ->
                            Report = io_lib:format(
                                "lager_file_backend dropped ~p messages in the last second that exceeded the limit of ~p messages/sec",
                                [Drop, Hwm]),
                            ReportMsg = lager_msg:new(Report, warning, [], []),
                            write(State, lager_msg:timestamp(ReportMsg),
                                lager_msg:severity_as_int(ReportMsg), Formatter:format(ReportMsg, FormatConfig));
                        false ->
                            State
                    end,
                    {ok,write(NewState#state{shaper=NewShaper},
                        lager_msg:timestamp(Message), lager_msg:severity_as_int(Message),
                        Formatter:format(Message,FormatConfig))};
                {false, _, NewShaper} ->
                    {ok, State#state{shaper=NewShaper}}
            end;
        false ->
            {ok, State}
    end;
handle_event(_Event, State) ->
    {ok, State}.

%% @private
handle_info({rotate, File}, #state{name=File,count=Count,date=Date} = State) ->
    _ = lager_util:rotate_logfile(File, Count),
    State1 = close_file(State),
    schedule_rotation(File, Date),
    {ok, State1};
handle_info({shaper_expired, Name}, #state{shaper=Shaper, name=Name, formatter=Formatter, formatter_config=FormatConfig} = State) ->
    Report = io_lib:format(
               "lager_file_backend dropped ~p messages in the last second that exceeded the limit of ~p messages/sec",
               [Shaper#lager_shaper.dropped, Shaper#lager_shaper.hwm]),
    ReportMsg = lager_msg:new(Report, warning, [], []),
    write(State, lager_msg:timestamp(ReportMsg),
          lager_msg:severity_as_int(ReportMsg), Formatter:format(ReportMsg, FormatConfig)),
    {ok, State#state{shaper=Shaper#lager_shaper{dropped=0, mps=1, lasttime=os:timestamp()}}};
handle_info(_Info, State) ->
    {ok, State}.

%% @private
terminate(_Reason, State) ->
    %% leaving this function call unmatched makes dialyzer cranky
    _ = close_file(State),
    ok.

%% @private
code_change(_OldVsn, State, _Extra) ->
    {ok, State}.

%% Convert the config into a gen_event handler ID
config_to_id({Name,_Severity}) when is_list(Name) ->
    {?MODULE, Name};
config_to_id({Name,_Severity,_Size,_Rotation,_Count}) ->
    {?MODULE, Name};
config_to_id([{Name,_Severity,_Size,_Rotation,_Count}, _Format]) ->
    {?MODULE, Name};
config_to_id([{Name,_Severity}, _Format]) when is_list(Name) ->
    {?MODULE, Name};
config_to_id(Config) ->
    case proplists:get_value(file, Config) of
        undefined ->
            erlang:error(no_file);
        File ->
            {?MODULE, File}
    end.


write(#state{name=Name, fd=FD, inode=Inode, flap=Flap, size=RotSize,
        count=Count} = State, Timestamp, Level, Msg) ->
    LastCheck = timer:now_diff(Timestamp, State#state.last_check) div 1000,
    case LastCheck >= State#state.check_interval orelse FD == undefined of
        true ->
            %% need to check for rotation
            case lager_util:ensure_logfile(Name, FD, Inode, {State#state.sync_size, State#state.sync_interval}) of
                {ok, {_, _, Size}} when RotSize /= 0, Size > RotSize ->
                    case lager_util:rotate_logfile(Name, Count) of
                        ok ->
                            %% go around the loop again, we'll do another rotation check and hit the next clause of ensure_logfile
                            write(State, Timestamp, Level, Msg);
                        {error, Reason} ->
                            case Flap of
                                true ->
                                    State;
                                _ ->
                                    ?INT_LOG(error, "Failed to rotate log file ~s with error ~s", [Name, file:format_error(Reason)]),
                                    State#state{flap=true}
                            end
                    end;
                {ok, {NewFD, NewInode, _}} ->
                    %% update our last check and try again
                    do_write(State#state{last_check=Timestamp, fd=NewFD, inode=NewInode}, Level, Msg);
                {error, Reason} ->
                    case Flap of
                        true ->
                            State;
                        _ ->
                            ?INT_LOG(error, "Failed to reopen log file ~s with error ~s", [Name, file:format_error(Reason)]),
                            State#state{flap=true}
                    end
            end;
        false ->
            do_write(State, Level, Msg)
    end.

do_write(#state{fd=FD, name=Name, flap=Flap} = State, Level, Msg) ->
    %% delayed_write doesn't report errors
    _ = file:write(FD, unicode:characters_to_binary(Msg)),
    {mask, SyncLevel} = State#state.sync_on,
    case (Level band SyncLevel) /= 0 of
        true ->
            %% force a sync on any message that matches the 'sync_on' bitmask
            Flap2 = case file:datasync(FD) of
                {error, Reason2} when Flap == false ->
                    ?INT_LOG(error, "Failed to write log message to file ~s: ~s",
                        [Name, file:format_error(Reason2)]),
                    true;
                ok ->
                    false;
                _ ->
                    Flap
            end,
            State#state{flap=Flap2};
        _ ->
            State
    end.

validate_loglevel(Level) ->
    try lager_util:config_to_mask(Level) of
        Levels ->
            Levels
    catch
        _:_ ->
            false
    end.

validate_logfile_proplist(List) ->
    try validate_logfile_proplist(List, []) of
        Res ->
            case proplists:get_value(file, Res) of
                undefined ->
                    ?INT_LOG(error, "Missing required file option", []),
                    false;
                _File ->
                    %% merge with the default options
                    {ok, DefaultRotationDate} = lager_util:parse_rotation_date_spec(?DEFAULT_ROTATION_DATE),
                    lists:keymerge(1, lists:sort(Res), lists:sort([
                            {level, validate_loglevel(?DEFAULT_LOG_LEVEL)}, {date, DefaultRotationDate},
                            {size, ?DEFAULT_ROTATION_SIZE}, {count, ?DEFAULT_ROTATION_COUNT},
                            {sync_on, validate_loglevel(?DEFAULT_SYNC_LEVEL)}, {sync_interval, ?DEFAULT_SYNC_INTERVAL},
                            {sync_size, ?DEFAULT_SYNC_SIZE}, {check_interval, ?DEFAULT_CHECK_INTERVAL},
                            {formatter, lager_default_formatter}, {formatter_config, []}
                        ]))
            end
    catch
        {bad_config, Msg, Value} ->
            ?INT_LOG(error, "~s ~p for file ~p",
                [Msg, Value, proplists:get_value(file, List)]),
            false
    end.

validate_logfile_proplist([], Acc) ->
    Acc;
validate_logfile_proplist([{file, File}|Tail], Acc) ->
    %% is there any reasonable validation we can do here?
    validate_logfile_proplist(Tail, [{file, File}|Acc]);
validate_logfile_proplist([{level, Level}|Tail], Acc) ->
    case validate_loglevel(Level) of
        false ->
            throw({bad_config, "Invalid loglevel", Level});
        Res ->
            validate_logfile_proplist(Tail, [{level, Res}|Acc])
    end;
validate_logfile_proplist([{size, Size}|Tail], Acc) ->
    case Size of
        S when is_integer(S), S >= 0 ->
            validate_logfile_proplist(Tail, [{size, Size}|Acc]);
        _ ->
            throw({bad_config, "Invalid rotation size", Size})
    end;
validate_logfile_proplist([{count, Count}|Tail], Acc) ->
    case Count of
        C when is_integer(C), C >= 0 ->
            validate_logfile_proplist(Tail, [{count, Count}|Acc]);
        _ ->
            throw({bad_config, "Invalid rotation count", Count})
    end;
validate_logfile_proplist([{high_water_mark, HighWaterMark}|Tail], Acc) ->
    case HighWaterMark of
        Hwm when is_integer(Hwm), Hwm >= 0 ->
            validate_logfile_proplist(Tail, [{high_water_mark, Hwm}|Acc]);
        _ ->
            throw({bad_config, "Invalid high water mark", HighWaterMark})
    end;
validate_logfile_proplist([{date, Date}|Tail], Acc) ->
    case lager_util:parse_rotation_date_spec(Date) of
        {ok, Spec} ->
            validate_logfile_proplist(Tail, [{date, Spec}|Acc]);
        {error, _} when Date == "" ->
            %% legacy config allowed blanks
            validate_logfile_proplist(Tail, [{date, undefined}|Acc]);
        {error, _} ->
            throw({bad_config, "Invalid rotation date", Date})
    end;
validate_logfile_proplist([{sync_interval, SyncInt}|Tail], Acc) ->
    case SyncInt of
        Val when is_integer(Val), Val >= 0 ->
            validate_logfile_proplist(Tail, [{sync_interval, Val}|Acc]);
        _ ->
            throw({bad_config, "Invalid sync interval", SyncInt})
    end;
validate_logfile_proplist([{sync_size, SyncSize}|Tail], Acc) ->
    case SyncSize of
        Val when is_integer(Val), Val >= 0 ->
            validate_logfile_proplist(Tail, [{sync_size, Val}|Acc]);
        _ ->
            throw({bad_config, "Invalid sync size", SyncSize})
    end;
validate_logfile_proplist([{check_interval, CheckInt}|Tail], Acc) ->
    case CheckInt of
        Val when is_integer(Val), Val >= 0 ->
            validate_logfile_proplist(Tail, [{check_interval, Val}|Acc]);
        always ->
            validate_logfile_proplist(Tail, [{check_interval, 0}|Acc]);
        _ ->
            throw({bad_config, "Invalid check interval", CheckInt})
    end;
validate_logfile_proplist([{sync_on, Level}|Tail], Acc) ->
    case validate_loglevel(Level) of
        false ->
            throw({bad_config, "Invalid sync on level", Level});
        Res ->
            validate_logfile_proplist(Tail, [{sync_on, Res}|Acc])
    end;
validate_logfile_proplist([{formatter, Fmt}|Tail], Acc) ->
    case is_atom(Fmt) of
        true ->
            validate_logfile_proplist(Tail, [{formatter, Fmt}|Acc]);
        false ->
            throw({bad_config, "Invalid formatter module", Fmt})
    end;
validate_logfile_proplist([{formatter_config, FmtCfg}|Tail], Acc) ->
    case is_list(FmtCfg) of
        true ->
            validate_logfile_proplist(Tail, [{formatter_config, FmtCfg}|Acc]);
        false ->
            throw({bad_config, "Invalid formatter config", FmtCfg})
    end;
validate_logfile_proplist([Other|_Tail], _Acc) ->
    throw({bad_config, "Invalid option", Other}).

schedule_rotation(_, undefined) ->
    ok;
schedule_rotation(Name, Date) ->
    erlang:send_after(lager_util:calculate_next_rotation(Date) * 1000, self(), {rotate, Name}),
    ok.

close_file(#state{fd=undefined} = State) ->
    State;
close_file(#state{fd=FD} = State) ->
    %% Flush and close any file handles.
    _ = file:datasync(FD),
    _ = file:close(FD),
    State#state{fd=undefined}.

-ifdef(TEST).

get_loglevel_test() ->
    {ok, Level, _} = handle_call(get_loglevel,
        #state{name="bar", level=lager_util:config_to_mask(info), fd=0, inode=0}),
    ?assertEqual(Level, lager_util:config_to_mask(info)),
    {ok, Level2, _} = handle_call(get_loglevel,
        #state{name="foo", level=lager_util:config_to_mask(warning), fd=0, inode=0}),
    ?assertEqual(Level2, lager_util:config_to_mask(warning)).

rotation_test_() ->
    {foreach,
        fun() ->
            SyncLevel = validate_loglevel(?DEFAULT_SYNC_LEVEL),
            SyncSize = ?DEFAULT_SYNC_SIZE,
            SyncInterval = ?DEFAULT_SYNC_INTERVAL,
            CheckInterval = 0, %% hard to test delayed mode
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            #state{name=TestLog, level=?DEBUG, sync_on=SyncLevel,
                sync_size=SyncSize, sync_interval=SyncInterval, check_interval=CheckInterval}

        end,
        fun(#state{name=TestLog}) ->
            lager_util:delete_test_dir(filename:dirname(TestLog))
        end, [
        fun(DefaultState = #state{name=TestLog, sync_size=SyncSize, sync_interval = SyncInterval}) ->
            {"External rotation should work",
            fun() ->
                {ok, {FD, Inode, _}} = lager_util:open_logfile(TestLog, {SyncSize, SyncInterval}),
                State0 = DefaultState#state{fd=FD, inode=Inode},
                ?assertMatch(#state{name=TestLog, level=?DEBUG, fd=FD, inode=Inode},
                    write(State0, os:timestamp(), ?DEBUG, "hello world")),
                file:delete(TestLog),
                Result = write(State0, os:timestamp(), ?DEBUG, "hello world"),
                %% assert file has changed
                ?assert(#state{name=TestLog, level=?DEBUG, fd=FD, inode=Inode} =/= Result),
                ?assertMatch(#state{name=TestLog, level=?DEBUG}, Result),
                file:rename(TestLog, TestLog ++ ".1"),
                Result2 = write(Result, os:timestamp(), ?DEBUG, "hello world"),
                %% assert file has changed
                ?assert(Result =/= Result2),
                ?assertMatch(#state{name=TestLog, level=?DEBUG}, Result2),
                ok
            end}
        end,
        fun(DefaultState = #state{name=TestLog, sync_size=SyncSize, sync_interval = SyncInterval}) ->
            {"Internal rotation and delayed write",
            fun() ->
                TestLog0 = TestLog ++ ".0",
                CheckInterval = 3000, % 3 sec
                RotationSize = 15,
                PreviousCheck = os:timestamp(),

                {ok, {FD, Inode, _}} = lager_util:open_logfile(TestLog, {SyncSize, SyncInterval}),
                State0 = DefaultState#state{
                    fd=FD, inode=Inode, size=RotationSize,
                    check_interval=CheckInterval, last_check=PreviousCheck},

                %% new message within check interval with sync_on level
                Msg1Timestamp = add_secs(PreviousCheck, 1),
                State0 = State1 = write(State0, Msg1Timestamp, ?ERROR, "big big message 1"),

                %% new message within check interval under sync_on level
                %% not written to disk yet
                Msg2Timestamp = add_secs(PreviousCheck, 2),
                State0 = State2 = write(State1, Msg2Timestamp, ?DEBUG, "buffered message 2"),

                %% although file size is big enough...
                {ok, FInfo} = file:read_file_info(TestLog),
                ?assert(RotationSize < FInfo#file_info.size),
                %% ...no rotation yet
                ?assertEqual(PreviousCheck, State2#state.last_check),
                ?assertNot(filelib:is_regular(TestLog0)),

                %% new message after check interval
                Msg3Timestamp = add_secs(PreviousCheck, 4),
                _State3 = write(State2, Msg3Timestamp, ?DEBUG, "message 3"),

                %% rotation happened
                ?assert(filelib:is_regular(TestLog0)),

                {ok, Bin1} = file:read_file(TestLog0),
                {ok, Bin2} = file:read_file(TestLog),
                %% message 1-3 written to file
                ?assertEqual(<<"big big message 1buffered message 2">>, Bin1),
                %% message 4 buffered, not yet written to file
                ?assertEqual(<<"">>, Bin2),
                ok
            end}
        end
    ]}.

add_secs({Mega, Secs, Micro}, Add) ->
    NewSecs = Secs + Add,
    {Mega + NewSecs div 10000000, NewSecs rem 10000000, Micro}.

filesystem_test_() ->
    {foreach,
        fun() ->
            error_logger:tty(false),
            application:load(lager),
            application:set_env(lager, handlers, [{lager_test_backend, info}]),
            application:set_env(lager, error_logger_redirect, false),
            application:set_env(lager, async_threshold, undefined),
            lager:start(),
            %% race condition where lager logs its own start up
            %% makes several tests fail. See test/lager_test_backend
            %% around line 800 for more information.
            timer:sleep(5),
            lager_test_backend:flush()
        end,
        fun(_) ->
            application:stop(lager),
            application:stop(goldrush),
            error_logger:tty(true)
        end, [
        {"under normal circumstances, file should be opened",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend,
                [{TestLog, info}, {lager_default_formatter}]),
            lager:log(error, self(), "Test message"),
            {ok, Bin} = file:read_file(TestLog),
            Pid = pid_to_list(self()),
            ?assertMatch([_, _, "[error]", Pid, "Test message\n"],
                re:split(Bin, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"don't choke on unicode",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend,
                [{TestLog, info}, {lager_default_formatter}]),
            lager:log(error, self(),"~ts", [[20013,25991,27979,35797]]),
            {ok, Bin} = file:read_file(TestLog),
            Pid = pid_to_list(self()),
            ?assertMatch([_, _, "[error]", Pid,
                [228,184,173,230,150,135,230,181,139,232,175,149, $\n]],
                re:split(Bin, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"don't choke on latin-1",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            %% XXX if this test fails, check that this file is encoded latin-1, not utf-8!
            gen_event:add_handler(lager_event, lager_file_backend,
                [{TestLog, info}, {lager_default_formatter}]),
            lager:log(error, self(),"~ts", [[76, 198, 221, 206, 78, $-, 239]]),
            {ok, Bin} = file:read_file(TestLog),
            Pid = pid_to_list(self()),
            Res = re:split(Bin, " ", [{return, list}, {parts, 5}]),
            ?assertMatch([_, _, "[error]", Pid,
                [76,195,134,195,157,195,142,78,45,195,175,$\n]], Res),

            lager_util:delete_test_dir(TestDir)
        end},
        {"file can't be opened on startup triggers an error message",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),
            ?assertEqual(ok, file:write_file(TestLog, [])),

            {ok, FInfo} = file:read_file_info(TestLog),
            file:write_file_info(TestLog, FInfo#file_info{mode = 0}),
            gen_event:add_handler(lager_event, lager_file_backend,
                {TestLog, info, 10*1024*1024, "$D0", 5}),
            ?assertEqual(1, lager_test_backend:count()),
            {_Level, _Time,Message,_Metadata} = lager_test_backend:pop(),
            ?assertEqual(
                "Failed to open log file " ++ TestLog ++ " with error permission denied",
                lists:flatten(Message)),

            lager_util:delete_test_dir(TestDir)
        end},
        {"file that becomes unavailable at runtime should trigger an error message",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend,
                [{file, TestLog}, {level, info}, {check_interval, 0}]),
            ?assertEqual(0, lager_test_backend:count()),
            lager:log(error, self(), "Test message"),
            ?assertEqual(1, lager_test_backend:count()),
            file:delete(TestLog),
            file:write_file(TestLog, ""),
            {ok, FInfo} = file:read_file_info(TestLog),
            file:write_file_info(TestLog, FInfo#file_info{mode = 0}),
            lager:log(error, self(), "Test message"),
            ?assertEqual(3, lager_test_backend:count()),
            lager_test_backend:pop(),
            lager_test_backend:pop(),
            {_Level, _Time, Message,_Metadata} = lager_test_backend:pop(),
            ?assertEqual(
                "Failed to reopen log file " ++ TestLog ++ " with error permission denied",
                lists:flatten(Message)),

            lager_util:delete_test_dir(TestDir)
        end},
        {"unavailable files that are fixed at runtime should start having log messages written",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),
            ?assertEqual(ok, file:write_file(TestLog, [])),

            {ok, FInfo} = file:read_file_info(TestLog),
            OldPerms = FInfo#file_info.mode,
            file:write_file_info(TestLog, FInfo#file_info{mode = 0}),
            gen_event:add_handler(lager_event, lager_file_backend,
                [{file, TestLog},{check_interval, 0}]),
            ?assertEqual(1, lager_test_backend:count()),
            {_Level, _Time, Message,_Metadata} = lager_test_backend:pop(),
            ?assertEqual(
                "Failed to open log file " ++ TestLog ++ " with error permission denied",
                lists:flatten(Message)),
            file:write_file_info(TestLog, FInfo#file_info{mode = OldPerms}),
            lager:log(error, self(), "Test message"),
            {ok, Bin} = file:read_file(TestLog),
            Pid = pid_to_list(self()),
            ?assertMatch([_, _, "[error]", Pid, "Test message\n"],
                re:split(Bin, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"external logfile rotation/deletion should be handled",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),
            TestLog0 = TestLog ++ ".0",

            gen_event:add_handler(lager_event, lager_file_backend,
                [{file, TestLog}, {level, info}, {check_interval, 0}]),
            ?assertEqual(0, lager_test_backend:count()),
            lager:log(error, self(), "Test message1"),
            ?assertEqual(1, lager_test_backend:count()),
            file:delete(TestLog),
            file:write_file(TestLog, ""),
            lager:log(error, self(), "Test message2"),
            {ok, Bin} = file:read_file(TestLog),
            Pid = pid_to_list(self()),
            ?assertMatch([_, _, "[error]", Pid, "Test message2\n"],
                re:split(Bin, " ", [{return, list}, {parts, 5}])),
            file:rename(TestLog, TestLog0),
            lager:log(error, self(), "Test message3"),
            {ok, Bin2} = file:read_file(TestLog),
            ?assertMatch([_, _, "[error]", Pid, "Test message3\n"],
                re:split(Bin2, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"internal size rotation should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),
            TestLog0 = TestLog ++ ".0",

            gen_event:add_handler(lager_event, lager_file_backend,
                [{file, TestLog}, {level, info}, {check_interval, 0}, {size, 10}]),
            lager:log(error, self(), "Test message1"),
            lager:log(error, self(), "Test message1"),
            ?assert(filelib:is_regular(TestLog0)),

            lager_util:delete_test_dir(TestDir)
        end},
        {"internal time rotation should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),
            TestLog0 = TestLog ++ ".0",

            gen_event:add_handler(lager_event, lager_file_backend,
                [{file, TestLog}, {level, info}, {check_interval, 1000}]),
            lager:log(error, self(), "Test message1"),
            lager:log(error, self(), "Test message1"),
            whereis(lager_event) ! {rotate, TestLog},
            lager:log(error, self(), "Test message1"),
            ?assert(filelib:is_regular(TestLog0)),

            lager_util:delete_test_dir(TestDir)
        end},
        {"rotation call should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),
            TestLog0 = TestLog ++ ".0",

            gen_event:add_handler(lager_event, {lager_file_backend, TestLog},
                [{file, TestLog}, {level, info}, {check_interval, 1000}]),
            lager:log(error, self(), "Test message1"),
            lager:log(error, self(), "Test message1"),
            gen_event:call(lager_event, {lager_file_backend, TestLog}, rotate, infinity),
            lager:log(error, self(), "Test message1"),
            ?assert(filelib:is_regular(TestLog0)),

            lager_util:delete_test_dir(TestDir)
        end},
        {"sync_on option should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend, [{file, TestLog},
                {level, info}, {sync_on, "=info"}, {check_interval, 5000}, {sync_interval, 5000}]),
            lager:log(error, self(), "Test message1"),
            lager:log(error, self(), "Test message1"),
            ?assertEqual({ok, <<>>}, file:read_file(TestLog)),
            lager:log(info, self(), "Test message1"),
            {ok, Bin} = file:read_file(TestLog),
            ?assert(<<>> /= Bin),

            lager_util:delete_test_dir(TestDir)
        end},
        {"sync_on none option should work (also tests sync_interval)",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend, [{file, TestLog},
                {level, info}, {sync_on, "none"}, {check_interval, 5000}, {sync_interval, 1000}]),
            lager:log(error, self(), "Test message1"),
            lager:log(error, self(), "Test message1"),
            ?assertEqual({ok, <<>>}, file:read_file(TestLog)),
            lager:log(info, self(), "Test message1"),
            ?assertEqual({ok, <<>>}, file:read_file(TestLog)),
            timer:sleep(2000),
            {ok, Bin} = file:read_file(TestLog),
            ?assert(<<>> /= Bin),

            lager_util:delete_test_dir(TestDir)
        end},
        {"sync_size option should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend, [{file, TestLog}, {level, info},
                {sync_on, "none"}, {check_interval, 5001}, {sync_size, 640}, {sync_interval, 5001}]),
            lager:log(error, self(), "Test messageis64bytes"),
            lager:log(error, self(), "Test messageis64bytes"),
            lager:log(error, self(), "Test messageis64bytes"),
            lager:log(error, self(), "Test messageis64bytes"),
            lager:log(error, self(), "Test messageis64bytes"),
            ?assertEqual({ok, <<>>}, file:read_file(TestLog)),
            lager:log(error, self(), "Test messageis64bytes"),
            lager:log(error, self(), "Test messageis64bytes"),
            lager:log(error, self(), "Test messageis64bytes"),
            lager:log(error, self(), "Test messageis64bytes"),
            ?assertEqual({ok, <<>>}, file:read_file(TestLog)),
            %% now we've written enough bytes
            lager:log(error, self(), "Test messageis64bytes"),
            {ok, Bin} = file:read_file(TestLog),
            ?assert(<<>> /= Bin),

            lager_util:delete_test_dir(TestDir)
        end},
        {"runtime level changes",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, {lager_file_backend, TestLog}, {TestLog, info}),
            ?assertEqual(0, lager_test_backend:count()),
            lager:log(info, self(), "Test message1"),
            lager:log(error, self(), "Test message2"),
            {ok, Bin} = file:read_file(TestLog),
            Lines = length(re:split(Bin, "\n", [{return, list}, trim])),
            ?assertEqual(Lines, 2),
            ?assertEqual(ok, lager:set_loglevel(lager_file_backend, TestLog, warning)),
            lager:log(info, self(), "Test message3"), %% this won't get logged
            lager:log(error, self(), "Test message4"),
            {ok, Bin2} = file:read_file(TestLog),
            Lines2 = length(re:split(Bin2, "\n", [{return, list}, trim])),
            ?assertEqual(Lines2, 3),

            lager_util:delete_test_dir(TestDir)
        end},
        {"invalid runtime level changes",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),
            TestLog3 = filename:join(TestDir, "test3.log"),

            gen_event:add_handler(lager_event, lager_file_backend,
                [{TestLog, info, 10*1024*1024, "$D0", 5}, {lager_default_formatter}]),
            gen_event:add_handler(lager_event, lager_file_backend, {TestLog3, info}),
            ?assertEqual({error, bad_module}, lager:set_loglevel(lager_file_backend, TestLog, warning)),

            lager_util:delete_test_dir(TestDir)
        end},
        {"tracing should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend, {TestLog, critical}),
            lager:error("Test message"),
            ?assertEqual({ok, <<>>}, file:read_file(TestLog)),
            {Level, _} = lager_config:get({lager_event, loglevel}),
            lager_config:set({lager_event, loglevel}, {Level,
                [{[{module, ?MODULE}], ?DEBUG, {lager_file_backend, TestLog}}]}),
            lager:error("Test message"),
            timer:sleep(1000),
            {ok, Bin} = file:read_file(TestLog),
            ?assertMatch([_, _, "[error]", _, "Test message\n"],
                re:split(Bin, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"tracing should not duplicate messages",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "test.log"),

            gen_event:add_handler(lager_event, lager_file_backend,
                [{file, TestLog}, {level, critical}, {check_interval, always}]),
            lager:critical("Test message"),
            {ok, Bin1} = file:read_file(TestLog),
            ?assertMatch([_, _, "[critical]", _, "Test message\n"],
                re:split(Bin1, " ", [{return, list}, {parts, 5}])),
            ok = file:delete(TestLog),
            {Level, _} = lager_config:get({lager_event, loglevel}),
            lager_config:set({lager_event, loglevel},
                {Level, [{[{module, ?MODULE}], ?DEBUG, {lager_file_backend, TestLog}}]}),
            lager:critical("Test message"),
            {ok, Bin2} = file:read_file(TestLog),
            ?assertMatch([_, _, "[critical]", _, "Test message\n"],
                re:split(Bin2, " ", [{return, list}, {parts, 5}])),
            ok = file:delete(TestLog),
            lager:error("Test message"),
            {ok, Bin3} = file:read_file(TestLog),
            ?assertMatch([_, _, "[error]", _, "Test message\n"],
                re:split(Bin3, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"tracing to a dedicated file should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "foo.log"),

            {ok, _} = lager:trace_file(TestLog, [{module, ?MODULE}]),
            lager:error("Test message"),
            %% not eligible for trace
            lager:log(error, self(), "Test message"),
            {ok, Bin3} = file:read_file(TestLog),
            ?assertMatch([_, _, "[error]", _, "Test message\n"],
                re:split(Bin3, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"tracing to a dedicated file should work even if root_log is set",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            LogName = "foo.log",
            LogPath = filename:join(TestDir, LogName),

            application:set_env(lager, log_root, TestDir),
            {ok, _} = lager:trace_file(LogName, [{module, ?MODULE}]),
            lager:error("Test message"),
            %% not eligible for trace
            lager:log(error, self(), "Test message"),
            {ok, Bin3} = file:read_file(LogPath),
            application:unset_env(lager, log_root),
            ?assertMatch([_, _, "[error]", _, "Test message\n"],
                re:split(Bin3, " ", [{return, list}, {parts, 5}])),

            lager_util:delete_test_dir(TestDir)
        end},
        {"tracing with options should work",
        fun() ->
            TestDir = lager_util:create_test_dir(),
            TestLog = filename:join(TestDir, "foo.log"),
            TestLog0 = TestLog ++ ".0",

            {ok, _} = lager:trace_file(TestLog, [{module, ?MODULE}],
                [{size, 20}, {check_interval, 1}]),
            lager:error("Test message"),
            ?assertNot(filelib:is_regular(TestLog0)),
            %% rotation is sensitive to intervals between
            %% writes so we sleep to exceed the 1
            %% millisecond interval specified by
            %% check_interval above
            timer:sleep(2),
            lager:error("Test message"),
            timer:sleep(10),
            ?assert(filelib:is_regular(TestLog0)),

            lager_util:delete_test_dir(TestDir)
        end}
    ]}.

trace_files_test_() ->
    {foreach,
        fun() ->
            Dir     = lager_util:create_test_dir(),
            Log     = filename:join(Dir, "test.log"),
            Debug   = filename:join(Dir, "debug.log"),
            Events  = filename:join(Dir, "events.log"),

            error_logger:tty(false),
            application:load(lager),
            application:set_env(lager, handlers, [
                {lager_file_backend, [
                    {file, Log},
                    {level, error},
                    {formatter, lager_default_formatter},
                    {formatter_config, [message, "\n"]}
                ]}
            ]),
            application:set_env(lager, traces, [
                { % get default level of debug
                    {lager_file_backend, Debug}, [{module, ?MODULE}]
                },
                { % Handler                       Filters              Level
                    {lager_file_backend, Events}, [{module, ?MODULE}], notice
                }
            ]),
            application:set_env(lager, async_threshold, undefined),
            lager:start(),
            {Dir, Log, Debug, Events}
        end,
        fun({Dir, _, _, _}) ->
            catch ets:delete(lager_config),
            application:unset_env(lager, traces),
            application:stop(lager),

            lager_util:delete_test_dir(Dir),
            error_logger:tty(true)
        end, [
        fun({_, Log, Debug, Events}) ->
            {"a trace using file backend set up in configuration should work",
            fun() ->
                lager:error("trace test error message"),
                lager:info("info message"),
                %% not eligible for trace
                lager:log(error, self(), "Not trace test message"),
                {ok, BinInfo} = file:read_file(Events),
                ?assertMatch([_, _, "[error]", _, "trace test error message\n"],
                    re:split(BinInfo, " ", [{return, list}, {parts, 5}])),
                ?assert(filelib:is_regular(Log)),
                {ok, BinInfo2} = file:read_file(Log),
                ?assertMatch(["trace test error message", "Not trace test message\n"],
                    re:split(BinInfo2, "\n", [{return, list}, {parts, 2}])),
                ?assert(filelib:is_regular(Debug)),
                %% XXX Aughhhh, wish I could force this to flush somehow...
                % should take about 1 second, try for 3 ...
                ?assertEqual(2, count_lines_until(2, add_secs(os:timestamp(), 3), Debug, 0))
            end}
        end
    ]}.

count_lines_until(Lines, Timeout, File, Last) ->
    case timer:now_diff(Timeout, os:timestamp()) > 0 of
        true ->
            timer:sleep(333),
            {ok, Bin} = file:read_file(File),
            case erlang:length(re:split(Bin, "\n", [{return, list}, trim])) of
                Count when Count < Lines ->
                    count_lines_until(Lines, Timeout, File, Count);
                Count ->
                    Count
            end;
        _ ->
            Last
    end.

formatting_test_() ->
    {foreach,
        fun() ->
            Dir = lager_util:create_test_dir(),
            Log1 = filename:join(Dir, "test.log"),
            Log2 = filename:join(Dir, "test2.log"),
            ?assertEqual(ok, file:write_file(Log1, [])),
            ?assertEqual(ok, file:write_file(Log2, [])),

            error_logger:tty(false),
            application:load(lager),
            application:set_env(lager, handlers, [{lager_test_backend, info}]),
            application:set_env(lager, error_logger_redirect, false),
            lager:start(),
            %% same race condition issue
            timer:sleep(5),
            {Dir, Log1, Log2}
        end,
        fun({Dir, _, _}) ->
            application:stop(lager),
            application:stop(goldrush),
            lager_util:delete_test_dir(Dir),
            error_logger:tty(true)
        end, [
        fun({_, Log1, Log2}) ->
            {"Should have two log files, the second prefixed with 2>",
            fun() ->
                gen_event:add_handler(lager_event, lager_file_backend,
                    [{Log1, debug}, {lager_default_formatter, ["[",severity,"] ", message, "\n"]}]),
                gen_event:add_handler(lager_event, lager_file_backend,
                    [{Log2, debug}, {lager_default_formatter, ["2> [",severity,"] ", message, "\n"]}]),
                lager:log(error, self(), "Test message"),
                ?assertMatch({ok, <<"[error] Test message\n">>},file:read_file(Log1)),
                ?assertMatch({ok, <<"2> [error] Test message\n">>},file:read_file(Log2))
            end}
        end
    ]}.

config_validation_test_() ->
    [
        {"missing file",
            ?_assertEqual(false,
                validate_logfile_proplist([{level, info}, {size, 10}]))
        },
        {"bad level",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {level, blah}, {size, 10}]))
        },
        {"bad size",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {size, infinity}]))
        },
        {"bad count",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {count, infinity}]))
        },
        {"bad high water mark",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {high_water_mark, infinity}]))
        },
        {"bad date",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {date, "midnight"}]))
        },
        {"blank date is ok",
            ?_assertMatch([_|_],
                validate_logfile_proplist([{file, "test.log"}, {date, ""}]))
        },
        {"bad sync_interval",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {sync_interval, infinity}]))
        },
        {"bad sync_size",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {sync_size, infinity}]))
        },
        {"bad check_interval",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {check_interval, infinity}]))
        },
        {"bad sync_on level",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {sync_on, infinity}]))
        },
        {"bad formatter module",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {formatter, "io:format"}]))
        },
        {"bad formatter config",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {formatter_config, blah}]))
        },
        {"unknown option",
            ?_assertEqual(false,
                validate_logfile_proplist([{file, "test.log"}, {rhubarb, spicy}]))
        }
    ].


-endif.