|
From: Ilya M. <m_...@us...> - 2002-02-16 00:00:51
|
Update of /cvsroot/http-webtest/HTTP-WebTest/lib/HTTP
In directory usw-pr-cvs1:/tmp/cvs-serv13690/lib/HTTP
Modified Files:
WebTest.pm.in WebTest.pm
Log Message:
Add section PLUGINS to HTTP::WebTest docs
Index: WebTest.pm.in
===================================================================
RCS file: /cvsroot/http-webtest/HTTP-WebTest/lib/HTTP/WebTest.pm.in,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** WebTest.pm.in 12 Feb 2002 05:34:26 -0000 1.3
--- WebTest.pm.in 16 Feb 2002 00:00:46 -0000 1.4
***************
*** 369,372 ****
--- 369,452 ----
$webtest->run_tests($tests, $params);
+ =head1 PLUGIN MODULES
+
+ =head2 Core Plugin Modules
+
+ C<HTTP::WebTest> provides a number of core plugin modules which are
+ loaded by default:
+
+ =over 4
+
+ =item L<HTTP::WebTest::Plugin::Apache>
+
+ This plugin provides support for local web file test mode.
+
+ =item L<HTTP::WebTest::Plugin::ContentSizeTest>
+
+ This plugin provides size checks of HTTP response bodies.
+
+ =item L<HTTP::WebTest::Plugin::Cookies>
+
+ This plugin provides means to control sending and recieve cookies.
+
+ =item L<HTTP::WebTest::Plugin::DefaultReport>
+
+ Default test report plugin.
+
+ =item L<HTTP::WebTest::Plugin::Loader>
+
+ This plugin allows to load external plugin modules.
+
+ =item L<HTTP::WebTest::Plugin::ResponseTimeTest>
+
+ This plugin provides support for response time tests.
+
+ =item L<HTTP::WebTest::Plugin::SetRequest>
+
+ This plugin initializes test HTTP requests.
+
+ =item L<HTTP::WebTest::Plugin::StatusTest>
+
+ This plugin checks HTTP response statuses.
+
+ =item L<HTTP::WebTest::Plugin::TextMatchTest>
+
+ This plugin provides test parameters which allow to check body of HTTP
+ responses.
+
+ =back
+
+ Information about test parameters supported by core plugins is
+ summarized below in section L<TEST PARAMETERS|TEST PARAMETERS>.
+
+ =head2 Other Plugin Modules Bundled With HTTP::WebTest
+
+ Following plugin modules come with HTTP::WebTest but they are not
+ loaded by default. They should be loaded using global test parameter
+ C<plugins> when needed.
+
+ =over 4
+
+ =item L<HTTP::WebTest::Plugin::HarnessReport>
+
+ This report plugin can generate L<Test::Harness|Test::Harness>
+ compatible test reports.
+
+ =item L<HTTP::WebTest::Plugin::Hooks>
+
+ This plugin allows to define callback test parameters which are
+ evaluated at specific time of L<HTTP::WebTest> test run. These test
+ parameters can define user-defined checks.
+
+ =back
+
+ See documentation on these modules for more information.
+
+ =head2 Writting Plugin Modules
+
+ L<perldoc HTTP::WebTest::Plugins|HTTP::WebTest::Plugins> contains
+ information needed for L<HTTP::WebTest|HTTP::WebTest> plugin
+ developers.
+
=head1 TEST PARAMETERS
Index: WebTest.pm
===================================================================
RCS file: /cvsroot/http-webtest/HTTP-WebTest/lib/HTTP/WebTest.pm,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** WebTest.pm 12 Feb 2002 13:09:18 -0000 1.4
--- WebTest.pm 16 Feb 2002 00:00:46 -0000 1.5
***************
*** 8,11 ****
--- 8,12 ----
# lib/HTTP/WebTest/Plugin/DefaultReport.pm
# lib/HTTP/WebTest/Plugin/HarnessReport.pm
+ # lib/HTTP/WebTest/Plugin/Hooks.pm
# lib/HTTP/WebTest/Plugin/Loader.pm
# lib/HTTP/WebTest/Plugin/ResponseTimeTest.pm
***************
*** 388,391 ****
--- 389,472 ----
$webtest->run_tests($tests, $params);
+ =head1 PLUGIN MODULES
+
+ =head2 Core Plugin Modules
+
+ C<HTTP::WebTest> provides a number of core plugin modules which are
+ loaded by default:
+
+ =over 4
+
+ =item L<HTTP::WebTest::Plugin::Apache>
+
+ This plugin provides support for local web file test mode.
+
+ =item L<HTTP::WebTest::Plugin::ContentSizeTest>
+
+ This plugin provides size checks of HTTP response bodies.
+
+ =item L<HTTP::WebTest::Plugin::Cookies>
+
+ This plugin provides means to control sending and recieve cookies.
+
+ =item L<HTTP::WebTest::Plugin::DefaultReport>
+
+ Default test report plugin.
+
+ =item L<HTTP::WebTest::Plugin::Loader>
+
+ This plugin allows to load external plugin modules.
+
+ =item L<HTTP::WebTest::Plugin::ResponseTimeTest>
+
+ This plugin provides support for response time tests.
+
+ =item L<HTTP::WebTest::Plugin::SetRequest>
+
+ This plugin initializes test HTTP requests.
+
+ =item L<HTTP::WebTest::Plugin::StatusTest>
+
+ This plugin checks HTTP response statuses.
+
+ =item L<HTTP::WebTest::Plugin::TextMatchTest>
+
+ This plugin provides test parameters which allow to check body of HTTP
+ responses.
+
+ =back
+
+ Information about test parameters supported by core plugins is
+ summarized below in section L<TEST PARAMETERS|TEST PARAMETERS>.
+
+ =head2 Other Plugin Modules Bundled With HTTP::WebTest
+
+ Following plugin modules come with HTTP::WebTest but they are not
+ loaded by default. They should be loaded using global test parameter
+ C<plugins> when needed.
+
+ =over 4
+
+ =item L<HTTP::WebTest::Plugin::HarnessReport>
+
+ This report plugin can generate L<Test::Harness|Test::Harness>
+ compatible test reports.
+
+ =item L<HTTP::WebTest::Plugin::Hooks>
+
+ This plugin allows to define callback test parameters which are
+ evaluated at specific time of L<HTTP::WebTest> test run. These test
+ parameters can define user-defined checks.
+
+ =back
+
+ See documentation on these modules for more information.
+
+ =head2 Writting Plugin Modules
+
+ L<perldoc HTTP::WebTest::Plugins|HTTP::WebTest::Plugins> contains
+ information needed for L<HTTP::WebTest|HTTP::WebTest> plugin
+ developers.
+
=head1 TEST PARAMETERS
***************
*** 871,874 ****
--- 952,990 ----
Any number less than C<max_rtime> (if C<max_rtime> is specified).
+
+ =head2 on_request
+
+ Value of this test parameter is ignored. However it is evaluted before
+ L<HTTP::WebTest> does a request to web page so it is useful to do some
+ initalization before the request.
+
+ =head3 Example
+
+ See example in L<HTTP::WebTest::Cookbook|HTTP::WebTest::Cookbook>.
+
+ =head2 on_response
+
+ This is list parameter which is treated as test result. It is evaluted
+ when L<HTTP::WebTest> gets a response for the test request.
+
+ It can be useful to define custom tests without writting new plugins
+ and/or it can be useful to run some code when L<HTTP::WebTest> got
+ some a response for the test request.
+
+ =head3 Allowed values
+
+ ( YESNO1, COMMENT1
+ YESNO2, COMMENT2
+ ....
+ YESNON, COMMENTN )
+
+ Here C<YESNO>, C<COMMENT> - is a test result. C<YESNO> - is either
+ C<yes> if test is successful or C<no> if it is not. C<COMMENT> is a
+ text of comment associated with this test.
+
+ =head3 Example
+
+ See example in L<HTTP::WebTest::Cookbook|HTTP::WebTest::Cookbook>.
+
=head2 output_ref
|
