Test::YAML::Valid (3pm)

Version 0.04

This module lets you easily test the validity of \s-1YAML:\s0

    use Test::More tests => 3;
    use Test::YAML::Valid;

    yaml_string_ok(YAML::Dump({foo => 'bar'}), 'YAML generates good YAML?');
    yaml_string_ok('this is not YAML, is it?', 'This one will fail');
    yaml_file_ok('/path/to/some/YAML', '/path/to/some/YAML is YAML');
    yaml_files_ok('/path/to/YAML/files/*', 'all YAML files are valid');

You can also test with YAML::Syck instead of \s-1YAML\s0 by passing \*(C`-Syck\*(C' in the import list:

use Test::YAML::Valid qw(-Syck); yaml_string_ok(...); # uses YAML::Syck::Load instead of YAML::Load

It's up to you to make sure you have YAML::Syck if you specify the \*(C`-Syck\*(C' option, since it's an optional prerequisite to this module. If it's requested but not found, a warning will be issued and \s-1YAML\s0 will be used instead.

As of version 0.04, you can use any module you want in the same way; \*(C`-Tiny\*(C' for YAML::Tiny and \*(C`-XS\*(C' for \s-1YAML::XS\s0.

• yaml_string_ok

• yaml_file_ok

• yaml_files_ok

yaml_string_ok($yaml, [$message])

Test will pass if $yaml contains valid \s-1YAML\s0 (according to \s-1YAML\s0.pm) and fail otherwise. Returns the result of loading the \s-1YAML\s0.

yaml_file_ok($filename, [$message])

Test will pass if $filename is a valid \s-1YAML\s0 file (according to \s-1YAML\s0.pm) and fail otherwise. Returns the result of loading the \s-1YAML\s0.

yaml_files_ok($file_glob_string, [$message])

Test will pass if all files matching the glob $file_glob_string contain valid \s-1YAML\s0. If a file is not valid, the test will fail and no further files will be examined.

Returns a list of all loaded \s-1YAML\s0;

Jonathan Rockway, \*(C`<jrockway at cpan.org>\*(C'

Please report any bugs or feature requests to \*(C`bug-test-yaml-valid at rt.cpan.org\*(C', or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-YAML-Valid>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

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

perldoc Test::YAML::Valid

You can also look for information at:

• AnnoCPAN: Annotated \s-1CPAN\s0 documentation <http://annocpan.org/dist/Test-YAML-Valid>

• \s-1CPAN\s0 Ratings <http://cpanratings.perl.org/d/Test-YAML-Valid>

• \s-1RT:\s0 \s-1CPAN\s0's request tracker <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-YAML-Valid>

• Search \s-1CPAN\s0 <http://search.cpan.org/dist/Test-YAML-Valid>

Stevan Little \*(C`<[email protected]>\*(C' contributed \*(C`yaml_files_ok\*(C' and some more tests.

Copyright 2007 Jonathan Rockway, all rights reserved.

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