The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

 Test::Cookbook - Write your tests as cookbooks

SYNOPSIS

With your test formatted as a cookbook in t/005_cookbook.t

        $> ./Build test
        
        $> ./Build test --test_files t/005_cookbook.t
        
        $> prove t/005_cookbook.t
        
        $> runtests t/005_cookbook.t
        
        $> pod_tested.pl -i t/005_cookbook.t -o cookbook.pod

DESCRIPTION

This module is wrapper around POD::Tested. POD::Tested let's you write POD containing tests. I use it mainly to write cookbooks with the ability to check the cookbook and generate part of it.

I started by writing tests, then I copied the tests into the cookbook. Then it hit me that both could be the same. That I could write my tests as cookbooks.

These are the advantages when writing your tests as cookbooks:

  • single file to manipulate, no copy/paste and the errors associated with it

  • your tests become much easier to read because they must be documented

  • you can manually generate cookbooks from your tests

  • you can generate cookbooks when your tests are run (not yet implemented)

  • design and document your modules in the tests

DOCUMENTATION

SUBROUTINES/METHODS

import

This is automatically called for you by Perl

FILTER

This is automatically called for you by Perl

BUGS AND LIMITATIONS

None so far.

AUTHOR

        Khemir Nadim ibn Hamouda
        CPAN ID: NKH
        mailto:nadim@khemir.net

LICENSE AND COPYRIGHT

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

SUPPORT

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

    perldoc Test::Cookbook

You can also look for information at:

SEE ALSO

POD::Tested