# -*- Mode: cperl; cperl-indent-level: 4 -*-
package Test::Run::Core_GplArt;
use strict;
use warnings;
=head1 NAME
Test::Run::Core_GplArt - GPL/Artistic-licensed code of Test::Run::Core.
=head1 SYNOPSIS
use Test::Run::Obj;
my $tester = Test::Run::Obj->new({'test_files' => \@test_files});
$tester->runtests();
=head1 DESCRIPTION
B<STOP!> If all you want to do is write a test script, consider
using Test::Simple. Test::Run::Core is the module that reads the
output from Test::Simple, Test::More and other modules based on
Test::Builder. You don't need to know about Test::Run::Core to use
those modules.
Test::Run::Core runs tests and expects output from the test in a
certain format. That format is called TAP, the Test Anything
Protocol. It is defined in L<Test::Harness::TAP>.
C<$tester->runtests()> runs all the testscripts named
as arguments and checks standard output for the expected strings
in TAP format.
L<Test::Run::Obj> is an applicative derived class of Test::Run::Core
that provides a programmer API for running and analyzing the output of TAP
files. For calling from the command line, look at
L<Test::Run::CmdLine>.
=head2 Taint mode
Test::Run will honor the C<-T> or C<-t> in the #! line on your
test files. So if you begin a test with:
#!perl -T
the test will be run with taint mode on.
=head2 Failure
When tests fail, analyze the summary report:
t/base..............ok
t/nonumbers.........ok
t/ok................ok
t/test-harness......ok
t/waterloo..........dubious
Test returned status 3 (wstat 768, 0x300)
DIED. FAILED tests 1, 3, 5, 7, 9, 11, 13, 15, 17, 19
Failed 10/20 tests, 50.00% okay
Failed Test Stat Wstat Total Fail Failed List of Failed
-----------------------------------------------------------------------
t/waterloo.t 3 768 20 10 50.00% 1 3 5 7 9 11 13 15 17 19
Failed 1/5 test scripts, 80.00% okay. 10/44 subtests failed, 77.27% okay.
Everything passed but F<t/waterloo.t>. It failed 10 of 20 tests and
exited with non-zero status indicating something dubious happened.
The columns in the summary report mean:
=over 4
=item B<Failed Test>
The test file which failed.
=item B<Stat>
If the test exited with non-zero, this is its exit status.
=item B<Wstat>
The wait status of the test.
=item B<Total>
Total number of tests expected to run.
=item B<Fail>
Number which failed, either from "not ok" or because they never ran.
=item B<Failed>
Percentage of the total tests which failed.
=item B<List of Failed>
A list of the tests which failed. Successive failures may be
abbreviated (ie. 15-20 to indicate that tests 15, 16, 17, 18, 19 and
20 failed).
=back
=head2 Functions
Test::Run currently only has one interface function, here it is.
=over 4
=item B<runtests>
my $allok = $self->runtests();
This runs all the given I<@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 C<die()> with
one of the messages in the DIAGNOSTICS section.
=cut
=begin _private
=item B<_run_all_tests>
my($total, $failed) = _run_all_tests();
Runs all the test_files defined for the object but does it
quietly (no report). $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 C<< $total->{bad} == 0 >> and C<< $total->{max} > 0 >>, you've
got a successful test.
$failed is a hash ref of all the test scripts which 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
percent Percentage of tests which failed
canon List of tests which failed (as string).
C<$failed> should be empty if everything passed.
B<NOTE> Currently this function is still noisy. I'm working on it.
=cut
=end _private
=back
=cut
1;
__END__
=head1 EXPORT
None.
=head1 DIAGNOSTICS
=over 4
=item C<All tests successful.\nFiles=%d, Tests=%d, %s>
If all tests are successful some statistics about the performance are
printed.
=item C<FAILED tests %s\n\tFailed %d/%d tests, %.2f%% okay.>
For any single script that has failing subtests statistics like the
above are printed.
=item C<Test returned status %d (wstat %d)>
Scripts that return a non-zero exit status, both C<$? E<gt>E<gt> 8>
and C<$?> are printed in a message similar to the above.
=item C<Failed 1 test, %.2f%% okay. %s>
=item C<Failed %d/%d tests, %.2f%% okay. %s>
If not all tests were successful, the script dies with one of the
above messages.
=item C<FAILED--Further testing stopped: %s>
If a single subtest decides that further testing will not make sense,
the script dies with this message.
=back
=head1 ENVIRONMENT VARIABLES THAT TEST::HARNESS SETS
Test::Run sets these before executing the individual tests.
=over 4
=item C<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.
=item C<HARNESS_VERSION>
This is the version of Test::Run.
=back
=head1 EXAMPLE
TODO: FIXME
Here's how Test::Run tests itself
$ cd ~/src/devel/Test-Harness
$ perl -Mblib -e 'use Test::Run qw(&runtests $verbose);
$verbose=0; runtests @ARGV;' t/*.t
Using /home/schwern/src/devel/Test-Harness/blib
t/base..............ok
t/nonumbers.........ok
t/ok................ok
t/test-harness......ok
All tests successful.
Files=4, Tests=24, 2 wallclock secs ( 0.61 cusr + 0.41 csys = 1.02 CPU)
=head1 SEE ALSO
The included F<prove> utility for running test scripts from the command line,
L<Test> and L<Test::Simple> for writing test scripts, L<Benchmark> for
the underlying timing routines, and L<Devel::Cover> for test coverage
analysis.
=head1 TODO
Provide a way of running tests quietly (ie. no printing) for automated
validation of tests. This will probably take the form of a version
of runtests() which rather than printing its output returns raw data
on the state of the tests. (Partially done in Test::Run::Straps)
Document the format.
Fix HARNESS_COMPILE_TEST without breaking its core usage.
Figure a way to report test names in the failure summary.
Rework the test summary so long test names are not truncated as badly.
(Partially done with new skip test styles)
Add option for coverage analysis.
Trap STDERR.
Implement Straps total_results()
Remember exit code
Completely redo the print summary code.
Implement Straps callbacks. (experimentally implemented)
Straps->analyze_file() not taint clean, don't know if it can be
Fix that damned VMS nit.
HARNESS_TODOFAIL to display TODO failures
Add a test for verbose.
Change internal list of test results to a hash.
Fix stats display when there's an overrun.
Fix so perls with spaces in the filename work.
Keeping whittling away at _run_all_tests()
Clean up how the summary is printed. Get rid of those damned formats.
=head1 BUGS
HARNESS_COMPILE_TEST currently assumes it's run from the Perl source
directory.
Please use the CPAN bug ticketing system at L<http://rt.cpan.org/>.
You can also mail bugs, fixes and enhancements to
C<< <bug-test-harness >> at C<< rt.cpan.org> >>.
=head1 COPYRIGHT
Copyright 2002-2005
by Michael G Schwern C<< <schwern at pobox.com> >>,
Andy Lester C<< <andy at petdance.com> >>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See L<http://www.perl.com/perl/misc/Artistic.html>.
=cut