.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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" ''
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::TableDriven 3pm"
.TH Test::TableDriven 3pm "2021-01-09" "perl v5.32.0" "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::TableDriven \- write tests, not scripts that run them
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\& use A::Module qw/or two!/;
\& use Test::TableDriven (
\& foo => { input => \*(Aqexpected output\*(Aq,
\& another => \*(Aqtest\*(Aq,
\& },
\&
\& bar => [[some => \*(Aqmore tests\*(Aq],
\& [that => \*(Aqrun in order\*(Aq],
\& [refs => [qw/also work/]],
\& [[qw/this is also possible/] => { and => \*(Aqit works\*(Aq }],
\& ],
\& );
\&
\& runtests;
\&
\& sub foo {
\& my $in = shift;
\& my $out = ...;
\& return $out;
\& }
\&
\& sub bar { same as foo }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Writing table-driven tests is usually a good idea. Adding a test case
doesn't require adding code, so it's easy to avoid fucking up the
other tests. However, actually going from a table of tests to a test
that runs is non-trivial.
.PP
\&\f(CW\*(C`Test::TableDriven\*(C'\fR makes writing the test drivers trivial. You
simply define your test cases and write a function that turns the
input data into output data to compare against. \f(CW\*(C`Test::TableDriven\*(C'\fR
will compute how many tests need to be run, and then run the tests.
.PP
Concentrate on your data and what you're testing, not \f(CW\*(C`plan tests =\*(C'\fR
scalar keys \f(CW%test_cases\fR> and a big foreach loop.
.SH "WHAT DO I DO"
.IX Header "WHAT DO I DO"
Start by using the modules that you need for your tests:
.PP
.Vb 3
\& use strict;
\& use warnings;
\& use String::Length; # the module you\*(Aqre testing
.Ve
.PP
Then write some code to test the module:
.PP
.Vb 5
\& sub strlen {
\& my $in = shift;
\& my $out = String::Length\->strlen($in);
\& return $out;
\& }
.Ve
.PP
This \f(CW\*(C`strlen\*(C'\fR function will accept a test case (as \f(CW$in\fR) and turns
it into something to compare against your test cases:
.PP
Oh yeah, you need some test cases:
.PP
.Vb 6
\& use Test::TableDriven (
\& strlen => { foo => 3,
\& bar => 3,
\& ...,
\& },
\& );
.Ve
.PP
And you'll want those test to run somehow:
.PP
.Vb 1
\& runtests;
.Ve
.PP
Now execute the test file. The output will look like:
.PP
.Vb 3
\& 1..2
\& ok 1 \- strlen: bar => 3
\& ok 2 \- strlen: foo => 3
.Ve
.PP
Add another test case:
.PP
.Vb 5
\& strlen => { foo => 3,
\& bar => 3,
\& quux => 4,
\& ...,
\& },
.Ve
.PP
And your test still works:
.PP
.Vb 4
\& 1..3
\& ok 1 \- strlen: bar => 3
\& ok 2 \- strlen: quux => 4
\& ok 3 \- strlen: foo => 3
.Ve
.PP
Yay.
.SH "DETAILS"
.IX Header "DETAILS"
I'm not in a prose-generation mood right now, so here's a list of
things to keep in mind:
.IP "\(bu" 4
Don't forget to \f(CW\*(C`runtests\*(C'\fR. Just loading the module doesn't do a
whole lot.
.IP "\(bu" 4
If a subtest is not a subroutine name in the current package, runtests
will die.
.IP "\(bu" 4
If a subtest definition is a hashref, the tests won't be run in order.
If it's an arrayref of arrayrefs, then the tests are run in order.
.IP "\(bu" 4
If a test case \*(L"expects\*(R" a reference, \f(CW\*(C`is_deeply\*(C'\fR is used to compare
the expected result and what your test returned. If it's just a
string, \f(CW\*(C`is\*(C'\fR is used.
.IP "\(bu" 4
Feel free to use \f(CW\*(C`Test::More::diag\*(C'\fR and friends, if you like.
.IP "\(bu" 4
Don't print to \s-1STDOUT.\s0
.IP "\(bu" 4
Especially don't print \s-1TAP\s0 to \s-1STDOUT :\s0)
.SH "EXPORT"
.IX Header "EXPORT"
.SS "runtests"
.IX Subsection "runtests"
Run the tests. Only call this once.
.SH "BUGS"
.IX Header "BUGS"
Report them to \s-1RT,\s0 or patch them against the git repository at:
.PP
.Vb 1
\& git clone git://git.jrock.us/Test\-TableDriven
.Ve
.PP
(or ).
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Rockway \f(CW\*(C`\*(C'\fR.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This module is copyright (c) 2007 Jonathan Rockway. You may use,
modify, and redistribute it under the same terms as Perl itself.