NAME

NAME
TAP::Harness::Archive - Create an archive of TAP test results

SYNOPSIS
use TAP::Harness::Archive;
my $harness = TAP::Harness::Archive->new(\%args);
$harness->runtests(@tests);

DESCRIPTION
This module is a direct subclass of TAP::Harness and behaves in exactly
the same way except for one detail. In addition to outputting a running
progress of the tests and an ending summary it can also capture all of
the raw TAP from the individual test files or streams into an archive
file (".tar" or ".tar.gz").

METHODS
All methods are exactly the same as our base TAP::Harness except for the
following.

new
In addition to the options that TAP::Harness allow to this method, we
also allow the following:

archive
This is the name of the archive file to generate. We use
Archive::Tar in the background so we only support ".tar" and
".tar.gz" archive file formats. This can optionally be an existing
directory that will have the TAP archive's contents deposited
therein without any file archiving (no Archive::Tar involved).

extra_files
This is an array reference to extra files that you want to include
in the TAP archive but which are not TAP files themselves. This is
useful if you want to include some log files that contain useful
information about the test run.

extra_properties
This is a hash reference of extra properties that you've collected
during your test run. Some things you might want to include are the
Perl version, the system's architecture, the operating system, etc.

runtests
Takes the same arguments as TAP::Harness's version and returns the same
thing (a TAP::Parser::Aggregator object). The only difference is that in
addition to the normal test running and progress output we also create
the TAP Archive when it's all done.

aggregator_from_archive
This class method will return a TAP::Parser::Aggregator object when
given a TAP Archive to open and parse. It's pretty much the reverse of
creating a TAP Archive from using "new" and "runtests".

It takes a hash of arguments which are as follows:

archive
The path to the archive file. This can also be a directory if you
created the archive as a directory. This is required.

parser_callbacks
This is a hash ref containing callbacks for the TAP::Parser objects
that are created while parsing the TAP files. See the TAP::Parser
documentation for details about these callbacks.

made_parser_callback
This callback is executed every time a new TAP::Parser object is
created. It will be passed the new parser object, the name of the
file to be parsed, and also the full (temporary) path of that file.

meta_yaml_callback
This is a subroutine that will be called if we find and parse a YAML
file containing meta information about the test run in the archive.
The structure of the YAML file will be passed in as an argument.

my $aggregator = TAP::Harness::Archive->aggregator_from_archive(
{
archive => 'my_tests.tar.gz',
parser_callbacks => {
plan => sub { warn "Nice to see you plan ahead..." },
unknown => sub { warn "Your TAP is bad!" },
},
made_parser_callback => sub {
my ($parser, $file, $full_path) = @_;
warn "$file is temporarily located at $full_path\n";
}

}
);

AUTHOR
Michael Peters, "<mpeters at plusthree.com>"

BUGS
Please report any bugs or feature requests to "bug-tap-harness-archive
at rt.cpan.org", or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=TAP-Harness-Archive>. I
will be notified, and then you'll automatically be notified of progress
on your bug as I make changes.

SUPPORT
You can find documentation for this module with the perldoc command.

perldoc TAP::Harness::Archive

You can also look for information at:

* AnnoCPAN: Annotated CPAN documentation
<http://annocpan.org/dist/TAP-Harness-Archive>

* CPAN Ratings
<http://cpanratings.perl.org/d/TAP-Harness-Archive>

* RT: CPAN's request tracker
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=TAP-Harness-Archive>

* Search CPAN
<http://search.cpan.org/dist/TAP-Harness-Archive>

ACKNOWLEDGEMENTS
* A big thanks to Plus Three, LP (<http://www.plusthree.com>) for
sponsoring my work on this module and other open source pursuits.
* Andy Armstrong

COPYRIGHT & LICENSE
Copyright 2007 Michael Peters, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.