.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Log::Any::Test 3pm" .TH Log::Any::Test 3pm "2009-12-08" "perl v5.10.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Log::Any::Test \-\- Test what you're logging with Log::Any .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use Test::More; \& use Log::Any::Test; # should appear before \*(Aquse Log::Any\*(Aq! \& use Log::Any qw($log); \& \& # ... \& # call something that logs using Log::Any \& # ... \& \& # 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, [{message => \*(Aqmsg1\*(Aq, level => \*(Aqdebug\*(Aq}, ...]); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Log::Any::Test\*(C'\fR is a simple module that allows you to test what has been logged with Log::Any. Most of its \s-1API\s0 and implementation have been taken from Log::Any::Dispatch. .PP Using \f(CW\*(C`Log::Any::Test\*(C'\fR sends all subsequent Log::Any log messages to a single global in-memory buffer. It should be used before Log::Any. .SH "METHODS" .IX Header "METHODS" The test_name is optional in the *_ok methods; a reasonable default will be provided. .IP "msgs ()" 4 .IX Item "msgs ()" Returns the current contents of the global log buffer as an array reference, where each element is a hash containing a \fIcategory\fR, \fIlevel\fR, and \fImessage\fR key. e.g. .Sp .Vb 10 \& { \& category => \*(AqFoo\*(Aq, \& level => \*(Aqerror\*(Aq, \& message => \*(Aqthis is an error\*(Aq \& }, \& { \& category => \*(AqBar::Baz\*(Aq, \& level => \*(Aqdebug\*(Aq, \& message => \*(Aqthis is a debug\*(Aq \& } .Ve .ie n .IP "contains_ok ($regex[, $test_name])" 4 .el .IP "contains_ok ($regex[, \f(CW$test_name\fR])" 4 .IX Item "contains_ok ($regex[, $test_name])" Tests that a message in the log buffer matches \fI\f(CI$regex\fI\fR. On success, the message is \fIremoved\fR from the log buffer (but any other matches are left untouched). .ie n .IP "does_not_contain_ok ($regex[, $test_name])" 4 .el .IP "does_not_contain_ok ($regex[, \f(CW$test_name\fR])" 4 .IX Item "does_not_contain_ok ($regex[, $test_name])" Tests that no message in the log buffer matches \fI\f(CI$regex\fI\fR. .IP "empty_ok ([$test_name])" 4 .IX Item "empty_ok ([$test_name])" Tests that there is no log buffer left. On failure, the log buffer is cleared to limit further cascading failures. .ie n .IP "contains_only_ok ($regex[, $test_name])" 4 .el .IP "contains_only_ok ($regex[, \f(CW$test_name\fR])" 4 .IX Item "contains_only_ok ($regex[, $test_name])" Tests that there is a single message in the log buffer and it matches \&\fI\f(CI$regex\fI\fR. On success, the message is removed. .IP "clear ()" 4 .IX Item "clear ()" Clears the log buffer. .SH "SEE ALSO" .IX Header "SEE ALSO" Log::Any, Test::Log::Dispatch .SH "AUTHOR" .IX Header "AUTHOR" Jonathan Swartz .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright (C) 2009 Jonathan Swartz, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.