[Rt-commit] r5457 - in Test-Chimps: trunk trunk/lib/Test

[zev at bestpractical.com]

Author: zev
Date: Fri Jun 23 18:38:35 2006
New Revision: 5457

Added:
   Test-Chimps/trunk/TODO
Modified:
   Test-Chimps/   (props changed)
   Test-Chimps/trunk/lib/Test/Chimps.pm

Log:
 r9742 at galvatron:  zev | 2006-06-23 18:38:29 -0400
 more documentation


Added: Test-Chimps/trunk/TODO
==============================================================================
--- (empty file)
+++ Test-Chimps/trunk/TODO	Fri Jun 23 18:38:35 2006
@@ -0,0 +1,12 @@
+* add options to to Poll
+* move Poll to SVN::Client
+* document variable requirements
+* move Server to a db
+* limit display
+* move repo
+* change category/subcategory handling
+* add command line switches to binaries?
+* fix ENV handling
+* add HTML::Scrubber
+* allow single test comparison back through revisions
+* add option defaults to Poller
\ No newline at end of file

Modified: Test-Chimps/trunk/lib/Test/Chimps.pm
==============================================================================
--- Test-Chimps/trunk/lib/Test/Chimps.pm	(original)
+++ Test-Chimps/trunk/lib/Test/Chimps.pm	Fri Jun 23 18:38:35 2006
@@ -25,6 +25,39 @@
 some scripts in the examples directory which should get you
 started.
 
+=head1 PHILOSOPHY
+
+Tests are good.  Testing is easy thanks to modules like
+L<Test::Simple> and L<Test::More>.  However, it's easy to forget to
+run C<make test> every time you commit.  Worse, you might have
+forgotten to add a file that will cause tests to fail on a freshly
+checked out copy.  Additionally, your tests might only pass on your
+version of perl or with specific module versions.
+
+Chimps aims to solve these problems.  However, it tries to make as
+few assumptions about how your integration testing architecture
+should work as possible.  Want to allow anyone to submit smoke
+reports?  Just write a wrapper around C<Test::Chimps::Client>.
+Want to have dedicated build hosts that continuously check out and
+test projects?  Just use C<Test::Chimps::Client::Poller>.  Whatever
+your integration testing architecture, you can probably use Chimps
+to simplify the process.
+
+=head1 REPORT VARIABLES
+
+Chimps does not make any assumptions about what kind of data is
+carried in your smoke reports.  These data are called I<report
+variables>.  When creating a server with C<Test::Chimps::Server>,
+you can specify which variables must be submitted with each
+report.  Unfortunately, if we I<never> made any assumptions, it
+would be hard to write any utility code.  Therefore, several Chimps
+modules have documentation sections describing variables that it
+assumes are passed to the server.  These are probably pretty
+reasonable assumptions for most set ups.  However, if they do not
+meet your needs, it should be fairly easy to subclass the
+appropriate classes and add the functionality and variables you
+require.
+
 =head1 AUTHOR
 
 Zev Benjamin, C<< <zev at cpan.org> >>