HTTP-WebTest-2.04 > HTTP::WebTest::API

HTTP-WebTest-2.04

誤訳の報告

原文を表示/隠す

名前
概要
説明
メソッド
低レベル API メソッド
下位互換性
- web_test ($file, $num_fail_ref, $num_succeed_ref, $optional_options)
  - パラメータ
- run_web_test ($tests, $num_fail_ref, $num_succeed_ref, $optional_options)
  - パラメータ
コピーライト
SEE ALSO

名前¶

HTTP::WebTest::API - API of HTTP::WebTest

HTTP::WebTest::API - HTTP::WebTest の API

概要¶

    use HTTP::WebTest;

    my $webtest = new HTTP::WebTest;

    # run test from file
    # ファイルからテストを実行
    $webtest->run_wtscript('script.wt');

    # or (to pass test parameters as method arguments)
    # もしくはメソッドのパラメータからテストパラメータを設定
    $webtest->run_tests($tests);

説明¶

This document describes Perl API of HTTP::WebTest.

このドキュメントでは HTTP::WebTest の Perl API について記述しています.

メソッド¶

new ()¶

Constructor.

コンストラクタ.

復帰値¶

A new HTTP::WebTest object.

新しい HTTP::WebTest オブジェクト.

run_tests ($tests, $optional_params)¶

Runs a test sequence.

テストシーケンスの実行.

パラメータ¶

$test

A reference to an array that contains test objects.

テストオブジェクトを格納した配列へのリファレンス.
$optional_params

A reference to a hash that contains optional global parameters for test.

任意のテストのためのグローバルパラメータを格納したハッシュへのリファレンス.

run_wtscript ($wtscript, $optional_params)¶

Reads wtscript and runs tests it defines.

wtscript を読み込みそこで定義されているテストを実行する.

パラメータ¶

$wtscript

Either the name of wtscript file or wtscript passed as string. Very simple heuristic is used distinguish first from second. If $wtscript contains either \n or \r it is treated as a wtscript string. Otherwise, it is treated as a file name.

wtscript ファイルの名前もしくはwtscriptそのもの. とても単純な方法で両指定は識別されます. もし $wtscript が \n もしくは \r を含んでいればそれは wtscript 文字列として処理されます. そうでなければファイル名として処理されます.
$optional_params

A reference to a hash that contains optional test parameters that can override parameters defined in wtscript.

wtscript で定義されているパラメータを上書きする任意のテストパラメータを含んだハッシュへのリファレンス.

num_fail ()¶

復帰値¶

The number of failed tests.

失敗したテストの数.

num_succeed ()¶

復帰値¶

The number of passed tests.

成功したテストの数.

have_succeed ()¶

復帰値¶

True if all tests have passed, false otherwise.

全てのテストが成功したときに真, そうでなければ偽.

parser_package($optional_parser_package)¶

If $optional_parser is defined sets a parser package to use when parsing wtscript files. Otherwise just returns current parser package.

$optional_parser が定義されていれば wtscript ファイルを解析するときに使われるパーサパッケージとして設定する. そうでなければ現在のパーサパッケージを返す.

復帰値¶

The parser package.

パーサーパッケージ.

parse ($data)¶

Parses test specification in wtscript format.

wtscript フォーマットのテスト記述を解析する.

パラメータ¶

$data

Scalar that contains test specification in wtscript format.

wtscript フォーマットのテスト記述を含んだスカラー.

復帰値¶

A list of two elements. First element is a reference to an array that contains test objects. Second element is a reference to a hash that contains optional global test parameters.

２つの要素を持つリスト. １つ目はテストオブジェクトを格納した配列へのリファレンス. ２つ目は任意のグローバルテストパラメータ含んだハッシュへのリファレンス.

It can be passed directly to run_tests.

これらの値は直接 run_tests に渡すことができます.

Example¶

    $webtest->run_tests($webtest->parse($data));

低レベル API メソッド¶

Most users don't need to use this part of HTTP::WebTest API directly. It could be useful for users who want to:

大抵のユーザはこのセクションの HTTP::WebTest API を直接使う必要はありません. これらは次のことを行いたいユーザには便利でしょう:

Write an HTTP::WebTest plugin.

HTTP::WebTest プラグインを書くとき.
Get access to LWP::UserAgent, HTTP::WebTest::Request, HTTP::Response and other objects used by HTTP::WebTest during runing test sequence.

LWP::UserAgent, HTTP::WebTest::Request, HTTP::Response 及びテストシーケンスの実行中に HTTP::WebTest が使うその他のオブジェクト等にアクセスしたいとき.

tests ()¶

復帰値¶

A reference to an array that contains test objects.

テストオブジェクトを格納する配列へのリファレンス.

user_agent ($optional_user_agent)¶

If $optional_user_agent is a user agent object, it is used by the HTTP::WebTest object for all requests. If $optional_user_agent is passed as undef, the HTTP::WebTest object is reset to use the default user agent.

$optional_user_agent がユーザエージェントオブジェクトであれば HTTP::WebTest の全てのリクエストでそれを使うようになります. もし $optional_user_agent に undef を渡されたなら, HTTP::WebTest オブジェクトのユーザエージェントはデフォルトのものにリセットされます.

復帰値¶

The user agent object used by the HTTP::WebTest object.

HTTP::WebTest オブジェクトによって使われるユーザエージェントオブジェクト.

plugins ($optional_plugins)¶

If $optional_plugins is a reference to an array that contains plugin objects, the HTTP::WebTest object uses these plugins while running tests. If $optional_plugins is passed as undef, the HTTP::WebTest object is reset to use the default set of plugins.

$optional_plugins にプラグインオブジェクトを格納した配列へのリファレンスを渡したときは HTTP::WebTest はテストの実行中にそれらのプラグインを使うようになります. もし $optional_plugins に undef を渡したときはデフォルトのプラグインセットにリセットされます.

復帰値¶

A reference to an array that contains plugin objects. If you add or remove plugin objects in this array, you will change the set of plugins used by HTTP::WebTest object during tests.

プラグインオブジェクトを格納した配列へのリファレンス. もしその配列のプラグインオブジェクトを追加もしくは削除するとテスト中に HTTP::WebTest オブジェクトが使うプラグインのセットを変更することになります.

create_user_agent ()¶

復帰値¶

A new LWP::UserAgent object, initialized with default settings.

デフォルトの設定で初期化された新しい LWP::UserAgent オブジェクト.

reset_user_agent ()¶

Resets the user agent to the default.

ユーザエージェントをデフォルトのものにリセットします.

reset_plugins ()¶

Resets the set of plugin objects to the default set.

プラグインオブジェクトをデフォルトのものにリセットします.

default_plugins ()¶

復帰値¶

A reference to the set of default plugin objects.

デフォルトのプラグインオブジェクトのセットへのリファレンス.

global_test_param ($param)¶

復帰値¶

The value of the global test parameter $param.

グローバルテストパラメータ $param の値.

current_test_num ()¶

復帰値¶

The number of the current test or, if no test is running, the current test run.

現在のテストの番号. もしくは実行中でなければ最後に実行されたテストの番号.

current_test ()¶

復帰値¶

The HTTP::WebTest::Test object which corresponds to the current test or, if no test is running, the current test run.

現在のテストに対応する HTTP::WebTest::Test オブジェクト. もしくは実行中でなければ最後に実行されたテストオブジェクト.

current_request ()¶

復帰値¶

The HTTP::WebTest::Request object used in current test.

現在のテストで使われている HTTP::WebTest::Request オブジェクト.

current_response ()¶

復帰値¶

The HTTP::Response object used in current test.

現在のテストで使われている HTTP::Response オブジェクト.

current_response_time ()¶

復帰値¶

The response time for the HTTP request used in current test.

現在のテストでの HTTP リクエストに対するレスポンスタイム.

current_results ()¶

復帰値¶

A reference to an array that contains the results of checks made by plugins for the current test.

現在のテストに対するプラグインからのテスト結果を格納している配列へのリファレンス.

run_test ($test, $optional_params)¶

Runs a single test.

１つのテストを実行.

パラメータ¶

$test

A test object.

テストオブジェクト.
$optional_params

A reference to a hash that contains optional global test parameters.

任意のグローバルテストパラメータを格納しているハッシュへのリファレンス.

convert_tests (@tests)¶

Converts test objects @tests of any supported type to internal canonical representation (i.e. to HTTP::WebTest::Test objects).

多ポートされているタイプのテストオブジェクト @tests を内部の標準表現(つまり HTTP::WebTest::Test オブジェクト)に変換する.

復帰値¶

A list of HTTP::WebTest::Test objects (list context) or the first value from a list of HTTP::WebTest::Test objects (scalar context).

リストコンテキストでは HTTP::WebTest::Test オブジェクトのリスト, スカラーコンテキストでは HTTP::WebTest::Test オブジェクトのリストの先頭の値.

下位互換性¶

HTTP::WebTest 2.xx offers a richer API than its predecessor HTTP::WebTest 1.xx. The old API is still supported, but may be deprecated in the future and is not recommended.

HTTP::WebTest 2.xx は前任の HTTP::WebTest 1.xx よりもリッチな API を提供しています. 古い API も今のところサポートされていますが今後廃止されるでしょう. また, これらの使用は推奨されません.

web_test ($file, $num_fail_ref, $num_succeed_ref, $optional_options)¶

Reads wtscript file and runs tests it defines.

wtscript ファイルを読み込みそこで定義されているテストを実行する.

In HTTP::WebTest 2.xx you should use method run_wtscript.

HTTP::WebTest 2.xx では run_wtscript メソッドを使うべきです.

パラメータ¶

$file

Name of a wtscript file.

wtscript ファイルの名前.
$num_fail_ref

A reference on scalar where a number of failed tests will be stored or undef if you don't need it.

失敗したテストの数を格納するスカラーへのリファレンス. 必要なければ undef を指定できます.
$num_succed_ref

A reference on scalar where a number of passed tests will be stored or undef if you don't need it.

パス(成功)したテストの数を格納するスカラーへのリファレンス. 必要なければ undef を指定できます.
$optional_params

A reference to a hash that contains optional test parameters which can override parameters defined in wtscript.

wtscript で定義されているパラメータを上書きすることができる任意のテストパラメータを格納したハッシュへのリファレンス.

run_web_test ($tests, $num_fail_ref, $num_succeed_ref, $optional_options)¶

This is not a method. It is subroutine which creates a HTTP::WebTest object and runs test sequence using it.

これはメソッドではありません. HTTP::WebTest オブジェクトを生成しそれを使ってテストシーケンスを実行するサブルーティンです.

You need to either import run_web_test into you namespace with

以下の文で run_web_test をインポートするか,

    use HTTP::WebTest qw(run_web_test);

or use the full name HTTP::WebTest::run_web_test

完全な名前 HTTP::WebTest::run_web_test を使う必要があります.

In HTTP::WebTest 2.xx you should use the method run_tests.

HTTP::WebTest 2.xx ではrun_tests メソッドを使うべきです.

パラメータ¶

$tests

A reference to an array that contains a set of test objects.

テストオブジェクトのセットを格納する配列へのリファレンス.
$num_fail_ref

A reference to a scalar where the number of failed tests will be stored or undef if you don't need it.

失敗したテストの数を格納するスカラーへのリファレンス. 必要なければ undef を指定できます.
$num_succed_ref

A reference to a scalar where the number of passed tests will be stored or undef if you don't need it.

パス(成功)したテストの数を格納するスカラーへのリファレンス. 必要なければ undef を指定できます.
$optional_params

A reference to a hash that contains optional test parameters.

任意のテストパラメータを格納するハッシュへのリファレンス.

コピーライト¶

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

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

名前¶

概要¶

説明¶

メソッド¶

new ()¶

復帰値¶

run_tests ($tests, $optional_params)¶

パラメータ¶

run_wtscript ($wtscript, $optional_params)¶

パラメータ¶

num_fail ()¶

復帰値¶

num_succeed ()¶

復帰値¶

have_succeed ()¶

復帰値¶

parser_package($optional_parser_package)¶

復帰値¶

parse ($data)¶

パラメータ¶

復帰値¶

Example¶

低レベル API メソッド¶

tests ()¶

復帰値¶

user_agent ($optional_user_agent)¶

復帰値¶

plugins ($optional_plugins)¶

復帰値¶

create_user_agent ()¶

復帰値¶

reset_user_agent ()¶

reset_plugins ()¶

default_plugins ()¶

復帰値¶

global_test_param ($param)¶

復帰値¶

current_test_num ()¶

復帰値¶

current_test ()¶

復帰値¶

current_request ()¶

復帰値¶

current_response ()¶

復帰値¶

current_response_time ()¶

復帰値¶

current_results ()¶

復帰値¶

run_test ($test, $optional_params)¶

パラメータ¶

convert_tests (@tests)¶

復帰値¶

下位互換性¶

web_test ($file, $num_fail_ref, $num_succeed_ref, $optional_options)¶

パラメータ¶

run_web_test ($tests, $num_fail_ref, $num_succeed_ref, $optional_options)¶

パラメータ¶

コピーライト¶

SEE ALSO¶