HTTP-WebTest-2.04 > HTTP::WebTest::Plugin
HTTP-WebTest-2.04

名前

HTTP::WebTest::Plugin - Base class for HTTP::WebTest plugins.

HTTP::WebTest::Plugin - HTTP::WebTest プラグインの基底クラス

概要

Not applicable.

なし.

説明

HTTP::WebTest plugin classes can inherit from this class. It provides some useful helper methods.

HTTP::WebTest プラグインクラスはこのクラスから派生させます. ここでは便利なヘルパーメソッドが提供されています.

メソッド

new ($webtest)

Constructor.

コンストラクタ.

復帰値

A new plugin object that will be used by HTTP::WebTest object $webtest.

HTTP::WebTest オブジェクト $webtest によって使用される 新しいプラグインオブジェクト.

webtest ()

復帰値

An HTTP::WebTest object that uses this plugin.

このプラグインを使っている HTTP::WebTest オブジェクト.

global_test_param ($param, $optional_default)

復帰値

If global test parameter $param is not defined, returns $optional_default or undef if there is no default.

グローバルテストパラメータ $param が定義されていなければ $optional_default. デフォルト値も渡されていなければ undef.

If the global test parameter $param is defined, returns it's value.

グローバルテストパラメータ $param が定義されていればその値.

test_param ($param, $optional_default)

復帰値

If latest test parameter $param is not defined, returns $optional_default or undef if there is no default.

最新のテストパラメータ $param が定義されていなければ $optional_default. デフォルト値も渡されていなければ undef.

If latest test parameter $param is defined returns it's value.

最新ののテストパラメータ $param が定義されていればその値.

global_yesno_test_param ($param, $optional_default)

復帰値

If the global test parameter $param is not defined, returns $optional_default or false if no default exists.

グローバルテストパラメータ $param が定義されていなければ $optional_default. デフォルト値も渡されていなければ偽.

If the global test parameter $param is defined, returns true if latest test parameter $param is yes, false otherwise.

グローバルテストパラメータ $param が定義されてるのなら, 最新のテストパラメータ $paramyes であれば真, そうでなければ偽.

yesno_test_param ($param, $optional_default)

復帰値

If latest test parameter $param is not defined returns $optional_default or false if it is not defined also.

最新のテストパラメータ $param が定義されていなければ $optional_default. デフォルト値も渡されていなければ偽.

If latest test parameter $param is defined returns true if latest test parameter $param is yes. False otherwise.

最新のテストパラメータ $param が定義されてるのなら, 最新のテストパラメータ $paramyes であれば真, そうでなければ偽.

test_result ($ok, $comment)

Factory method that creates test result object.

テスト結果オブジェクトを作るファクトリメソッド.

復帰値

HTTP::WebTest::TestResult オブジェクト.

validate_params (@params)

Checks test parameters in @params. Throws exception if any of them are invalid.

@params の中のテストパラメータを調べます. もし不正なものがあれば 例外をなげます.

global_validate_params (@params)

Checks global test parameters in @params. Throws exception if any of them are invalid.

@params の中のグローバルテストパラメータを調べます. もし不正なものがあれば 例外をなげます.

validate_value($param, $value, $type)

Checks if $value of test parameter $param has type <$type>.

テストパラメータ $param$value がタイプ <$type> を持っているか を調べます.

例外

Dies if check is not successful.

チェックが成功しなければ die します.

param_types ()

This method should be redefined in the subclasses. Returns information about test parameters that are supported by plugin. Used to validate tests.

このメソッドはサブクラスで再定義されるべきです. プラグインがサポートするテストパラメータに関する情報を返します. テストの検証に使われます.

復帰値

A string that looks like:

次のような文字列です:

    'param1 type1
     param2 type2
     param3 type3(optional,args)
     param4 type4'

check_anything ($value)

Method that checks whether test parameter value is of anything type.

テストパラメータの値が anything タイプであることをチェックする メソッドです.

This is NOOP operation. It always succeed.

これは何もしません. 常に成功します.

check_list ($param, $value, @optional_spec)

Method that checks whether test parameter value is of list type. That is it is a reference on an array.

テストパラメータの値が list タイプ から成ることをチェックします. つまり配列のリファレンスであることをチェックします.

Optional list @optional_spec can define specification on allowed elements of list. It can be either

任意のリスト @optional_spec はリストに許可される要素を定義します. 次のいずれかの形式で指定します:

    ('TYPE_1', 'TYPE_2', ..., 'TYPE_N')

or

もしくは

    ('TYPE_1', 'TYPE_2', ..., 'TYPE_M', '...')

First specification requires list value of test parameter to contain N elements. First element of list should be of should TYPE_1 type, second element of list should of TYPE_2 type, ..., N-th element of list should be of TYPE_N type.

1つめの指定ではテストパラメータが N 個の要素を持っているリストで あることを要求します. リストの最初の要素は TYPE_1 タイプであり, リストの2つ目の要素は TYPE_2 であり, ..., リストの N 番目の要素は TYPE_N タイプであるべきです.

Second specification requires list value of test parameter to contain at least N elements. First element of list should be of should TYPE_1 type, second element of list should of TYPE_2 type, ..., M-th element of list should be of TYPE_M type, all following elements should be of TYPE_M type.

2つめの指定ではテストパラメータが少なくとも M 個の要素を持っている リストであることを要求します. リストの最初の要素は TYPE_1 タイプであり, リストの2つ目の要素は TYPE_2 であり, ..., リストの M 番目の要素は TYPE_M タイプであるべきです. そしてそれ以降の要素は TYPE_M で あるべきです.

例外

Dies if checks is not successful.

チェックが成功しなければ die します.

check_scalar ($param, $value, $optional_regexp)

Method that checks whether test parameter value is of scalar type (that is it is usual Perl scalar and is not a reference).

テストパラメータが scalar タイプ(通常の Perl のスカラーであり, リファレンスは含みません)であることをチェックします.

If $optional_regexp is specified also checks value of parameter using this regual expression.

$optional_regexp が指定されたのならパラメータの値をこの正規表現でも チェックします.

例外

Dies if check is not successful.

チェックが成功しなければ die します.

check_stringref ($param, $value)

Method that checks whether test parameter value is of stringref type (that is it is a reference on scalar).

テストパラメータの値が stringref タイプ(スカラーへのリファレンス) であることをチェックします.

例外

Dies if check is not successful.

チェックが成功しなければ die します.

check_uri ($param, $value)

Method that checks whether test parameter value is of uri type (that is it either scalar or URI object).

テストパラメータの値が uri タイプ (スカラーもしくは URI オブジェクト)であることをチェックします.

例外

Dies if check is not successful.

チェックが成功しなければ die します.

check_hashlist ($param, $value)

Method that checks whether test parameter value is of hashlist type (that is it is either a hash reference or an array reference that points to array containing even number of elements).

テストパラメータの値が hashlist タイプ(ハッシュのリファレンス もしくは偶数個の要素をもつ配列へのリファレンス)であることをチェックします.

例外

Dies if check is not successful.

チェックが成功しなければ die します.

check_yesno ($param, $value)

Same as

以下の分と等値です:

    check_scalar($param, $value, '^(?:yes|no)$');

コピーライト

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::ReportPlugin