File: //usr/local/share/man/man3/Test::Fatal.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Test::Fatal 3"
.TH Test::Fatal 3 "2011-11-06" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Test::Fatal \- incredibly simple helpers for testing code with exceptions
.SH "VERSION"
.IX Header "VERSION"
version 0.008
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Test::More;
\& use Test::Fatal;
.Ve
.PP
.Vb 1
\& use System::Under::Test qw(might_die);
.Ve
.PP
.Vb 5
\& is(
\& exception { might_die; },
\& undef,
\& "the code lived",
\& );
.Ve
.PP
.Vb 5
\& isnt(
\& exception { might_die; },
\& undef,
\& "the code died",
\& );
.Ve
.PP
.Vb 5
\& isa_ok(
\& exception { might_die; },
\& 'Exception::Whatever',
\& 'the thrown exception',
\& );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Test::Fatal is an alternative to the popular Test::Exception. It does much
less, but should allow greater flexibility in testing exception-throwing code
with about the same amount of typing.
.PP
It exports one routine by default: \f(CW\*(C`exception\*(C'\fR.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.Sh "exception"
.IX Subsection "exception"
.Vb 1
\& my $exception = exception { ... };
.Ve
.PP
\&\f(CW\*(C`exception\*(C'\fR takes a bare block of code and returns the exception thrown by
that block. If no exception was thrown, it returns undef.
.PP
\&\fB\s-1ACHTUNG\s0!\fR If the block results in a \fIfalse\fR exception, such as 0 or the
empty string, Test::Fatal itself will die. Since either of these cases
indicates a serious problem with the system under testing, this behavior is
considered a \fIfeature\fR. If you must test for these conditions, you should use
Try::Tiny's try/catch mechanism. (Try::Tiny is the underlying exception
handling system of Test::Fatal.)
.PP
Note that there is no \s-1TAP\s0 assert being performed. In other words, no \*(L"ok\*(R" or
\&\*(L"not ok\*(R" line is emitted. It's up to you to use the rest of \f(CW\*(C`exception\*(C'\fR in an
existing test like \f(CW\*(C`ok\*(C'\fR, \f(CW\*(C`isa_ok\*(C'\fR, \f(CW\*(C`is\*(C'\fR, et cetera. Or you may wish to use
the \f(CW\*(C`dies_ok\*(C'\fR and \f(CW\*(C`lives_ok\*(C'\fR wrappers, which do provide \s-1TAP\s0 output.
.PP
\&\f(CW\*(C`exception\*(C'\fR does \fInot\fR alter the stack presented to the called block, meaning
that if the exception returned has a stack trace, it will include some frames
between the code calling \f(CW\*(C`exception\*(C'\fR and the thing throwing the exception.
This is considered a \fIfeature\fR because it avoids the occasionally twitchy
\&\f(CW\*(C`Sub::Uplevel\*(C'\fR mechanism.
.PP
\&\fBAchtung!\fR This is not a great idea:
.PP
.Vb 1
\& like( exception { ... }, qr/foo/, "foo appears in the exception" );
.Ve
.PP
If the code in the \f(CW\*(C`...\*(C'\fR is going to throw a stack trace with the arguments to
each subroutine in its call stack, the test name, \*(L"foo appears in the
exception\*(R" will itself be matched by the regex. Instead, write this:
.PP
.Vb 2
\& my $exception = exception { ... };
\& like( $exception, qr/foo/, "foo appears in the exception" );
.Ve
.Sh "success"
.IX Subsection "success"
.Vb 7
\& try {
\& should_live;
\& } catch {
\& fail("boo, we died");
\& } success {
\& pass("hooray, we lived");
\& };
.Ve
.PP
\&\f(CW\*(C`success\*(C'\fR, exported only by request, is a Try::Tiny helper with semantics
identical to \f(CW\*(C`finally\*(C'\fR, but the body of the block will
only be run if the \f(CW\*(C`try\*(C'\fR block ran without error.
.PP
Although almost any needed exception tests can be performed with \f(CW\*(C`exception\*(C'\fR,
success blocks may sometimes help organize complex testing.
.Sh "dies_ok"
.IX Subsection "dies_ok"
.Sh "lives_ok"
.IX Subsection "lives_ok"
Exported only by request, these two functions run a given block of code, and
provide \s-1TAP\s0 output indicating if it did, or did not throw an exception.
These provide an easy upgrade path for replacing existing unit tests based on
\&\f(CW\*(C`Test::Exception\*(C'\fR.
.PP
\&\s-1RJBS\s0 does not using this except as a convenience while porting tests to use
Test::Fatal's \f(CW\*(C`exception\*(C'\fR routine.
.PP
.Vb 2
\& use Test::More tests => 2;
\& use Test::Fatal qw(dies_ok lives_ok);
.Ve
.PP
.Vb 1
\& dies_ok { die "I failed" } 'code that fails';
.Ve
.PP
.Vb 1
\& lives_ok { return "I'm still alive" } 'code that does not fail';
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo Signes <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by Ricardo Signes.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.