test::assertions::testscript(3pm) [debian man page]

Test::Assertions::TestScript(3pm)			User Contributed Perl Documentation			 Test::Assertions::TestScript(3pm)

NAME

       Test::Assertions::TestScript - Base for test scripts

SYNOPSIS

	       use Test::Assertions::TestScript;
	       use Module::To::Test qw( frobnicate );

	       ASSERT(frobnicate(),"Frobnicate returns true");

DESCRIPTION

       Test::Assertions::TestScript provides a base for writing test scripts. It performs some common actions such as setting up the @INC path and
       parsing command-line options, specifically:

       o   The lib and t/lib directories are added to @INC.

       o   The current directory is changed to the directory the script is in.

       o   Test script command-line options are parsed. (See "COMMAND-LINE OPTIONS")

       o   The test set of functions from Test::Assertions are imported into your test script.

       Test::Assertions::TestScript makes certain assumptions about the filesystem layout of your project:

       o   Modules that you are testing are in the lib directory of your project.

       o   Test scripts are in the t directory.

       o   There may also be a t/lib directory for any modules written for the test process.

       Test::Assertions::TestScript should be "use"d before any modules that you intend to test.

OPTIONS

       Options can be supplied to the import function. These should be placed after the "use" or "import". For example

	       use Test::Assertions::TestScript( tests => 10, options => { 'b', $opt_b })

       The following options are defined:

       tests
	   The number of tests to pass to "plan tests" from Test::Assertions.  For example to tell Test::Assertions::TestScript that the script
	   contains 42 tests:

	     use Test::Assertions::TestScript tests => 42;

       options
	   A hashref of additional options to capture via Getopt::Long.  The "options" import parameter is passed verbatim to GetOptions, so
	   something along the following lines is required in order to capture the "-b" command line option:

	     use Test::Assertions::TestScript( options => { 'b' => $opt_b } );

COMMAND-LINE OPTIONS
       A script based on Test::Assertions::TestScript will detect the following command line options.

       -t  Shallow tracing. Traces are "print"ed and AutoImport is turned on.

       -T  Deep tracing. Traces are "print"ed and AutoImport is turned on.

       --trace-module=MODULE
	   Imports tracing into MODULE specifically. Can be specified multiple times.

       -s  Save generated output. You will need to write the actual code to do this in your testscript, but you can inspect
	   $Test::Assertions::TestScript::SAVE_OUTPUT to see whether this argument was given.

       Be aware that all other command line options will be disregarded unless the "options" import parameter is used to capture them.

VERSION

       $Revision: 1.18 $

AUTHOR

       Colin Robertson <cpan _at_ bbc _dot_ co _dot_ uk>

COPYRIGHT

       (c) BBC 2005-6. This program is free software; you can redistribute it and/or modify it under the GNU GPL.

       See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt

perl v5.10.0							    2006-08-10					 Test::Assertions::TestScript(3pm)

Check Out this Related Man Page

Test::Builder::Module(3pm)				 Perl Programmers Reference Guide				Test::Builder::Module(3pm)

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 a handful of common functionality and a method of getting at the
       underlying Test::Builder object.

   Importing
       Test::Builder::Module is a subclass of Exporter which means your module 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> part for you.

       import

       Test::Builder::Module provides an import() 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.

       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 plan to be 23 tests.

       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 import_extra().

       import_extra

	   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.

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

   Builder
       Test::Builder::Module provides some methods of getting at the underlying Test::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 should not get it via "Test::Builder->new" as was previously recommended.

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

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

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

perl v5.18.2							    2014-01-06						Test::Builder::Module(3pm)

Linux and UNIX Man Pages

test::assertions::testscript(3pm) [debian man page]

Check Out this Related Man Page