NAME
TAP::Harness::Compatible - Run Perl standard test scripts with statistics
VERSION
Version 0.54
SYNOPSIS
use TAP::Harness::Compatible;
runtests(@test_files);
DESCRIPTION
This module exists to provide TAP::Harness with an interface that is somewhat backwards compatible with Test::Harness. If you're writing new code consider using TAP::Harness directly instead.
Emulation is provided for runtests
and execute_tests
but the pluggable 'Straps' interface that the real Test::Harness supports is not reproduced here.
FUNCTIONS
The following functions are available.
runtests( @test_files )
This runs all the given @test_files and divines whether they passed or failed based on their output to STDOUT (details above). It prints out each individual test which failed along with a summary report and a how long it all took.
It returns true if everything was ok. Otherwise it will die()
with one of the messages in the DIAGNOSTICS section.
execute_tests( tests => \@test_files, out => \*FH )
Runs all the given @test_files
(just like runtests()
) but doesn't generate the final report. During testing, progress information will be written to the currently selected output filehandle (usually STDOUT
), or to the filehandle given by the out
parameter. The out is optional.
Returns a list of two values, $total
and $failed
, describing the results. $total
is a hash ref summary of all the tests run. Its keys and values are this:
bonus Number of individual todo tests unexpectedly passed
max Number of individual tests ran
ok Number of individual tests passed
sub_skipped Number of individual tests skipped
todo Number of individual todo tests
files Number of test files ran
good Number of test files passed
bad Number of test files failed
tests Number of test files originally given
skipped Number of test files skipped
If $total->{bad} == 0
and $total->{max} > 0
, you've got a successful test.
$failed
is a hash ref of all the test scripts that failed. Each key is the name of a test script, each value is another hash representing how that script failed. Its keys are these:
name Name of the test which failed
estat Script's exit value
wstat Script's wait status
max Number of individual tests
failed Number which failed
canon List of tests which failed (as string).
$failed
should be empty if everything passed.
EXPORT
&runtests
is exported by TAP::Harness::Compatible
by default.
&execute_tests
, $verbose
, $switches
and $debug
are exported upon request.
ENVIRONMENT VARIABLES THAT TAP::HARNESS::COMPATIBLE SETS
TAP::Harness::Compatible
sets these before executing the individual tests.
HARNESS_ACTIVE
-
This is set to a true value. It allows the tests to determine if they are being executed through the harness or by any other means.
HARNESS_VERSION
-
This is the version of
TAP::Harness::Compatible
.
ENVIRONMENT VARIABLES THAT AFFECT TEST::HARNESS
HARNESS_TIMER
-
Setting this to true will make the harness display the number of milliseconds each test took. You can also use prove's
--timer
switch. HARNESS_VERBOSE
-
If true,
TAP::Harness::Compatible
will output the verbose results of running its tests. Setting$TAP::Harness::Compatible::verbose
will override this, or you can use the-v
switch in the prove utility.If true,
TAP::Harness::Compatible
will output the verbose results of running its tests. Setting$TAP::Harness::Compatible::verbose
will override this, or you can use the-v
switch in the prove utility.
SEE ALSO
AUTHORS
Andy Armstrong <andy@hexten.net>
Test::Harness (on which this module is based) has this attribution:
Either Tim Bunce or Andreas Koenig, we don't know. What we know for
sure is, that it was inspired by Larry Wall's F<TEST> script that came
with perl distributions for ages. Numerous anonymous contributors
exist. Andreas Koenig held the torch for many years, and then
Michael G Schwern.
LICENCE AND COPYRIGHT
Copyright (c) 2007, Andy Armstrong <andy@hexten.net>
. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.