The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-SimpleScan-3.01
River stage one • 6 direct dependents • 6 total dependents
++
/ simple_report

NAME

simple_report - Ultra-compact TAP summary

SYNOPSIS

  # For a one-line summary:
  % simple_scan <ss.in 2>&1 | simple_report MyLabel
  MyLabel: tests=9, ok=8, failed=1, skipped=1, todo=2 (1 UNEXPECTEDLY SUCCEEDED)

  # For the summary plus a one-line comment for failed 
  # tests and unexpectedly-suceeding TODO tests:
  % simple_scan <ss.in 2>&1 | simple_report -v MyLabel
  MyLabel: tests=9, ok=8, failed=1, skipped=1, todo=2 (1 UNEXPECTEDLY SUCCEEDED)
  F 7 Broken test
  T 9 unexpected success

  # For the summary plus one-line comment plus diagnostics:
  % simple_scan <ss.in 2>&1 | simple_report -v -v MyLabel
  MyLabel: tests=9, ok=8, failed=1, skipped=1, todo=2 (1 UNEXPECTEDLY SUCCEEDED)
  F 7 Deliberately broken test (zorch) [http://zorch.mysite.com/] [/fnord/ should match]
  #   Failed test 'Deliberately broken test (zorch) [http://zorch.mysite.com] [/fnord/ should match]'
  #   in /home/y/lib/perl5/site_perl/5.6.1/Test/WWW/Simple.pm at line 65.
  #          got: "<!doctype html public "-//W3C//DTD HTML 4.01//EN" "...
  #       length: 37943
  #     doesn't match '(?-xism:fnord)'
  T 9 unexpected success (glonk) [http://glonk.mysite.com/] [/sproing/ should match]

DESCRIPTION

Raw TAP output is often lengthy, making it difficult to spot tests that have failed. simple_report is a TAP filter: it reads TAP output from its standard input, and creates a compact report as to

  • number of tests run

  • number of tests passed

  • number of tests failed

  • number of tests skipped

  • number of TODO tests (and number unexpectedly passing, if any)

If you want to see the test comments from the tests which failed, add --verbose (or -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 -v -v (that's two --verbose options).

If you've installed 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 -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.

INTERFACE

See the DESCRIPTION section.

DIAGNOSTICS

If you do not specify a test name as the first argument, 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

CONFIGURATION AND ENVIRONMENT

No config files or environment variables used.

DEPENDENCIES

Test::Harness, simple_scan

INCOMPATIBILITIES

None known.

BUGS AND LIMITATIONS

None reported.

AUTHOR

Joe McMahon <mcmahon@yahoo-inc.com>

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.

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.