[%#
# IMPORTANT NOTE
# This documentation is generated automatically from source
# templates. Any changes you make here may be lost.
#
# The 'docsrc' documentation source bundle is available for download
# from http://www.template-toolkit.org/docs.html and contains all
# the source templates, XML files, scripts, etc., from which the
# documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
page = 'Test'
%]
[% WRAPPER toc;
PROCESS tocitem
title ="SYNOPSIS"
subs = [];
PROCESS tocitem
title ="DESCRIPTION"
subs = [];
PROCESS tocitem
title ="HISTORY"
subs = [];
PROCESS tocitem
title ="BUGS / KNOWN "FEATURES""
subs = [];
PROCESS tocitem
title ="AUTHOR"
subs = [];
PROCESS tocitem
title ="VERSION"
subs = [];
PROCESS tocitem
title ="COPYRIGHT"
subs = [];
PROCESS tocitem
title ="SEE ALSO"
subs = [];
END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
title="SYNOPSIS"
-%]<pre> use Template::Test;
$Template::Test::DEBUG = 0; # set this true to see each test running
$Template::Test::EXTRA = 2; # 2 extra tests follow test_expect()...</pre>
<pre> # ok() can be called any number of times before test_expect
ok( $true_or_false )</pre>
<pre> # test_expect() splits $input into individual tests, processes each
# and compares generated output against expected output
test_expect($input, $template, \%replace );</pre>
<pre> # $input is text or filehandle (e.g. DATA section after __END__)
test_expect( $text );
test_expect( \*DATA );</pre>
<pre> # $template is a Template object or configuration hash
my $template_cfg = { ... };
test_expect( $input, $template_cfg );
my $template_obj = Template->new($template_cfg);
test_expect( $input, $template_obj );</pre>
<pre> # $replace is a hash reference of template variables
my $replace = {
a => 'alpha',
b => 'bravo'
};
test_expect( $input, $template, $replace );</pre>
<pre> # ok() called after test_expect should be declared in $EXTRA (2)
ok( $true_or_false )
ok( $true_or_false ) </pre>
[%- END %]
[% WRAPPER section
title="DESCRIPTION"
-%]<p>
The Template::Test module defines the test_expect() and other related
subroutines which can be used to automate test scripts for the
Template Toolkit. See the numerous tests in the 't' sub-directory of
the distribution for examples of use.
</p>
<p>
The test_expect() subroutine splits an input document into a number
of separate tests, processes each one using the Template Toolkit and
then compares the generated output against an expected output, also
specified in the input document. It generates the familiar "ok/not
ok" output compatible with Test::Harness.
</p>
<p>
The test input should be specified as a text string or a reference to
a filehandle (e.g. GLOB or IO::Handle) from which it can be read. In
particular, this allows the test input to be placed after the __END__
marker and read via the DATA filehandle.
</p>
<pre> use Template::Test;</pre>
<pre> test_expect(\*DATA);</pre>
<pre> __END__
# this is the first test (this is a comment)
-- test --
blah blah blah [% tt_start_tag %] foo [% tt_end_tag %]
-- expect --
blah blah blah value_of_foo</pre>
<pre> # here's the second test (no surprise, so is this)
-- test --
more blah blah [% tt_start_tag %] bar [% tt_end_tag %]
-- expect --
more blah blah value_of_bar</pre>
<p>
Blank lines between test sections are generally ignored. Any line starting
with '#' is treated as a comment and is ignored.
</p>
<p>
The second and third parameters to test_expect() are optional. The second
may be either a reference to a Template object which should be used to
process the template fragments, or a reference to a hash array containing
configuration values which should be used to instantiate a new Template
object.
</p>
<pre> # pass reference to config hash
my $config = {
INCLUDE_PATH => '/here/there:/every/where',
POST_CHOMP => 1,
};
test_expect(\*DATA, $config);</pre>
<pre> # or create Template object explicitly
my $template = Template->new($config);
test_expect(\*DATA, $template);</pre>
<p>
The third parameter may be used to reference a hash array of template
variable which should be defined when processing the tests. This is
passed to the Template process() method.
</p>
<pre> my $replace = {
a => 'alpha',
b => 'bravo',
};</pre>
<pre> test_expect(\*DATA, $config, $replace);</pre>
<p>
The second parameter may be left undefined to specify a default Template
configuration.
</p>
<pre> test_expect(\*DATA, undef, $replace);</pre>
<p>
For testing the output of different Template configurations, a
reference to a list of named Template objects also may be passed as
the second parameter.
</p>
<pre> my $tt1 = Template->new({ ... });
my $tt2 = Template->new({ ... });
my @tts = [ one => $tt1, two => $tt1 ];
The first object in the list is used by default. Other objects may be
switched in with the '-- use $name --' marker. This should immediately
follow a '-- test --' line. That object will then be used for the rest
of the test, or until a different object is selected.</pre>
<pre> -- test --
-- use one --
[% tt_start_tag %] blah [% tt_end_tag %]
-- expect --
blah, blah</pre>
<pre> -- test --
still using one...
-- expect --
...</pre>
<pre> -- test --
-- use two --
[% tt_start_tag %] blah [% tt_end_tag %]
-- expect --
blah, blah, more blah</pre>
<p>
The test_expect() sub counts the number of tests, and then calls ntests()
to generate the familiar "1..$ntests\n" test harness line. Each
test defined generates two test numbers. The first indicates
that the input was processed without error, and the second that the
output matches that expected.
</p>
<p>
Additional test may be run before test_expect() by calling ok().
These test results are cached until ntests() is called and the final
number of tests can be calculated. Then, the "1..$ntests" line is
output, along with "ok $n" / "not ok $n" lines for each of the cached
test result. Subsequent calls to ok() then generate an output line
immediately.
</p>
<pre> my $something = SomeObject->new();
ok( $something );
my $other = AnotherThing->new();
ok( $other );</pre>
<pre> test_expect(\*DATA);</pre>
<p>
If any tests are to follow after test_expect() is called then these
should be pre-declared by setting the $EXTRA package variable. This
value (default: 0) is added to the grand total calculated by ntests().
The results of the additional tests are also registered by calling ok().
</p>
<pre> $Template::Test::EXTRA = 2;</pre>
<pre> # can call ok() any number of times before test_expect()
ok( $did_that_work );
ok( $make_sure );
ok( $dead_certain ); </pre>
<pre> # <some> number of tests...
test_expect(\*DATA, $config, $replace);
# here's those $EXTRA tests
ok( defined $some_result && ref $some_result eq 'ARRAY' );
ok( $some_result->[0] eq 'some expected value' );</pre>
<p>
If you don't want to call test_expect() at all then you can call
ntests($n) to declare the number of tests and generate the test
header line. After that, simply call ok() for each test passing
a true or false values to indicate that the test passed or failed.
</p>
<pre> ntests(2);
ok(1);
ok(0);</pre>
<p>
If you're really lazy, you can just call ok() and not bother declaring
the number of tests at all. All tests results will be cached until the
end of the script and then printed in one go before the program exits.
</p>
<pre> ok( $x );
ok( $y );</pre>
<p>
You can identify only a specific part of the input file for testing
using the '-- start --' and '-- stop --' markers. Anything before the
first '-- start --' is ignored, along with anything after the next
'-- stop --' marker.
</p>
<pre> -- test --
this is test 1 (not performed)
-- expect --
this is test 1 (not performed)</pre>
<pre> -- start --</pre>
<pre> -- test --
this is test 2
-- expect --
this is test 2
-- stop --</pre>
<pre> ...</pre>
<p>
For historical reasons and general utility, the module also defines a
'callsign' subroutine which returns a hash mapping a..z to their phonetic
alphabet equivalent (e.g. radio callsigns). This is used by many
of the test scripts as a "known source" of variable values.
</p>
<pre> test_expect(\*DATA, $config, callsign());</pre>
<p>
A banner() subroutine is also provided which prints a simple banner
including any text passed as parameters, if $DEBUG is set.
</p>
<pre> banner('Testing something-or-other');</pre>
<p>
example output:
</p>
<pre> #------------------------------------------------------------
# Testing something-or-other (27 tests completed)
#------------------------------------------------------------</pre>
<p>
The $DEBUG package variable can be set to enable debugging mode.
</p>
<p>
The $PRESERVE package variable can be set to stop the test_expect()
from converting newlines in the output and expected output into
the literal strings '\n'.
</p>
[%- END %]
[% WRAPPER section
title="HISTORY"
-%]<p>
This module started its butt-ugly life as the t/texpect.pl script. It
was cleaned up to became the Template::Test module some time around
version 0.29. It underwent further cosmetic surgery for version 2.00
but still retains some rear-end resemblances.
</p>
[%- END %]
[% WRAPPER section
title="BUGS / KNOWN "FEATURES""
-%]<p>
Imports all methods by default. This is generally a Bad Thing, but
this module is only used in test scripts (i.e. at build time) so a) we
don't really care and b) it saves typing.
</p>
<p>
The line splitter may be a bit dumb, especially if it sees lines like
-- this -- that aren't supposed to be special markers. So don't do that.
</p>
[%- END %]
[% WRAPPER section
title="AUTHOR"
-%]<p>
Andy Wardley <abw@wardley.org>
</p>
<p>
[% ttlink('http://wardley.org/', 'http://wardley.org/') -%]
</p>
[%- END %]
[% WRAPPER section
title="VERSION"
-%]<p>
2.75, distributed as part of the
Template Toolkit version 2.19, released on 27 April 2007.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
-%]<pre> Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
title="SEE ALSO"
-%]<p>
[% ttlink('Template', 'Template') -%]
</p>
[%- END %]