| 1 | package Test::Chimps; | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | Test::Chimps - Collaborative Heterogeneous Infinite Monkey Perfectionification Service | ||
| 6 | |||
| 7 | =head1 VERSION | ||
| 8 | |||
| 9 | Version 0.07 | ||
| 10 | |||
| 11 | =cut | ||
| 12 | |||
| 13 | our $VERSION = '0.07'; | ||
| 14 | |||
| 15 | =head1 SYNOPSIS | ||
| 16 | |||
| 17 | Why run tests yourself? Let an infinite number of monkeys do it | ||
| 18 | for you! Take the monkey work out of testing! Remove the monkey | ||
| 19 | wrench from your development process! Alright, I'm done. Sorry | ||
| 20 | about that. I got a little carried away... | ||
| 21 | |||
| 22 | The Collaborative Heterogeneous Infinite Monkey Perfectionification | ||
| 23 | Service (CHIMPS) is a generalized testing framework designed to | ||
| 24 | make integration testing easy. You use L<Test::Chimps::Server> to | ||
| 25 | create your CGI script for viewing and submitting reports, and you | ||
| 26 | use L<Test::Chimps::Client> for submitting reports. You will find | ||
| 27 | some scripts in the examples directory which should get you | ||
| 28 | started. | ||
| 29 | |||
| 30 | =head1 PHILOSOPHY | ||
| 31 | |||
| 32 | Tests are good. Testing is easy thanks to modules like | ||
| 33 | L<Test::Simple> and L<Test::More>. However, it's easy to forget to | ||
| 34 | run C<make test> every time you commit. Worse, you might have | ||
| 35 | forgotten to add a file that will cause tests to fail on a freshly | ||
| 36 | checked out copy. Additionally, your tests might only pass on your | ||
| 37 | version of perl or with specific module versions. | ||
| 38 | |||
| 39 | Chimps aims to solve these problems. However, it tries to make as | ||
| 40 | few assumptions about how your integration testing architecture | ||
| 41 | should work as possible. Want to allow anyone to submit smoke | ||
| 42 | reports? Just write a wrapper around C<Test::Chimps::Client>. | ||
| 43 | Want to have dedicated build hosts that continuously check out and | ||
| 44 | test projects? Just use C<Test::Chimps::Client::Poller>. Whatever | ||
| 45 | your integration testing architecture, you can probably use Chimps | ||
| 46 | to simplify the process. | ||
| 47 | |||
| 48 | =head1 REPORT VARIABLES | ||
| 49 | |||
| 50 | Chimps does not make any assumptions about what kind of data is | ||
| 51 | carried in your smoke reports. These data are called I<report | ||
| 52 | variables>. When creating a server with C<Test::Chimps::Server>, | ||
| 53 | you can specify which variables must be submitted with each | ||
| 54 | report. Unfortunately, if we I<never> made any assumptions, it | ||
| 55 | would be hard to write any utility code. Therefore, several Chimps | ||
| 56 | modules have documentation sections describing variables that it | ||
| 57 | assumes are passed to the server. These are probably pretty | ||
| 58 | reasonable assumptions for most set ups. However, if they do not | ||
| 59 | meet your needs, it should be fairly easy to subclass the | ||
| 60 | appropriate classes and add the functionality and variables you | ||
| 61 | require. | ||
| 62 | |||
| 63 | =head1 AUTHOR | ||
| 64 | |||
| 65 | Zev Benjamin, C<< <zev at cpan.org> >> | ||
| 66 | |||
| 67 | =head1 BUGS | ||
| 68 | |||
| 69 | Please report any bugs or feature requests to | ||
| 70 | C<bug-test-chimps at rt.cpan.org>, or through the web interface at | ||
| 71 | L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Chimps>. | ||
| 72 | I will be notified, and then you'll automatically be notified of progress on | ||
| 73 | your bug as I make changes. | ||
| 74 | |||
| 75 | =head1 SUPPORT | ||
| 76 | |||
| 77 | You can find documentation for this module with the perldoc command. | ||
| 78 | |||
| 79 | perldoc Test::Chimps | ||
| 80 | |||
| 81 | You can also look for information at: | ||
| 82 | |||
| 83 | =over 4 | ||
| 84 | |||
| 85 | =item * Mailing list | ||
| 86 | |||
| 87 | Chimps has a mailman mailing list at | ||
| 88 | L<chimps@bestpractical.com>. You can subscribe via the web | ||
| 89 | interface at | ||
| 90 | L<http://lists.bestpractical.com/cgi-bin/mailman/listinfo/chimps>. | ||
| 91 | |||
| 92 | =item * AnnoCPAN: Annotated CPAN documentation | ||
| 93 | |||
| 94 | L<http://annocpan.org/dist/Test-Chimps> | ||
| 95 | |||
| 96 | =item * CPAN Ratings | ||
| 97 | |||
| 98 | L<http://cpanratings.perl.org/d/Test-Chimps> | ||
| 99 | |||
| 100 | =item * RT: CPAN's request tracker | ||
| 101 | |||
| 102 | L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Chimps> | ||
| 103 | |||
| 104 | =item * Search CPAN | ||
| 105 | |||
| 106 | L<http://search.cpan.org/dist/Test-Chimps> | ||
| 107 | |||
| 108 | =back | ||
| 109 | |||
| 110 | =head1 COPYRIGHT & LICENSE | ||
| 111 | |||
| 112 | Copyright 2006 Best Practical Solutions. | ||
| 113 | |||
| 114 | This program is free software; you can redistribute it and/or modify it | ||
| 115 | under the same terms as Perl itself. | ||
| 116 | |||
| 117 | =cut | ||
| 118 | |||
| 119 | 1; | ||
| 120 |