名前¶

HTTP::WebTest::Plugin::Cookies - テスト時のクッキーの送受信

概要¶

なし.

説明¶

このプラグインではウェブテスト時のクッキーの送受信を制御する手段を 提供します.

テストパラメータ¶

accept_cookies¶

ウェブサーバからクッキーを受けつかるかの設定.

クッキーはプログラムの実行中にだけ存在し, それ以降は影響を与えません. これらのクッキーはあなたのブラウザやテストプログラム以外のソフトウェア には影響しません. クッキーは１つのテストシーケンス中で実行している 他のテストからだけアクセスできます.

<send_cookies> パラメータも参照してください.

使用可能な値¶

yes, no

デフォルト値¶

yes

send_cookies¶

ウェブサーバのクッキーを送るかを設定します. これはウェブサーバから 受け取ったクッキーにも cookies テストパラメータで指定された クッキーにも適用されます.

これはウェブサーバにブラウザや他のこのプログラム以外のユーザエージェント ソフトウェアが作ったクッキーへのアクセスを禁じるものではありません. このプログラムの実行中に生成されたクッキーは同じテストシーケンス内の 他のテストからのみアクセス可能です.

<accept_cookies> パラメータも参照してください.

使用可能な値¶

yes, no

デフォルト値¶

yes

cookie¶

cookies の同義語です.

このパラメータは廃止されています. 今後のバージョンの HTTP::WebTest で削除されるでしょう.

cookies¶

ウェブサーバに送るクッキーを指定したリストを指定します:

    cookies = ( cookie1_spec
                cookie2_spec
                ...
                cookieN_spec )

現在のところ２種類の記述方法があります.

• Named style

  * 名前付きスタイル

  A cookie is specified by a set of param => value pairs:

  クッキーは param => value ペアの集合で指定します:

      (
        param => value
        ...
      )

  List of all supported param => value pairs:

  サポートされている param => value ペアは以下の通りです:

  version => VERSION

  Version number of cookie spec to use, usually 0.

  使用するクッキー指定方法のバージョン番号. 通常は 0 を指定します.

  name => NAME (REQUIRED)

  Name of cookie. Cannot begin with a $ character.

  クッキーの名前. 文字 $ で始まる名前は使えません.

  value => VALUE (REQUIRED)

  Value of cookie.

  クッキーの値.

  path => PATH (REQUIRED)

  URL path name for which this cookie applies. Must begin with a / character. See also path_spec.

  このクッキーが適用される url パス. 文字 / で始まらなければなりません. path_spec も参照してください.

  domain => DOMAIN (REQUIRED)

  Domain for which cookie is valid. Must either contain two periods or be equal to .local.

  クッキーを有効にするドメイン. ２つのピリオドを含むか .local と 等しくなければなりません.

  port => PORT

  List of allowed port numbers that the cookie may be returned to. If not specified, cookie can be returned to any port. Must be specified using the format N or N, N, ..., N where N is one or more digits.

  クッキーを返すことを許可するポート番号のリスト. 指定しなければ全てのポートに対して返すようになります. N もしくは N, N, ..., N というフォーマットして指定してください (N は１つ以上の数字です).

  path_spec => PATH_SPEC

  Ignored if version is less than 1. Option to ignore the value of path. Default value is 0.

  version が 1 より小さいときは無視されます. path の値を無視するかどうかを設定します. デフォルトは 0 です.

  • 1

    Use the value of path.

    path の値を使う.

  • Ignore the specified value of path.

    path に指定された値を無視する.

  secure => SECURE

  Option to require secure protocols for cookie transmission. Default value is 0.

  クッキーの転送にセキュアなプロトコルを要求する. デフォルトは 0.

  • 1

    Use only secure protocols to transmit this cookie.

    このクッキーはセキュアなプロトコルでのみ使われる.

  • Secure protocols are not required for transmission.

    転送時にセキュアなプロトコルを必要としない.

  maxage => MAXAGE

  Number of seconds until cookie expires.

  クッキーが期限切れとなるまでの秒数.

  discard => DISCARD

  Option to discard cookie when the program finishes. Default is 0. (The cookie will be discarded regardless of the value of this element.)

  プログラムが終了するときにクッキーを破棄するかの設定. デフォルトは 0. (クッキーはこの要素の値に関わらず破棄されます.)

  • 1

    Discard cookie when the program finishes.

    プログラム終了時にクッキーを破棄する.

  • Don't discard cookie.

    クッキーを破棄しない.

  rest => NAME_VALUE_LIST

  Defines additional cookie attributes.

  クッキーの属性を追加定義する.

  Zero, one or several name/value pairs may be specified. The name parameters are words such as Comment or CommentURL and the value parameters are strings that may contain embedded blanks.

  0個, 1個, それ以上の名前/値ペアを指定します. 名前は Comment や CommentURL といった単語を, 値には文字列(空白を 含むこともできます)を指定します.

  Example (wtscript file):

  例 (wtscript ファイル):

      cookies = ( ( name   => Cookie1
                    value  => cookie value )
  
                  ( name   => Cookie2
                    value  => cookie value
                    path   => /
                    domain => .company.com ) )
  
                  ( name   => Cookie2
                    value  => cookie value
                    rest   => ( Comment => this is a comment ) )

  Example (Perl script):

  例 (Perl スクリプト):

      my $tests = [
                    ...
                    {
                      test_name => 'cookie',
                      cookies   => [ [
                                       name  => 'Cookie1',
                                       value => 'Value',
                                     ],
                                     [
                                       name  => 'Cookie2',
                                       value => 'Value',
                                       path  => '/',
                                     ] ],
                      ...
                    }
                    ...
                  ]

• Row list style

  (行リストスタイル)

  This style of cookie specification is deprecated and may be removed in future versions of HTTP::WebTest.

  この形式での指定は廃止されています. 今後のバージョンの HTTP::WebTest で削除されるでしょう.

  Each cookie is specified by following list:

  各クッキーは以下のリストの形で指定されます:

      ( VERSION
        NAME
        VALUE
        PATH
        DOMAIN
        PORT
        PATH_SPEC
        SECURE
        MAXAGE
        DISCARD
        NAME1
        VALUE1
        NAME2
        VALUE2
        ...
      )

  Any element not marked below as REQUIRED may be defaulted by specifying a null value or ''.

  以下で REQUIRED とマークされている要素はnull値もしくは '' がデフォルトになります.

  • VERSION (REQUIRED)

    Version number of cookie spec to use, usually 0.

    使用するクッキー指定方法のバージョン番号. 通常は 0 を指定します.

  • NAME (REQUIRED)

    Name of cookie. Cannot begin with a $ character.

    クッキーの名前. 文字 $ で始まる名前は使えません.

  • VALUE (REQUIRED)

    Value of cookie.

    クッキーの値.

  • PATH (REQUIRED)

    URL path name for which this cookie applies. Must begin with a / character. See also path_spec.

    このクッキーが適用される url パス. 文字 / で始まらなければなりません. path_spec も参照してください.

  • DOMAIN (REQUIRED)

    Domain for which cookie is valid. Must either contain two periods or be equal to .local.

    クッキーを有効にするドメイン. ２つのピリオドを含むか .local と 等しくなければなりません.

  • PORT

    List of allowed port numbers that the cookie may be returned to. If not specified, cookie can be returned to any port. Must be specified using the format N or N, N, ..., N where N is one or more digits.

    クッキーを返すことを許可するポート番号のリスト. 指定しなければ全てのポートに対して返すようになります. N もしくは N, N, ..., N というフォーマットして指定してください (N は１つ以上の数字です).

  • PATH_SPEC

    Ignored if version is less than 1. Option to ignore the value of path. Default value is 0.

    version が 1 より小さいときは無視されます. path の値を無視するかどうかを設定します. デフォルトは 0 です.

    • 1

      Use the value of path.

      path の値を使う.

    • Ignore the specified value of path.

      path に指定された値を無視する.

  • SECURE

    Option to require secure protocols for cookie transmission. Default value is 0.

    クッキーの転送にセキュアなプロトコルを要求する. デフォルトは 0.

    • 1

      Use only secure protocols to transmit this cookie.

      このクッキーはセキュアなプロトコルでのみ使われる.

    • Secure protocols are not required for transmission.

      転送時にセキュアなプロトコルを必要としない.

  • MAXAGE

    Number of seconds until cookie expires.

    クッキーが期限切れとなるまでの秒数.

  • DISCARD

    Option to discard cookie when the program finishes. Default is 0. (The cookie will be discarded regardless of the value of this element.)

    プログラムが終了するときにクッキーを破棄するかの設定. デフォルトは 0. (クッキーはこの要素の値に関わらず破棄されます.)

    • 1

      Discard cookie when the program finishes.

      プログラム終了時にクッキーを破棄する.

    • Don't discard cookie.

      クッキーを破棄しない.

  • name/value

    Zero, one or several name/value pairs may be specified. The name parameters are words such as Comment or CommentURL and the value parameters are strings that may contain embedded blanks.

    0個, 1個, それ以上の名前/値ペアを指定します. 名前は Comment や CommentURL といった単語を, 値には文字列(空白を 含むこともできます)を指定します.

  An example cookie would look like:

  例えば次のようになります:

      cookies = ( ( 0
                    WebTest cookie #1
                    cookie value
                    /
                    .mycompany.com
                    ''
                    0
                    0
                    200
                    1
                  ) )

詳細は RFC 2965 (ftp://ftp.isi.edu/in-notes/rfc2965.txt) を 参照してください.

コピーライト¶

Copyright (c) 2000-2001 Richard Anderson. All rights reserved.

Copyright (c) 2001-2003 Ilya Martynov. All rights reserved.

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

SEE ALSO¶

HTTP::WebTest

HTTP::WebTest::API

HTTP::WebTest::Plugin

HTTP::WebTest::Plugins