.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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 "Test::Routine 3pm"
.TH Test::Routine 3pm "2012-03-16" "perl v5.14.2" "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"
Test::Routine \- composable units of assertion
.SH "VERSION"
.IX Header "VERSION"
version 0.015
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBThe interface of Test::Routine is still open to some changes.\fR
.PP
.Vb 4
\&  # mytest.t
\&  use Test::More;
\&  use Test::Routine;
\&  use Test::Routine::Util;
\&
\&  has fixture => (
\&    is   => \*(Aqro\*(Aq,
\&    lazy => 1,
\&    clearer => \*(Aqreset_fixture\*(Aq,
\&    default => sub { ...expensive setup... },
\&  );
\&
\&  test "we can use our fixture to do stuff" => sub {
\&    my ($self) = @_;
\&
\&    $self\->reset_fixture; # this test requires a fresh one
\&
\&    ok( $self\->fixture\->do_things, "do_things returns true");
\&    ok( ! $self\->fixture\->no_op,   "no_op returns false");
\&
\&    for my $item ($self\->fixture\->contents) {
\&      isa_ok($item, \*(AqFixture::Entry\*(Aq);
\&    }
\&  };
\&
\&  test "fixture was recycled" => sub {
\&    my ($self) = @_;
\&
\&    my $fixture = $self\->fixture; # we don\*(Aqt expect a fresh one
\&
\&    is( $self\->fixture\->things_done, 1, "we have done one thing already");
\&  };
\&
\&  run_me;
\&  done_testing;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Test::Routine is a very simple framework for writing your tests as composable
units of assertion.  In other words: roles.
.PP
For a walkthrough of tests written with Test::Routine, see
Test::Routine::Manual::Demo.
.PP
Test::Routine is similar to Test::Class in some ways.  These similarities
are largely superficial, but the idea of \*(L"tests bound together in reusable
units\*(R" is a useful one to understand when coming to Test::Routine.  If you are
already familiar with Test::Class, it is the differences rather than the
similarities that will be more important to understand.  If you are not
familiar with Test::Class, there is no need to understand it prior to using
Test::Routine.
.PP
On the other hand, an understanding of the basics of Moose is absolutely
essential.  Test::Routine composes tests from Moose classes, roles, and
attributes.  Without an understanding of those, you will not be able to use
Test::Routine.  The Moose::Manual is an excellent resource for learning
Moose, and has links to other online tutorials and documentation.
.SS "The Concepts"
.IX Subsection "The Concepts"
.SS "The Basics of Using Test::Routine"
.IX Subsection "The Basics of Using Test::Routine"
There actually isn't much to Test::Routine \fIother\fR than the basics.  It does
not provide many complex features, instead delegating almost everything to the
Moose object system.
.PP
\fIWriting Tests\fR
.IX Subsection "Writing Tests"
.PP
To write a set of tests (a test routine, which is a role), you add \f(CW\*(C`use
Test::Routine;\*(C'\fR to your package.  \f(CW\*(C`main\*(C'\fR is an acceptable target for turning
into a test routine, meaning that you may use Test::Routine in your \fI*.t\fR
files in your distribution.
.PP
\&\f(CW\*(C`use\*(C'\fR\-ing Test::Routine will turn your package into a role that composes
Test::Routine::Common, and will give you the \f(CW\*(C`test\*(C'\fR declarator for adding
tests to your routine.  Test::Routine::Common adds the \f(CW\*(C`run_test\*(C'\fR method that
will be called to run each test.
.PP
The \f(CW\*(C`test\*(C'\fR declarator is very simple, and will generally be called like this:
.PP
.Vb 2
\&  test $NAME_OF_TEST => sub {
\&    my ($self) = @_;
\&
\&    is($self\->foo, 123, "we got the foo we expected");
\&    ...
\&    ...
\&  };
.Ve
.PP
This defines a test with a given name, which will be invoked like a method on
the test object (described below).  Tests are ordered by declaration within the
file, but when multiple test routines are run in a single test, the ordering of
the routines is \fBundefined\fR.
.PP
\&\f(CW\*(C`test\*(C'\fR may also be given a different name for the installed method and the
test description.  This isn't usually needed, but can make things clearer when
referring to tests as methods:
.PP
.Vb 3
\&  test $NAME_OF_TEST_METHOD => { description => $TEST_DESCRIPTION } => sub {
\&    ...
\&  }
.Ve
.PP
Each test will be run by the \f(CW\*(C`run_test\*(C'\fR method.  To add setup or teardown
behavior, advice (method modifiers) may be attached to that method.  For
example, to call an attribute clearer before each test, you could add:
.PP
.Vb 2
\&  before run_test => sub {
\&    my ($self) = @_;
\&
\&    $self\->clear_some_attribute;
\&  };
.Ve
.PP
\fIRunning Tests\fR
.IX Subsection "Running Tests"
.PP
To run tests, you will need to use Test::Routine::Util, which will provide
two functions for running tests: \f(CW\*(C`run_tests\*(C'\fR and \f(CW\*(C`run_me\*(C'\fR.  The former is
given a set of packages to compose and run as tests.  The latter runs the
caller, assuming it to be a test routine.
.PP
\&\f(CW\*(C`run_tests\*(C'\fR can be called in several ways:
.PP
.Vb 1
\&  run_tests( $desc, $object );
\&
\&  run_tests( $desc, \e@packages, $arg );
\&
\&  run_tests( $desc, $package, $arg );  # equivalent to ($desc, [$pkg], $arg)
.Ve
.PP
In the first case, the object is assumed to be a fully formed, testable object.
In other words, you have already created a class that composes test routines
and have built an instance of it.
.PP
In the other cases, \f(CW\*(C`run_tests\*(C'\fR will produce an instance for you.  It divides
the given packages into classes and roles.  If more than one class was given,
an exception is thrown.  A new class is created subclassing the given class and
applying the given roles.  If no class was in the list, Moose::Object is used.
The new class's \f(CW\*(C`new\*(C'\fR is called with the given \f(CW$arg\fR (if any).
.PP
The composition mechanism makes it easy to run a test routine without first
writing a class to which to apply it.  This is what makes it possible to write
your test routine in the \f(CW\*(C`main\*(C'\fR package and run it directly from your \fI*.t\fR
file.  The following is a valid, trivial use of Test::Routine:
.PP
.Vb 3
\&  use Test::More;
\&  use Test::Routine;
\&  use Test::Routine::Util;
\&
\&  test demo_test => sub { pass("everything is okay") };
\&
\&  run_tests(\*(Aqour tests\*(Aq, \*(Aqmain\*(Aq);
\&  done_testing;
.Ve
.PP
In this circumstance, though, you'd probably use \f(CW\*(C`run_me\*(C'\fR, which runs the
tests in the caller.  You'd just replace the \f(CW\*(C`run_tests\*(C'\fR line with
\&\f(CW\*(C`run_me;\*(C'\fR.  A description for the run may be supplied, if you like.
.PP
Each call to \f(CW\*(C`run_me\*(C'\fR or \f(CW\*(C`run_tests\*(C'\fR generates a new instance, and you can
call them as many times, with as many different arguments, as you like.  Since
Test::Routine can't know how many times you'll call different test routines,
you are responsible for calling \f(CW\*(C`done_testing\*(C'\fR when
you're done testing.
.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.