b3ccce63292ada99a662aa379cc112cda5fb795b
package Test
::Builder
::Module
;
# 5.004's Exporter doesn't have export_to_level.
my $_export_to_level = sub {
(undef) = shift; # redundant arg
my $callpkg = caller($level);
$pkg->export($callpkg, @_);
Test::Builder::Module - Base class for test modules
use base 'Test::Builder::Module';
my $tb = $CLASS->builder;
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::Module is a subclass of Exporter which means your
module is also a subclass of Exporter. @EXPORT, @EXPORT_OK, etc...
A few methods are provided to do the C<use Your::Module tests => 23> part
Test::Builder::Module provides an import() method which acts in the
same basic way as Test::More's, setting the plan and controling
exporting of functions and variables. This allows your module to set
the plan independent of Test::More.
All arguments passed to import() are passed onto
C<< Your::Module->builder->plan() >> with the exception of
C<import =>[qw(things to import)]>.
use Your::Module import => [qw(this that)], tests => 23;
says to import the functions this() and that() as well as set the plan
import() also sets the exported_to() attribute of your builder to be
the caller of the import() function.
Additional behaviors can be added to your import() method by overriding
my $test = $class->builder;
$test->exported_to($caller);
$class->import_extra(\
@_);
my(@imports) = $class->_strip_imports(\
@_);
$class->$_export_to_level(1, $class, @imports);
while( $idx <= $#{$list} ) {
my $item = $list->[$idx];
if( defined $item and $item eq 'import' ) {
push @imports, @
{$list->[$idx+1]};
Your::Module->import_extra(\@import_args);
import_extra() is called by import(). It provides an opportunity for you
to add behaviors to your module based on its import list.
Any extra arguments which shouldn't be passed on to plan() should be
stripped off by this method.
See Test::More for an example of its use.
B<NOTE> This mechanism is I<VERY ALPHA AND LIKELY TO CHANGE> as it
feels like a bit of an ugly hack in its current form.
Test::Builder::Module provides some methods of getting at the underlying
my $builder = Your::Class->builder;
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.
This is the preferred way to get the Test::Builder object. You should
I<not> get it via C<< Test::Builder->new >> as was previously
The object returned by builder() may change at runtime so you should
call builder() inside each function rather than store it in a global.
my $builder = Your::Class->builder;
return Test
::Builder
->new;