名前¶
HTTP::WebTest::SelfTest - Helper package for HTTP::WebTest test suite
HTTP::WebTest::SelfTest - HTTP::WebTest テストスイート用のヘルパーパッケージ
概要¶
use HTTP::WebTest::SelfTest;説明¶
This module provides helper routines used by HTTP::WebTest self test suite. Plugin writers may find this module useful for implementation of test suites for their plugins.
このモジュールでは HTTP::WebTest 自身のテストスイートで使われる ヘルパーメソッドを提供します. プラグインの制作者は作っているプラグインの テストスイートの実装に役立つものが見付かるかもしれません.
グローバル変数¶
This module imports in namespace of test script following global variables.
このモジュールは以下のグローバル変数をテストスクリプトの名前空間に インポートします.
$HOSTNAME¶
The hostname of the test webserver.
テストウェブサーバのホスト名.
$PORT¶
The port of the test webserver.
テストウェブサーバのポート.
$URL¶
The URL of the test webserer.
テストウェブサーバの URL.
サブルーティン¶
This module imports in namespace of test script following helper subroutines.
このモジュールは以下のヘルパ関数をテストスクリプトの名前空間に インポートします.
abs_url($base, $rel)¶
復帰値¶
Returns absolute URL based on pair of base and relative URLs.
ベース及び相対 URL のペアからなる絶対 URL を返します.
read_file($filename, $ignore_errors)¶
Reads a file.
ファイルを読み込みます.
パラメータ¶
- $filename
-
Name of the file.
ファイルの名前.
- $ignore_errors
-
(Optional) If true then open file errors are ignored, otherwise they raise an exception. If omit defaults to true.
(任意) 死んであればファイルを開くときのエラーは無視されます. そうでなければ例外を発生させます. 省略時は真です.
復帰値¶
Whole content of the file as a string.
ファイルの中身全体を文字列として返します.
write_file($filename, $data)¶
Writes into a file.
ファイルに書き込み.
パラメータ¶
- $filename
-
Name of the file.
ファイル名.
- $data
-
Data to write into the file.
ファイルに書き込むデータ.
check_webtest(%params)¶
Runs a test sequence and compares output with a reference file.
テストシーケンスを実行してその出力をリファレンスファイルと比較します.
パラメータ¶
- webtest => $webtest
-
HTTP::WebTest object to be used for running the test sequence.
テストシーケンスの実行に使う HTTP::WebTest オブジェクト.
- tests => $tests
-
The test sequence.
テストシーケンス.
- tests => $opts
-
The global parameters for the test sequence.
テストシーケンスのためのグローバルパラメータ. (訳注: 原文では
tests =$opts> となっていたが恐らく誤り.) - out_filter => $out_filter
generate_testfile(%params)¶
Generates test file from template file. I.e. it replaces substring '<<SERVER_URL>>' with value of named parameter server_url.
テンプレートファイルからテストファイルを生成. 部分文字列 '<<SERVER_URL>>' は名前付きパラメータ server_url の値で 置き換えられます.
パラメータ¶
- file => $file
-
Filename of test file. Template file is expected to be in file named "$file.in".
テストファイルのファイル名. テンプレートファイルは "$file.in" の名前を もつ必要があります.
- server_url => $server_url
-
Test webserver URL.
テストサーバの URL.
canonical_output(%params)¶
Some substrings in test output are unique for each test run. This subroutine "fixes" test output so it becomes repeatable (unless tests get broken).
テストの出力中のいくつかの部分文字列を各テストの実行毎にユニークな ものに置き換えます. この関数ではテストの出力を"修正"するため(テストが 壊れていない限りは)繰り返し可能です.
パラメータ¶
- output_ref => $output_ref
-
A reference on scalar which contains test output as whole string.
テストの結果を文字列全体として格納するスカラーへのリファレンス.
- out_filter => $out_filter
-
An optional reference on subroutine which can be used as additional filter. It gets passed test output as its first parameter.
追加フィルタとして使われる関数へのリファレンス. 任意. １番目の引数に テストの出力が渡されます.
- server_url => $server_url
-
Test webserver URL. Normally it is unique for each test run so it gets replaced with
http://http.web.test/.ウェブサーバ URL をテストします. 通常これは各テストの実行毎にユニーク であるため
http://http.web.test/で置き換えられます. - server_hostname => $server_hostname
-
Test webserver URL. Normally it is unique for each machine where test is run so it gets replaced with
http.web.test.ウェブサーバ URL をテストします. 通常これは各マシン毎にユニーク であるため
http.web.testで置き換えられます.
compare_output(%params)¶
Tests if a test output matches content of specified reference file. If environment variable TEST_FIX is set then the test is always succeed and the content of the reference file is overwritten with current test output.
テスト出力が指定されたリファレンスファイルの内容と一致するかテストします. もし環境変数 TEST_FIX が設定されていればテストは常に成功し, リファレンスファイルの内容をテスト結果で上書きします.
パラメータ¶
- output_ref => $output_ref
-
A reference on scalar which contains test output as whole string.
テストの結果を文字列全体として格納するスカラーへのリファレンス.
- check_file => $check_file
-
Filename of the reference file.
リファレンスファイルのファイル名.
parse_basic_credentials($credentials)¶
Decodes credentials for Basic authorization scheme according RFC2617.
RFC 2617 に対応するベーシック認証スキーマのデコードを行います.
復帰値¶
Returns user/password pair.
ユーザ/パスワードのペア.
廃止された関数¶
This module imports in namespace of test script following helper subroutines but they are deprecated and may be removed in the future from this module.
このモジュールは以下のヘルパ関数もテストスクリプトの名前空間に インポートしますがこれらは廃止されています. 今後削除されるでしょう.
start_webserver¶
This subroutine was moved into HTTP::WebTest::Utils but for backward compatibility purposes can be exported from this module.
この関数は HTTP::WebTest::Utils に 移動されました. 下位互換のためにこのモジュールからエクスポートされています.
stop_webserver¶
This subroutine was moved into HTTP::WebTest::Utils but for backward compatibility purposes can be exported from this module.
この関数は HTTP::WebTest::Utils に 移動されました. 下位互換のためにこのモジュールからエクスポートされています.
コピーライト¶
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 自身と同じ条件下で再配布・改変可能です.