HTTP-WebTest-2.04 > HTTP::WebTest::ReportPlugin
HTTP-WebTest-2.04

名前

HTTP::WebTest::ReportPlugin - Subclass for HTTP::WebTest report plugins.

HTTP::WebTest::ReportPlugin - HTTP::WebTest レポート用のプラグインのサブクラス

概要

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.

このクラスは HTTP::WebTest のサブクラスです. HTTP::WebTest のレポートプラグインはこのクラスを 継承させます. ここではメソッド print の実装を提供することで レポートプラグインに共通するいくつかのテストパラメータを処理しています.

テストパラメータ

output_ref

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.

このパラメータは Perl スクリプトのテストパラメータ引数として 渡されたときのみ使われます.

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.

テストレポートを出力するために使うファイルハンドル(もしくは print をサポートする何か). このパラメータは テストパラメータ output_ref が指定されているときには無視されます.

This parameter can be used only when passing the test parameters as arguments from a calling Perl script.

このパラメータは Perl スクリプトのテストパラメータ引数として 渡されたときのみ使われます.

mail

GLOBAL PARAMETER

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

mail_addresses テストパラメータで指定されている1つまたはそれ以上の アドレスに e-mail で出力を送るかの設定.

mail_success_subject

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

全てのテストが成功した時のテストレポートe-mailの Subject ヘッダの 設定. この文字列には特別な意味を持つ文字並びがあります (mail_failure_subject パラメータを参照してください).

デフォルト値

Web tests succeeded

mail_failure_subject

GLOBAL PARAMETER

Sets Subject header for test report e-mails when some tests fail. In this string some character sequences have special meaning:

失敗したテストがあったときに e-mail テストレポートの Subject ヘッダを設定します. この文字列には特別な意味を持つ文字並びが あります.

%f

the number of failed tests

失敗したテストの数

%s

the number of successful tests

成功したテストの数

%t

the total number of tests

テストの総数

%%

replaced with single %

1つの % に置換されます

デフォルト値

WEB TESTS FAILED! FOUND %f ERROR(S)

mail_addresses

GLOBAL PARAMETER

A list of e-mail addresses where report will be send (if sending report is enabled with mail test parameter).

レポートを送る e-mail アドレスのリスト(mail テストパラメータで レポートの送信が有効にされているときだけ送られます).

  • all

    Send e-mail containing test results.

    テスト結果を含んだ e-mail を送ります.

  • errors

    Send e-mail only if one or more tests fails.

    1つまたはそれ以上のテストが失敗したときにだけ e-mail を送ります.

  • no

    Do not send e-mail.

    e-mail を送信しません.

    Default value

    デフォルト値

    no

mail_server

GLOBAL PARAMETER

Fully-qualified name of of the mail server (e.g., mailhost.mycompany.com).

メールサーバの完全修飾ドメイン名(例えば mailhost.mycompany.com).

デフォルト値

localhost

mail_from

GLOBAL PARAMETER

Sets From: header for test report e-mails.

e-mail テストレポートの From: ヘッダを設定します.

デフォルト値

Name of user under which test script runs.

テストスクリプトを実行したユーザの名前.

クラスメソッド

test_output ()

復帰値

Returns a reference to buffer that 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.

<@array> の中のデータを文字列の中(テストパラメータ output_ref が 設定されていたとき)もしくはファイルハンドル(テストパラメータ fh_out が設定されていたとき)もしくは標準出力に 出力します.

Also stores this data into buffer accessible via method test_output.

このデータは test_output メソッドを通してバッファへの格納も できます.

start_tests ()

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.

このメソッドはテストの開始時に HTTP::WebTest から 呼び出されます. このクラスの実装ではテストレポート用の出力バッファを 初期化します.

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

end_tests ()

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

このメソッドはテストの終了時に HTTP::WebTest から 呼び出されます. このクラスの実装ではテストパラメータ mail*** に従ってテストレポートを e-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.

このプログラムはフリーソフトウェアです. このプログラムは Perl 自身と同じ条件下で再配布・改変可能です.

SEE ALSO

HTTP::WebTest

HTTP::WebTest::API

HTTP::WebTest::Plugins

HTTP::WebTest::Plugin