HTTP::WebTest::ReportPlugin - Subclass for HTTP::WebTest report plugins.
Not applicable.
This is a subclass of HTTP::WebTest. HTTP::WebTest report plugin classes can inherit from this class. It handles some test parameters common to report plugins by providing implementation of the method print.
print
GLOBAL PARAMETER
A reference to a scalar that accumulates text of test report. If this test parameter is specified then value of test parameter fh_out is ignore.
fh_out
This parameter can be used only when passing the test parameters as arguments from a calling Perl script.
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.
output_ref
Option to e-mail output to one or more addresses specified by mail_addresses test parameter.
mail_addresses
Sets Subject header for test report e-mails when all tests are passed successfully. In this string some character sequences have special meaning (see mail_failure_subject parameter for their description).
Subject
mail_failure_subject
Web tests succeeded
Sets Subject header for test report e-mails when some tests fail. In this string some character sequences have special meaning:
the number of failed tests
the number of successful tests
the total number of tests
replaced with single %
%
WEB TESTS FAILED! FOUND %f ERROR(S)
A list of e-mail addresses where report will be send (if sending report is enabled with mail test parameter).
mail
all
Send e-mail containing test results.
errors
Send e-mail only if one or more tests fails.
no
Do not send e-mail.
Fully-qualified name of of the mail server (e.g., mailhost.mycompany.com).
localhost
Sets From: header for test report e-mails.
Name of user under which test script runs.
Returns a reference to buffer that stores copy of test output.
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.
test_output
This method is called by HTTP::WebTest at the beginning of the test run. Its implementation in this class initializes the output buffer for the test report.
If you redefine this method in a subclass, be sure to call the superclass method in the new method:
sub start_tests { my $self = shift; $self->SUPER::start_tests; # your code here .... }
This method is called by HTTP::WebTest at the end of a test run. Its implementation in this class e-mails the test report according test parameters mail***.
mail***
If you redefine this method in subclass be sure to call the superclass method in the new method:
sub end_tests { my $self = shift; # your code here .... $self->SUPER::end_tests; }
Copyright (c) 2001-2003 Ilya Martynov. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
HTTP::WebTest
HTTP::WebTest::API
HTTP::WebTest::Plugins
HTTP::WebTest::Plugin
2 POD Errors
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head3'
=back without =over
To install HTTP::WebTest, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTTP::WebTest
CPAN shell
perl -MCPAN -e shell install HTTP::WebTest
For more information on module installation, please visit the detailed CPAN module installation guide.