logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Test::Log::Dispatch -- Test what you are logging

Author

       Jonathan Swartz

Constructor

       The constructor returns a "Test::Log::Dispatch" object, which inherits from "Log::Dispatch" and contains
       a single "Log::Dispatch::Array" output at 'debug' level.

       The constructor requires no parameters. Any parameters will be forwarded to the "Log::Dispatch::Array"
       constructor. For example, you can pass a min_level to override the default 'debug'.

Description

       "Test::Log::Dispatch" is a "Log::Dispatch" object that keeps track of everything logged to it in memory,
       and provides convenient tests against what has been logged.

Methods

       The test_name is optional in the *_ok methods; a reasonable default will be provided.

       contains_ok ($regex[, $test_name])
           Tests  that  a  message in the log buffer matches $regex. On success, the message is removed from the
           log buffer (but any other matches are left untouched).

       does_not_contain_ok ($regex[, $test_name])
           Tests that no message in the log buffer matches $regex.

       empty_ok ([$test_name])
           Tests that there is no log buffer left. On failure, the  log  buffer  is  cleared  to  limit  further
           cascading failures.

       contains_only_ok ($regex[, $test_name])
           Tests that there is a single message in the log buffer and it matches $regex. On success, the message
           is removed.

       clear ()
           Clears the log buffer.

       msgs ()
           Returns  the  current  contents of the log buffer as an array reference, where each element is a hash
           containing a message and level key.

Name

       Test::Log::Dispatch -- Test what you are logging

See Also

       Log::Dispatch, Test::Log4perl

Synopsis

           use Test::More;
           use Test::Log::Dispatch;

           my $log = Test::Log::Dispatch->new();

           # ...
           # call something that logs to $log
           # ...

           # now test to make sure you logged the right things

           $log->contains_ok(qr/good log message/, "good message was logged");
           $log->does_not_contain_ok(qr/unexpected log message/, "unexpected message was not logged");
           $log->empty_ok("no more logs");

           # or

           my $msgs = $log->msgs;
           cmp_deeply($msgs, ['msg1', 'msg2', 'msg3']);

To Do

       •   Allow testing of log levels.

See Also