GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TEST::YAML::VALID (3)

.ds Aq ’

NAME

Test::YAML::Valid - Test for valid YAML

CONTENTS

VERSION

Version 0.04

SYNOPSIS

This module lets you easily test the validity of YAML:



    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 YAML by passing -Syck 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 -Syck option, since it’s an optional prerequisite to this module. If it’s requested but not found, a warning will be issued and YAML will be used instead.

As of version 0.04, you can use any module you want in the same way; -Tiny for YAML::Tiny and -XS for YAML::XS.

EXPORT

o yaml_string_ok
o yaml_file_ok
o yaml_files_ok

FUNCTIONS

    yaml_string_ok($yaml, [$message])

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

    yaml_file_ok($filename, [$message])

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

    yaml_files_ok($file_glob_string, [$message])

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

Returns a list of all loaded YAML;

AUTHOR

Jonathan Rockway, <jrockway at cpan.org>

BUGS

Please report any bugs or feature requests to bug-test-yaml-valid at rt.cpan.org, 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.

SUPPORT

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



    perldoc Test::YAML::Valid



You can also look for information at:
o AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/Test-YAML-Valid>

o CPAN Ratings

<http://cpanratings.perl.org/d/Test-YAML-Valid>

o RT: CPAN’s request tracker

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-YAML-Valid>

o Search CPAN

<http://search.cpan.org/dist/Test-YAML-Valid>

ACKNOWLEDGEMENTS

Stevan Little <stevan.little@iinteractive.com> contributed yaml_files_ok and some more tests.

COPYRIGHT & LICENSE

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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TEST::YAML::VALID (3) 2010-01-09

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.