NAME
HTTP::WebTest::ReportPlugin - Base class for HTTP::WebTest report plugins.
SYNOPSIS
Not applicable.
DESCRIPTION
This is subclass of HTTP::WebTest. HTTP::WebTest report plugin classes can subclass this class. It handles some test parameters common to report plugins by providing implementation of method print. See below.
TEST PARAMETERS
output_ref
GLOBAL PARAMETER
A reference on scalar which accumulates text of test report. If this test parameter is specified then value of test parameter fh_out is ignore.
This parameter can be used only when passing the test parameters as arguments from a calling Perl script.
fh_out
GLOBAL PARAMETER
A filehandle (or anything else that supports print) to use for test report output. This parameter is ignored if test parameter output_ref is specified also.
This parameter can be used only when passing the test parameters as arguments from a calling Perl script.
mail_addresses
GLOBAL PARAMETER
A list of e-mail addresses where report will be send (if sending report is enabled with mail test parameter).
GLOBAL PARAMETER
Option to e-mail output to one or more addresses specified by mail_addresses test parameter.
all
Send e-mail containing test results.
errors
Send e-mail only if one or more tests fails.
no
Do not send e-mail.
Default value
no
mail_server
GLOBAL PARAMETER
Fully-qualified name of of the mail server (e.g., mailhost.mycompany.com).
Default value
localhost
mail_from
GLOBAL PARAMETER
Sets From: header for test report e-mails.
Default Value
Name of user under which test script runs.
CLASS METHODS
test_output ()
Returns
Returns a reference to buffer which stores copy of test output.
print (@array)
Prints data in <@array> either into string (if test parameter output_ref is set) or to some filehandle (if test parameter fh_out is set) or to standard output.
Also stores this data into buffer accessible via method test_output.
start_tests ()
This method is called by HTTP::WebTest at the begin of test run. Its implementation in this class inits output buffer for test report.
If you redefine this method in subclass be sure to call it in new method:
sub start_tests {
my $self = shift;
$self->SUPER::start_tests;
# your code here
....
}end_tests ()
This method is called by HTTP::WebTest at the end of test run. Its implementation in this class can email test report according test parameters mail***.
If you redefine this method in subclass be sure to call it in new method:
sub end_tests {
my $self = shift;
# your code here
....
$self->SUPER::end_tests;
}COPYRIGHT
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.
SEE ALSO
2 POD Errors
The following errors were encountered while parsing the POD:
- Around line 84:
You forgot a '=back' before '=head3'
- Around line 88:
=back without =over