.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" 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<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. 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
.\" 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.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" 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
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. 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 \
.\" ========================================================================
.IX Title "Test::Builder 3"
.TH Test::Builder 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
Test::Builder \- Backend for building test libraries
\& package My::Test::Module;
\& my $Test = Test::Builder->new;
\& $Test->output('my_logfile');
\& $Test->exported_to($pack);
\& $self->export_to_level(1, $self, 'ok');
\& my($test, $name) = @_;
\& $Test->ok($test, $name);
Test::Simple and Test::More have proven to be popular testing modules,
but they're not always flexible enough. Test::Builder provides the a
building block upon which to write your own test libraries \fIwhich can
.IX Subsection "Construction"
\& my $Test = Test::Builder->new;
Returns a Test::Builder object representing the current state of the
Since you only run one test per program \f(CW\*(C`new\*(C'\fR always returns the same
Test::Builder object. No matter how many times you call \fInew()\fR, you're
getting the same object. This is called a singleton. This is done so that
multiple modules share such global information as the test counter and
where test output is going.
If you want a completely new Test::Builder object different from the
singleton, use \f(CW\*(C`create\*(C'\fR.
\& my $Test = Test::Builder->create;
Ok, so there can be more than one Test::Builder object and this is how
you get it. You might use this instead of \f(CW\*(C`new()\*(C'\fR if you're testing
a Test::Builder based module, but otherwise you probably want \f(CW\*(C`new\*(C'\fR.
\&\fB\s-1NOTE\s0\fR: the implementation is not complete. \f(CW\*(C`level\*(C'\fR, for example, is
still shared amongst \fBall\fR Test::Builder objects, even ones created using
this method. Also, the method name may change in the future.
Reinitializes the Test::Builder singleton to its original state.
Mostly useful for tests run in persistent environments where the same
test might be run multiple times in the same process.
.IX Subsection "Setting up tests"
These methods are for setting up tests and declaring how many there
are. You usually only want to call one of these methods.
.IP "\fBexported_to\fR" 4
\& my $pack = $Test->exported_to;
\& $Test->exported_to($pack);
Tells Test::Builder what package you exported your functions to.
This is important for getting \s-1TODO\s0 tests right.
\& $Test->plan('no_plan');
\& $Test->plan( skip_all => $reason );
\& $Test->plan( tests => $num_tests );
A convenient way to set up your tests. Call this and Test::Builder
will print the appropriate headers and take the appropriate actions.
If you call \fIplan()\fR, don't call any of the other methods below.
.IP "\fBexpected_tests\fR" 4
.IX Item "expected_tests"
\& my $max = $Test->expected_tests;
\& $Test->expected_tests($max);
Gets/sets the # of tests we expect this test to run and prints out
Declares that this test will run an indeterminate # of tests.
\& $plan = $Test->has_plan
Find out whether a plan has been defined. \f(CW$plan\fR is either \f(CW\*(C`undef\*(C'\fR (no plan has been set), \f(CW\*(C`no_plan\*(C'\fR (indeterminate # of tests) or an integer (the number of expected tests).
\& $Test->skip_all($reason);
Skips all the tests, using the given \f(CW$reason\fR. Exits immediately with 0.
.IX Subsection "Running tests"
These actually run the tests, analogous to the functions in
$name is always optional.
\& $Test->ok($test, $name);
Your basic test. Pass if \f(CW$test\fR is true, fail if \f(CW$test\fR is false. Just
like Test::Simple's \fIok()\fR.
\& $Test->is_eq($got, $expected, $name);
Like Test::More's \fIis()\fR. Checks if \f(CW$got\fR eq \f(CW$expected\fR. This is the
\& $Test->is_num($got, $expected, $name);
Like Test::More's \fIis()\fR. Checks if \f(CW$got\fR == \f(CW$expected\fR. This is the
\& $Test->isnt_eq($got, $dont_expect, $name);
Like Test::More's \fIisnt()\fR. Checks if \f(CW$got\fR ne \f(CW$dont_expect\fR. This is
\& $Test->is_num($got, $dont_expect, $name);
Like Test::More's \fIisnt()\fR. Checks if \f(CW$got\fR ne \f(CW$dont_expect\fR. This is
\& $Test->like($this, qr/$regex/, $name);
\& $Test->like($this, '/$regex/', $name);
Like Test::More's \fIlike()\fR. Checks if \f(CW$this\fR matches the given \f(CW$regex\fR.
You'll want to avoid qr// if you want your tests to work before 5.005.
\& $Test->unlike($this, qr/$regex/, $name);
\& $Test->unlike($this, '/$regex/', $name);
Like Test::More's \fIunlike()\fR. Checks if \f(CW$this\fR \fBdoes not match\fR the
.IP "\fBmaybe_regex\fR" 4
\& $Test->maybe_regex(qr/$regex/);
\& $Test->maybe_regex('/$regex/');
Convenience method for building testing functions that take regular
expressions as arguments, but need to work before perl 5.005.
Takes a quoted regular expression produced by qr//, or a string
representing a regular expression.
Returns a Perl value which may be used instead of the corresponding
regular expression, or undef if it's argument is not recognised.
For example, a version of \fIlike()\fR, sans the useful diagnostic messages,
\& my ($self, $this, $regex, $name) = @_;
\& my $usable_regex = $self->maybe_regex($regex);
\& die "expecting regex, found '$regex'\en"
\& $self->ok($this =~ m/$usable_regex/, $name);
\& $Test->cmp_ok($this, $type, $that, $name);
Works just like Test::More's \fIcmp_ok()\fR.
\& $Test->cmp_ok($big_num, '!=', $other_big_num);
.IP "\fB\s-1BAIL_OUT\s0\fR" 4
\& $Test->BAIL_OUT($reason);
Indicates to the Test::Harness that things are going so badly all
testing should terminate. This includes running any additional test
Skips the current test, reporting \f(CW$why\fR.
\& $Test->todo_skip($why);
Like \fIskip()\fR, only it will declare the test as failing and \s-1TODO\s0. Similar
\& print "not ok $tnum # TODO $why\en";
.IX Subsection "Test style"
\& $Test->level($how_high);
How far up the call stack should \f(CW$Test\fR look when reporting where the
Setting \f(CW$Test::Builder::Level\fR overrides. This is typically useful
\& local $Test::Builder::Level = 2;
.IP "\fBuse_numbers\fR" 4
\& $Test->use_numbers($on_or_off);
Whether or not the test should output numbers. That is, this if true:
Most useful when you can't depend on the test output order, such as
when threads or forking is involved.
Test::Harness will accept either, but avoid mixing the two styles.
\& $Test->no_diag($no_diag);
If set true no diagnostics will be printed. This includes calls to
\& $Test->no_ending($no_ending);
Normally, Test::Builder does some extra diagnostics when the test
ends. It also changes the exit code as described below.
If this is true, none of that will be done.
\& $Test->no_header($no_header);
If set to true, no \*(L"1..N\*(R" header will be printed.
Controlling where the test output goes.
It's ok for your test to change where \s-1STDOUT\s0 and \s-1STDERR\s0 point to,
Test::Builder's default output settings will not be affected.
Prints out the given \f(CW@msgs\fR. Like \f(CW\*(C`print\*(C'\fR, arguments are simply
Normally, it uses the \fIfailure_output()\fR handle, but if this is for a
\&\s-1TODO\s0 test, the \fItodo_output()\fR handle is used.
Output will be indented and marked with a # so as not to interfere
with test output. A newline will be put on the end if there isn't one
We encourage using this rather than calling print directly.
Returns false. Why? Because \fIdiag()\fR is often used in conjunction with
a failing test (\f(CW\*(C`ok() || diag()\*(C'\fR) it \*(L"passes through\*(R" the failure.
\& return ok(...) || diag(...);
.IP "\fB_print_diag\fR" 4
\& $Test->_print_diag(@msg);
Like _print, but prints to the current diagnostic filehandle.
Where normal \*(L"ok/not ok\*(R" test output should go.
Defaults to \s-1STDOUT\s0.
.IP "\fBfailure_output\fR" 4
.IX Item "failure_output"
\& $Test->failure_output($fh);
\& $Test->failure_output($file);
Where diagnostic output on test failures and \fIdiag()\fR should go.
Defaults to \s-1STDERR\s0.
.IP "\fBtodo_output\fR" 4
\& $Test->todo_output($fh);
\& $Test->todo_output($file);
Where diagnostics about todo test failures and \fIdiag()\fR should go.
Defaults to \s-1STDOUT\s0.
.Sh "Test Status and Info"
.IX Subsection "Test Status and Info"
.IP "\fBcurrent_test\fR" 4
\& my $curr_test = $Test->current_test;
\& $Test->current_test($num);
Gets/sets the current test number we're on. You usually shouldn't
If set forward, the details of the missing tests are filled in as 'unknown'.
if set backward, the details of the intervening tests are deleted. You
can erase history if you really want to.
\& my @tests = $Test->summary;
A simple summary of the tests so far. True for pass, false for fail.
This is a logical pass/fail, so todos are passes.
Of course, test #1 is \f(CW$tests\fR[0], etc...
\& my @tests = $Test->details;
Like \fIsummary()\fR, but with a lot more detail.
\& $tests[$test_num - 1] =
\& { 'ok' => is the test considered a pass?
\& actual_ok => did it literally say 'ok'?
\& name => name of the test (if any)
\& type => type of test (if any, see below).
\& reason => reason for the above (if any)
\&'ok' is true if Test::Harness will consider the test to be a pass.
\&'actual_ok' is a reflection of whether or not the test literally
printed 'ok' or 'not ok'. This is for examining the result of 'todo'
\&'name' is the name of the test.
\&'type' indicates if it was a special test. Normal tests have a type
of ''. Type can be one of the following:
\& todo_skip see todo_skip()
Sometimes the Test::Builder test counter is incremented without it
printing any test output, for example, when \fIcurrent_test()\fR is changed.
In these cases, Test::Builder doesn't know the result of the test, so
it's type is 'unkown'. These details for these tests are filled in.
They are considered ok, but the name and actual_ok is left undef.
For example \*(L"not ok 23 \- hole count # \s-1TODO\s0 insufficient donuts\*(R" would
result in this structure:
\& $tests[22] = # 23 - 1, since arrays start from 0.
\& { ok => 1, # logically, the test passed since it's todo
\& actual_ok => 0, # in absolute terms, it failed
\& reason => 'insufficient donuts'
\& my $todo_reason = $Test->todo;
\& my $todo_reason = $Test->todo($pack);
\&\fItodo()\fR looks for a \f(CW$TODO\fR variable in your tests. If set, all tests
will be considered 'todo' (see Test::More and Test::Harness for
details). Returns the reason (ie. the value of \f(CW$TODO\fR) if running as
todo tests, false otherwise.
\&\fItodo()\fR is about finding the right package to look for \f(CW$TODO\fR in. It
uses the \fIexported_to()\fR package to find it. If that's not set, it's
pretty good at guessing the right package to look at based on \f(CW$Level\fR.
Sometimes there is some confusion about where \fItodo()\fR should be looking
for the \f(CW$TODO\fR variable. If you want to be sure, tell it explicitly
what \f(CW$pack\fR to use.
\& my $package = $Test->caller;
\& my($pack, $file, $line) = $Test->caller;
\& my($pack, $file, $line) = $Test->caller($height);
Like the normal \fIcaller()\fR, except it reports according to your \fIlevel()\fR.
If all your tests passed, Test::Builder will exit with zero (which is
normal). If anything failed it will exit with how many failed. If
you run less (or more) tests than you planned, the missing (or extras)
will be considered failures. If no tests were ever run Test::Builder
will throw a warning and exit with 255. If the test died, even after
having successfully completed all its tests, it will still be
considered a failure and will exit with 255.
\& 0 all tests successful
\& 255 test died or all passed but wrong # of tests run
\& any other number how many failed (including missing or extras)
If you fail more than 254 tests, it will be reported as 254.
In perl 5.8.0 and later, Test::Builder is thread\-safe. The test
number is shared amongst all threads. This means if one thread sets
the test number using \fIcurrent_test()\fR they will all be effected.
Test::Builder is only thread-aware if threads.pm is loaded \fIbefore\fR
\&\s-1CPAN\s0 can provide the best examples. Test::Simple, Test::More,
Test::Exception and Test::Differences all use Test::Builder.
Test::Simple, Test::More, Test::Harness
Original code by chromatic, maintained by Michael G Schwern
Copyright 2002, 2004 by chromatic <chromatic@wgz.org> and
Michael G Schwern <schwern@pobox.com>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR
projects / OpenSPARC-T2-SAM / blob