test::log::dispatch(3pm) [debian man page]

Test::Log::Dispatch(3pm)				User Contributed Perl Documentation				  Test::Log::Dispatch(3pm)

NAME

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

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']);

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.

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'.

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.

TO DO

       o   Allow testing of log levels.

SEE ALSO

       Log::Dispatch, Test::Log4perl

AUTHOR

       Jonathan Swartz

COPYRIGHT &; LICENSE
       Copyright (C) 2009 Jonathan Swartz, all rights reserved.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2009-11-04						  Test::Log::Dispatch(3pm)

Check Out this Related Man Page

Log::Dispatch::Email(3pm)				User Contributed Perl Documentation				 Log::Dispatch::Email(3pm)

NAME

       Log::Dispatch::Email - Base class for objects that send log messages via email

VERSION

       version 2.32

SYNOPSIS

	 package Log::Dispatch::Email::MySender;

	 use Log::Dispatch::Email;
	 use base qw( Log::Dispatch::Email );

	 sub send_email {
	     my $self = shift;
	     my %p    = @_;

	     # Send email somehow.  Message is in $p{message}
	 }

DESCRIPTION

       This module should be used as a base class to implement Log::Dispatch::* objects that send their log messages via email.  Implementing a
       subclass simply requires the code shown in the SYNOPSIS with a real implementation of the "send_email()" method.

CONSTRUCTOR

       The constructor takes the following parameters in addition to the standard parameters documented in Log::Dispatch::Output:

       o   subject ($)

	   The subject of the email messages which are sent.  Defaults to "$0: log email"

       o   to ($ or @)

	   Either a string or a list reference of strings containing email addresses.  Required.

       o   from ($)

	   A string containing an email address.  This is optional and may not work with all mail sending methods.

       o   buffered (0 or 1)

	   This determines whether the object sends one email per message it is given or whether it stores them up and sends them all at once.
	   The default is to buffer messages.

METHODS

       o   send_email(%p)

	   This is the method that must be subclassed.	For now the only parameter in the hash is 'message'.

       o   flush

	   If the object is buffered, then this method will call the "send_email()" method to send the contents of the buffer and then clear the
	   buffer.

       o   DESTROY

	   On destruction, the object will call "flush()" to send any pending email.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2011 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.14.2							    2012-05-25						 Log::Dispatch::Email(3pm)

Linux and UNIX Man Pages

test::log::dispatch(3pm) [debian man page]

Check Out this Related Man Page