[Http-webtest-commits] CVS: HTTP-WebTest/lib/HTTP WebTest.pm.in,1.9,1.10

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/http-webtest/HTTP-WebTest/lib/HTTP
In directory usw-pr-cvs1:/tmp/cvs-serv6771/lib/HTTP

Modified Files:
	WebTest.pm.in 
Log Message:
Minor POD docs tweaks

Index: WebTest.pm.in
===================================================================
RCS file: /cvsroot/http-webtest/HTTP-WebTest/lib/HTTP/WebTest.pm.in,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** WebTest.pm.in	8 Apr 2002 21:51:57 -0000	1.9
--- WebTest.pm.in	12 May 2002 13:35:36 -0000	1.10
***************
*** 32,47 ****
  =head2 Beta software warning

! THIS IS A BETA VERSION THAT IS A REWRITE OF VERSION 1.07 AND IS PROBABLY NOT
! AS WELL DEBUGGED AS VERSION 1.07. Version 1.07 can be downloaded at
! http://search.cpan.org/search?dist=HTTP-WebTest-1.07

  =head2 Introduction

  This module runs tests on remote URLs or local web files containing
! Perl/JSP/HTML/JavaScript/etc. and generates a detailed test
! report. This module can be used "as-is" or its functionality can be
! extended using plugins. Plugins can define test types and provide
! additional report capabilities. This module comes with a set of
! default plugins but can be easily extended with third party plugins.

  The L<wt|wt> script is provided for running C<HTTP::WebTest> from the
--- 32,47 ----
  =head2 Beta software warning

! THIS IS A BETA VERSION THAT IS A REWRITE OF VERSION 1.07 AND IS
! PROBABLY NOT AS WELL DEBUGGED AS VERSION 1.07.  Version 1.07 can be
! downloaded at http://search.cpan.org/search?dist=HTTP-WebTest-1.07

  =head2 Introduction

  This module runs tests on remote URLs or local web files containing
! Perl/JSP/HTML/JavaScript/etc. and generates a detailed test report.
! This module can be used "as-is" or its functionality can be extended
! using plugins.  Plugins can define test types and provide additional
! report capabilities.  This module comes with a set of default plugins
! but can be easily extended with third party plugins.

  The L<wt|wt> script is provided for running C<HTTP::WebTest> from the
***************
*** 49,68 ****

  The test specifications can be read from a parameter file in wtscript
! format or input as method arguments. If you are testing a local file,
  Apache is started on a private/dynamic port with a configuration file
  in a temporary directory.

  The test results can be displayed on the terminal, directed to a file,
! stored in a scalar variable. The test results can also be emailed.
  The report can be modified and extended using report plugins.

  Each URL/web file is tested by fetching it from the web server using a
! local instance of an HTTP user agent. The basic test is simply whether
! or not the fetch was successful. You may also test using literal
! strings or regular expressions that are either required to exist or
! forbidden to exist in the fetched page. You may also specify tests for
! the minimum and maximum number of bytes in the returned page. You may
! also specify tests for the minimum and maximum web server response
! time.

  Data flow for C<HTTP::WebTest> using a remote URL:
--- 49,68 ----

  The test specifications can be read from a parameter file in wtscript
! format or input as method arguments.  If you are testing a local file,
  Apache is started on a private/dynamic port with a configuration file
  in a temporary directory.

  The test results can be displayed on the terminal, directed to a file,
! stored in a scalar variable.  The test results can also be emailed.
  The report can be modified and extended using report plugins.

  Each URL/web file is tested by fetching it from the web server using a
! local instance of an HTTP user agent.  The basic test is simply
! whether or not the fetch was successful.  You may also test using
! literal strings or regular expressions that are either required to
! exist or forbidden to exist in the fetched page.  You may also specify
! tests for the minimum and maximum number of bytes in the returned
! page.  You may also specify tests for the minimum and maximum web
! server response time.

  Data flow for C<HTTP::WebTest> using a remote URL:
***************
*** 115,122 ****

  This module has complex functionality, but using it to run simple
! tests is simple. Create a file of test parameters in the
  L<wtscript format|Running HTTP::WebTest using a parameter file> and use the
  L<wt|wt> program to process the file using the command C<wt
! filename>. The only required parameters are C<test_name> and C<url>.

  This document describes:
--- 115,122 ----

  This module has complex functionality, but using it to run simple
! tests is simple.  Create a file of test parameters in the
  L<wtscript format|Running HTTP::WebTest using a parameter file> and use the
  L<wt|wt> program to process the file using the command C<wt
! filename>.  The only required parameters are C<test_name> and C<url>.

  This document describes:
***************
*** 126,136 ****
  =item *

! How tests can be specified. See section L<TEST SPECIFICATION|TEST
! SPECIFICATION>.

  =item *

  All test parameters supported by core C<HTTP::WebTest>
! plugins. See section L<TEST PARAMETERS|TEST PARAMETERS>.

  =back
--- 126,136 ----
  =item *

! How tests can be specified.  See section
! L<TEST SPECIFICATION|TEST SPECIFICATION>.

  =item *

  All test parameters supported by core C<HTTP::WebTest>
! plugins.  See section L<TEST PARAMETERS|TEST PARAMETERS>.

  =back
***************
*** 181,186 ****

  If you are running dozens of tests, you may want to divide them into
! several parameter files. This will organize the tests and reduce the
! size of the output and e-mail messages. However, cookies passed to or
  received from the web server(s) are not shared between tests in
  different parameter files.
--- 181,186 ----

  If you are running dozens of tests, you may want to divide them into
! several parameter files.  This will organize the tests and reduce the
! size of the output and e-mail messages.  However, cookies passed to or
  received from the web server(s) are not shared between tests in
  different parameter files.
***************
*** 188,200 ****
  =head3 File format

! The wtscript file is a text file containing global parameters and 
! test blocks containing test block parameters.  A test block begins with
! a test_name parameter and ends with an end_test directive.  The order of
  the parameters and test blocks is arbitrary.

  Test block parameters MUST occur between a test_name parameter and an
! end_test directive. (Test block parameters affect only an individual
  test.) Global parameters must NOT occur between a test_name parameter
! and an end_test directive. (This requirement does not apply to
  certain parameters that are both global and test block parameters.)

--- 188,200 ----
  =head3 File format

! The wtscript file is a text file containing global parameters and test
! blocks containing test block parameters.  A test block begins with a
! test_name parameter and ends with an end_test directive.  The order of
  the parameters and test blocks is arbitrary.

  Test block parameters MUST occur between a test_name parameter and an
! end_test directive.  (Test block parameters affect only an individual
  test.) Global parameters must NOT occur between a test_name parameter
! and an end_test directive.  (This requirement does not apply to
  certain parameters that are both global and test block parameters.)

***************
*** 259,263 ****

  Also it is possible to specify Perl code instead of scalar, instead of
! list parameter value or instead of element of list paramater. Curly
  brackets are used to denote Perl code inside wtscript files.  This
  code will be evaluated during test run.
--- 259,263 ----

  Also it is possible to specify Perl code instead of scalar, instead of
! list parameter value or instead of element of list paramater.  Curly
  brackets are used to denote Perl code inside wtscript files.  This
  code will be evaluated during test run.
***************
*** 265,269 ****
  C<HTTP::WebTest> compiles this Perl code as anonymous subroutines
  which are called during test run when value of corresponding test
! parameters are required. When these subroutines are called
  C<HTTP::WebTest> object is passed to them.

--- 265,269 ----
  C<HTTP::WebTest> compiles this Perl code as anonymous subroutines
  which are called during test run when value of corresponding test
! parameters are required.  When these subroutines are called
  C<HTTP::WebTest> object is passed to them.

***************
*** 289,295 ****
  The parameters below specify tests of a local file and a remote URL.
  The tests specified by the C<text_forbid> parameter apply to both the
! "RayCosoft home page" and the "Yahoo home page" tests. Hence, if
  either returned page contains one of the case-insensitive strings in
! text_forbid, the test fails. If any test fails or the fetch of the URL
  fails, an e-mail will be sent to te...@un....

--- 289,295 ----
  The parameters below specify tests of a local file and a remote URL.
  The tests specified by the C<text_forbid> parameter apply to both the
! "RayCosoft home page" and the "Yahoo home page" tests.  Hence, if
  either returned page contains one of the case-insensitive strings in
! text_forbid, the test fails.  If any test fails or the fetch of the URL
  fails, an e-mail will be sent to te...@un....

***************
*** 322,326 ****

  The parameters below specify a test of a local file containing Perl
! code using the L<Apache::ASP|Apache::ASP> module. The C<includes.htm>
  file requires five include files and two Perl modules, which are
  copied using the C<include_file_path> parameter.
--- 322,326 ----

  The parameters below specify a test of a local file containing Perl
! code using the L<Apache::ASP|Apache::ASP> module.  The C<includes.htm>
  file requires five include files and two Perl modules, which are
  copied using the C<include_file_path> parameter.
***************
*** 352,363 ****
  can be defined in form of array of hashes.

! Each hash in array defines tests for one URL or local web file. Keys
  in hashes are test parameter names and values in hashes are values of
! test parameters. Additionally, optional global test parameters can be
  passed in a hash passed as the second argument.

  Instead of test parameter values subroutine references can be
! specified. Referenced subroutines are called during test run when
! values of corresponding test parameters are required. When called
  these subroutines get C<HTTP::WebTest> object passed to them.

--- 352,363 ----
  can be defined in form of array of hashes.

! Each hash in array defines tests for one URL or local web file.  Keys
  in hashes are test parameter names and values in hashes are values of
! test parameters.  Additionally, optional global test parameters can be
  passed in a hash passed as the second argument.

  Instead of test parameter values subroutine references can be
! specified.  Referenced subroutines are called during test run when
! values of corresponding test parameters are required.  When called
  these subroutines get C<HTTP::WebTest> object passed to them.

***************
*** 457,461 ****

  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.

--- 457,461 ----

  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.

***************
*** 470,474 ****

  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.

--- 470,474 ----

  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.

***************
*** 486,491 ****

  Most parameters can be used both as global and as test block
! parameters. If you specify such parameter as global its value applies
! to all test blocks. Value of parameter specified as global can be
  overriden individually in each test block by specifying this parameter
  with different values in test blocks.
--- 486,491 ----

  Most parameters can be used both as global and as test block
! parameters.  If you specify such parameter as global its value applies
! to all test blocks.  Value of parameter specified as global can be
  overriden individually in each test block by specifying this parameter
  with different values in test blocks.
***************
*** 497,501 ****

  Content of this section should be autogenerated from POD documentation
! in plugin modules. Everything from this point till next =cut will be
  replaced with autogenerated documentation.

--- 497,501 ----

  Content of this section should be autogenerated from POD documentation
! in plugin modules.  Everything from this point till next =cut will be
  replaced with autogenerated documentation.

***************
*** 513,517 ****

  Content of this section should be autogenerated from POD documentation
! in Apache plugin module. Everything from this point till next =cut
  will be replaced with autogenerated documentation.

--- 513,517 ----

  Content of this section should be autogenerated from POD documentation
! in Apache plugin module.  Everything from this point till next =cut
  will be replaced with autogenerated documentation.

***************
*** 526,530 ****

  The module's HTTP requests time out after 3 minutes (the default value
! for L<LWP::UserAgent|LWP::UserAgent>). If the C<file_path> parameter is
  specified, Apache must be installed.

--- 526,530 ----

  The module's HTTP requests time out after 3 minutes (the default value
! for L<LWP::UserAgent|LWP::UserAgent>).  If the C<file_path> parameter is
  specified, Apache must be installed.

***************
*** 533,537 ****
  Please email bug reports, suggestions, questions, etc. to
  C<HTTP::WebTest> maillist
! C<htt...@li...>. You can sign up at
  http://lists.sourceforge.net/lists/listinfo/http-webtest-general.

--- 533,537 ----
  Please email bug reports, suggestions, questions, etc. to
  C<HTTP::WebTest> maillist
! C<htt...@li...>.  You can sign up at
  http://lists.sourceforge.net/lists/listinfo/http-webtest-general.

***************
*** 542,557 ****

  Ilya Martynov <il...@ma...> made rewrite of
! C<HTTP::WebTest>. New version of C<HTTP::WebTest> have introduced
  extended API and plugin based architecture.

! Please don't email authors directly. Use C<HTTP::WebTest> maillists.

  =head1 COPYRIGHT

! Copyright (c) 2000-2001 Richard Anderson. All rights reserved.

! Copyright (c) 2001,2002 Ilya Martynov. All rights reserved.

! This module is free software. It may be used, redistributed and/or
  modified under the terms of the Perl Artistic License.

--- 542,557 ----

  Ilya Martynov <il...@ma...> made rewrite of
! C<HTTP::WebTest>.  New version of C<HTTP::WebTest> have introduced
  extended API and plugin based architecture.

! Please don't email authors directly.  Use C<HTTP::WebTest> maillists.

  =head1 COPYRIGHT

! Copyright (c) 2000-2001 Richard Anderson.  All rights reserved.

! Copyright (c) 2001,2002 Ilya Martynov.  All rights reserved.

! This module is free software.  It may be used, redistributed and/or
  modified under the terms of the Perl Artistic License.