MAN page from Scientific Linux Other perl-5.8.8-43.el5_11.x86_64.rpm

Test::Builder::Module

Section: Perl Programmers Reference Guide (3pm)
Updated: 2014-10-30
Index

NAME

Test::Builder::Module - Base class for test modules

SYNOPSIS

  # Emulates Test::Simple  package Your::Module;

  my $CLASS = __PACKAGE__;

  use base 'Test::Builder::Module';  @EXPORT = qw(ok);

  sub ok ($;$) {      my $tb = $CLASS->builder;      return $tb->ok(@_);  }

1;

DESCRIPTION

This is a superclass for Test::Builder-based modules. It provides ahandful of common functionality and a method of getting at the underlyingTest::Builder object.

Importing

Test::Builder::Module is a subclass of Exporter which means yourmodule is also a subclass of Exporter. @EXPORT, @EXPORT_OK, etc...all act normally.

A few methods are provided to do the "use Your::Module tests =" 23> partfor you.

import

Test::Builder::Module provides an import() method which acts in thesame basic way as Test::More's, setting the plan and controlingexporting of functions and variables. This allows your module to setthe plan independent of Test::More.

All arguments passed to import() are passed onto "Your::Module->builder->plan()" with the exception of "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 planto be 23 tests.

import() also sets the exported_to() attribute of your builder to bethe caller of the import() function.

Additional behaviors can be added to your import() method by overridingimport_extra().

import_extra

    Your::Module->import_extra(\@import_args);

import_extra() is called by import(). It provides an opportunity for youto 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.

NOTE This mechanism is VERY ALPHA AND LIKELY TO CHANGE as itfeels like a bit of an ugly hack in its current form.

Builder

Test::Builder::Module provides some methods of getting at the underlyingTest::Builder object.

builder

  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 shouldnot get it via "Test::Builder->new" as was previouslyrecommended.

The object returned by builder() may change at runtime so you shouldcall builder() inside each function rather than store it in a global.

  sub ok {      my $builder = Your::Class->builder;

      return $builder->ok(@_);  }

This document was created byman2html,using the manual pages.