NAME

Test::More::Diagnostic - Conditionally add YAML diagnostics to Test::More's output

VERSION

This document describes Test::More::Diagnostic version 0.2

SYNOPSIS

    use Test::More;              # DON'T PLAN
    use Test::More::Diagnostic;
    plan tests => 1;

Since people may not have Test::More::Diagnostic installed you may wish to do this:

    eval 'use Test::More::Diagnostic';
    diag "Test::More::Diagnostic not available' if $@;
  

DESCRIPTION

Upgrades Test::More's output to TAP version 13. See

  http://testanything.org/wiki/index.php/TAP_diagnostic_syntax

for more information about YAML diagnostics.

This module is completely experimental, kludgy and likely to fall out of favour once Test::More natively supports YAML diagnostics. Use at your own risk.

INTERFACE

To add YAML diagnostics to your test output:

    use Test::More;              # DON'T PLAN
    use Test::More::Diagnostic;
    plan tests => 1;

It's important that you don't attempt to plan before loading Test::More::Diagnostic. If you do the TAP version line will appear in the wrong place in the output.

caller

Overwridden from Test::Builder. Adjusts the stack depth to account for our intercept.

ok

Overwridden from Test::Builder. Adds basic YAML diagnostic output to failing tests.

CONFIGURATION AND ENVIRONMENT

Test::More::Diagnostic requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-test-more-diagnostic@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Andy Armstrong <andy@hexten.net>

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.

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 CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (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.