GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
HTTP::WebTest::ReportPlugin(3) User Contributed Perl Documentation HTTP::WebTest::ReportPlugin(3)
 

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".

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.
This parameter can be used only when passing the test parameters as arguments from a calling Perl script.

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.

GLOBAL PARAMETER
Option to e-mail output to one or more addresses specified by "mail_addresses" test parameter.

GLOBAL PARAMETER
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).
Default Value
"Web tests succeeded"

GLOBAL PARAMETER
Sets "Subject" header for test report e-mails when some tests fail. In this string some character sequences have special meaning:
%f
the number of failed tests
%s
the number of successful tests
%t
the total number of tests
%%
replaced with single "%"
Default Value
"WEB TESTS FAILED! FOUND %f ERROR(S)"

GLOBAL PARAMETER
A list of e-mail addresses where report will be send (if sending report is enabled with "mail" 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"

GLOBAL PARAMETER
Fully-qualified name of of the mail server (e.g., mailhost.mycompany.com).
Default value
"localhost"

GLOBAL PARAMETER
Sets From: header for test report e-mails.
Default Value
Name of user under which test script runs.

Returns
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".

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***".
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

Hey! The above document had some coding errors, which are explained below:
Around line 128:
You forgot a '=back' before '=head3'
Around line 132:
=back without =over
2003-09-05 perl v5.28.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.