| Current Path : /proc/2/root/usr/share/man/man3/ |
| Current File : //proc/2/root/usr/share/man/man3/Test::Builder::Module.3pm |
.\" 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
..
.\}
.\" ========================================================================
.\"
.IX Title "Test::Builder::Module 3"
.TH Test::Builder::Module 3 "2019-04-27" "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"
Test::Builder::Module \- Base class for test modules
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # Emulates Test::Simple
\& package Your::Module;
\&
\& my $CLASS = _\|_PACKAGE_\|_;
\&
\& use parent \*(AqTest::Builder::Module\*(Aq;
\& @EXPORT = qw(ok);
\&
\& sub ok ($;$) {
\& my $tb = $CLASS\->builder;
\& return $tb\->ok(@_);
\& }
\&
\& 1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a superclass for Test::Builder\-based modules. It provides a
handful of common functionality and a method of getting at the underlying
Test::Builder object.
.SS "Importing"
.IX Subsection "Importing"
Test::Builder::Module is a subclass of Exporter which means your
module is also a subclass of Exporter. \f(CW@EXPORT\fR, \f(CW@EXPORT_OK\fR, etc...
all act normally.
.PP
A few methods are provided to do the \f(CW\*(C`use Your::Module tests => 23\*(C'\fR part
for you.
.PP
\fIimport\fR
.IX Subsection "import"
.PP
Test::Builder::Module provides an \f(CW\*(C`import()\*(C'\fR method which acts in the
same basic way as Test::More's, setting the plan and controlling
exporting of functions and variables. This allows your module to set
the plan independent of Test::More.
.PP
All arguments passed to \f(CW\*(C`import()\*(C'\fR are passed onto
\&\f(CW\*(C`Your::Module\->builder\->plan()\*(C'\fR with the exception of
\&\f(CW\*(C`import =>[qw(things to import)]\*(C'\fR.
.PP
.Vb 1
\& use Your::Module import => [qw(this that)], tests => 23;
.Ve
.PP
says to import the functions \f(CW\*(C`this()\*(C'\fR and \f(CW\*(C`that()\*(C'\fR as well as set the plan
to be 23 tests.
.PP
\&\f(CW\*(C`import()\*(C'\fR also sets the \f(CW\*(C`exported_to()\*(C'\fR attribute of your builder to be
the caller of the \f(CW\*(C`import()\*(C'\fR function.
.PP
Additional behaviors can be added to your \f(CW\*(C`import()\*(C'\fR method by overriding
\&\f(CW\*(C`import_extra()\*(C'\fR.
.PP
\fIimport_extra\fR
.IX Subsection "import_extra"
.PP
.Vb 1
\& Your::Module\->import_extra(\e@import_args);
.Ve
.PP
\&\f(CW\*(C`import_extra()\*(C'\fR is called by \f(CW\*(C`import()\*(C'\fR. It provides an opportunity for you
to add behaviors to your module based on its import list.
.PP
Any extra arguments which shouldn't be passed on to \f(CW\*(C`plan()\*(C'\fR should be
stripped off by this method.
.PP
See Test::More for an example of its use.
.PP
\&\fB\s-1NOTE\s0\fR This mechanism is \fI\s-1VERY\s0 \s-1ALPHA\s0 \s-1AND\s0 \s-1LIKELY\s0 \s-1TO\s0 \s-1CHANGE\s0\fR as it
feels like a bit of an ugly hack in its current form.
.SS "Builder"
.IX Subsection "Builder"
Test::Builder::Module provides some methods of getting at the underlying
Test::Builder object.
.PP
\fIbuilder\fR
.IX Subsection "builder"
.PP
.Vb 1
\& my $builder = Your::Class\->builder;
.Ve
.PP
This method returns the Test::Builder object associated with Your::Class.
It is not a constructor so you can call it as often as you like.
.PP
This is the preferred way to get the Test::Builder object. You should
\&\fInot\fR get it via \f(CW\*(C`Test::Builder\->new\*(C'\fR as was previously
recommended.
.PP
The object returned by \f(CW\*(C`builder()\*(C'\fR may change at runtime so you should
call \f(CW\*(C`builder()\*(C'\fR inside each function rather than store it in a global.
.PP
.Vb 2
\& sub ok {
\& my $builder = Your::Class\->builder;
\&
\& return $builder\->ok(@_);
\& }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test2::Manual::Tooling::TestBuilder describes the improved
options for writing testing modules provided by Test2.
Copyright 2K16 - 2K18 Indonesian Hacker Rulez
;?>)