view release on metacpan or  search on metacpan

bin/simple_report  view on Meta::CPAN

C<simple_report> is a TAP filter: it reads TAP output from its standard input, and
creates a compact report as to

=over 4

=item * number of tests run

=item * number of tests passed

=item * number of tests failed

=item * number of tests skipped

=item * number of TODO tests (and number unexpectedly passing, if any)

=back

If you want to see the test comments from the tests which failed, add C<--verbose>
(or C<-v> for the lazy) to get a one-line printout of the failing (and 
unexpectedly-succeeding) tests as well.

If you want to see all of the diag messages as well, specify C<-v -v> (that's
I<two> C<--verbose> options). 

If you've installed C<WWW::Mechanize::Plugin::Snapshot> and snapshots were 
taken, a one-line diag will be printed showing you where the snapshot was 
stored.

If you're running simple_report as part of a pipe from simple_scan, you may
want to use the C<-s> option. This outputs a status message each time another
test runs, culminating in the standard reports that simple_report outputs. 
The status messages all begin with '# ', so they're easy to filter out of
your final output if you only want the report output.

=head1 INTERFACE

See the C<DESCRIPTION> section.

=head1 DIAGNOSTICS

If you do not specify a test name as the first argument, C<UNNAMED_TEST>
is assumed.

Output will indicate no tests were run if the input is not valid TAP:

  > perldoc simple_report | simple_report
  UNNAMED_TEST: tests=0, ok=0, failed=0, skipped=0, todo=0

=head1 CONFIGURATION AND ENVIRONMENT

No config files or environment variables used.

=head1 DEPENDENCIES

Test::Harness, simple_scan 

=head1 INCOMPATIBILITIES

None known.

=head1 BUGS AND LIMITATIONS

None reported.

=head1 AUTHOR

Joe McMahon C<< <mcmahon@yahoo-inc.com> >>

=head1 LICENSE AND COPYRIGHT

Copyright (c) 2005, Yahoo! and Joe McMahon. All rights reserved.

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

=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CON-
SEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFT-
WARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER
OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.