7.3.9　電文選択プラグイン : Hitachi System Information Capture リファレンス

機能

シナリオ実行モード時に送信電文の選択を行います。

形式

ANSI C、C++の形式

#include <esfrw.h>
ESLONG plg_func(ESFRW_SEL_IF *parm)

「plg_func」部分には、システム内で一意の名称を指定してください。

説明

電文選択プラグインは、シナリオ実行モードでの同時テスト数、及び、テストで使用する要求電文を選択します。

最初に呼び出される電文選択プラグイン（シナリオ数選択）で、シナリオ実行数を設定してください。ここで指定した数が、テストの同時実行数となります。システムテスト支援では、シナリオ実行数分のテスト単位情報（引継ぎ領域等）を作成します。テスト単位情報（引継ぎ領域等）は、電文選択プラグイン（電文選択）に渡すので、シナリオ内で情報引継ぎを行う場合は、このテスト単位情報を使用してください。

電文選択プラグイン（電文選択）では、シナリオの継続／終了を判断し、継続する場合は要求電文を選択してください。システムテスト支援は、指定された要求電文を基にテストを実施（要求電文送信〜結果ファイル出力）後、再度、電文選択プラグイン（電文選択）を呼び出します。これを、シナリオ終了まで繰り返します。なお、要求電文として、電文情報プラグインに渡された要求電文情報アドレスを設定する必要がある為、テストで使用する要求電文のアドレスは、電文情報プラグインでメモリ等に退避しておいてください。

同時テスト数を途中で増やしたい場合、電文選択プラグイン（電文選択）にて、シナリオ数再選択を指示してください。この場合、再度、電文選択プラグイン（シナリオ数選択）を呼び出すので、同時テスト数を設定してください。継続中のシナリオがある場合は、継続中のシナリオ数＋プラグイン設定数が、シナリオ数となります。

実行中のシナリオが無くなった時点で、システムテスト支援が終了します。

以下に、電文選択プラグインの呼び出しの流れを示します。

パラメタの内容

ESFRW_SEL_IFのパラメタ内容

typedef struct es_frw_sel_interface {
  ESULONG         call_timing;  …………… 呼び出し契機
  char            reserve1[4];  …………… 送信間隔
  ESFRW_COMMON    *cominf;  ………………… プラグイン共通情報
  ESFRW_CLIENT    *cltinf;  ………………… テスト実行単位情報
  ESFRW_TELEGRAM  *telinf;  ………………… 電文情報
  ESULONG         interval_time;  ………… 送信間隔
  ESULONG         scenario_cnt; …………… シナリオ数
} ESFRW_SEL_IF;

ESFRW_COMMONのパラメタ内容

typedef struct es_frw_cominfo {
  ESULONG         run_mode; ………………… フェーズ
  char            testid[32]; ……………… テスト識別子
  char            plg_name[32]; …………… プラグイン名称
  ESULONG         max_msg_sz ;……………… 最大電文サイズ
  ESULONG         protocol; ………………… プロトコル一覧
  ESULONG         tel_filetype; …………… 電文ファイルの種別
  ESULONG         res_filetype; …………… 結果ファイルの種別
  char            sel_mode;   ……………… 実行モード
  char            reserve1[3];……………… 予備
} ESFRW_COMMON;

ESFRW_CLIENTのパラメタ内容

typedef struct es_frw_cltinfo {
  ESFRW_CONTAINER *continf;  …………………… 引継ぎ領域情報
  char            client_id[16]; ……………… クライアント識別子
} ESFRW_CLIENT;

ESFRW_CONNECTIONのパラメタ内容

typedef struct es_frw_connection {
  ESULONG         protocol;   ………………… プロトコル種別
  char           conntype;  …………………… コネクション種別
  char            reserve1[3];  ……………… 予備
  ESFRW_ADDR      clt_addr;   ………………… クライアントアドレス情報
  ESFRW_ADDR      srv_addr; …………………… サーバアドレス情報
  ESFRW_CONTAINER *continf; …………………… 引継ぎ領域情報
} ESFRW_CONNECTION;

ESFRW_TELEGRAMのパラメタ内容

typedef struct es_frw_telinfo {
  ESULONG         protocol; ……………………プロトコル種別
  unsigned char   msgtype; …………………… 電文種別
  unsigned char   msgform; …………………… 電文形態
  char            reserve1[2]; ……………… 予備
  ESFRW_AREA      head_area; ………………… 電文（HTTPヘッダ）
  ESFRW_AREA      body_area; ………………… 電文（データ）
  ESFRW_ADDR      src_addr;  ………………… 送信元アドレス情報
  ESFRW_ADDR      dst_addr;  ………………… 送信先アドレス情報
  ESFRW_CONTAINER *continf;  ………………… 引継ぎ領域情報
  ESFRW_TELEGRAM  *pair_telinf;  …………… ペアリング電文情報
  ESFRW_EXT_INF   extinf;    ………………… 電文拡張情報
  char            protoinf[128]; …………… 製品情報1（参照出来ません）
  void            *protocol_telinf; ……… プロトコル固有情報
} ESFRW_TELEGRAM;

ESFRW_CONTAINERのパラメタ内容

typedef struct es_frw_continfo {
  ESULONG         contid; …………………… 通番
  char            conttype; ………………… 引継ぎ領域種別
  char            contstat; ………………… 引継ぎ領域状態
  ESCOM_AREA      data_area;………………… 引継ぎ領域
} ESFRW_CONTAINER;

es_com_area（ESCOM_AREA）のパラメタ内容

typedef struct es_com_area {
  ESULONG   size;            ……………… 領域サイズ
  char      reserve[4];      ……………… 予備領域
  char      *data;           ……………… 領域先頭アドレス
} ESCOM_AREA;

ESFRW_ADDRのパラメタ内容

typedef struct es_frw_addr {
  ESCOM_IPADDR ip;         …………………… IPアドレス
  unsigned short  portno;  …………………… ポート番号
} ESFRW_ADDR;

es_com_ipaddr（ESCOM_IPADDR）のパラメタ内容

typedef union es_com_ipaddr{
  ESCOM_IPV4 ipv4;            ……………… IPアドレス（IPv4）
  char reserve[16];           ……………… 予備領域
} ESCOM_IPADDR;

es_com_ipv4（ESCOM_IPV4）のパラメタ内容

typedef struct es_com_ipv4 {
  char reserve[12];            ……………… 予備領域
  char ip[4];                  ……………… IPアドレス（IPv4）
} ESCOM_IPV4;

各テーブル間は以下のチェイン構造となります。

システム検証支援が値を設定するパラメタ項目

ESFRW_SEL_IFのパラメタ項目

call_timing

プラグインの呼び出し契機を設定します。以下の何れかとなります。

ESFRW_TIMING_SCENARIO：シナリオ数選択時

ESFRW_TIMING_TEL：電文選択時

cominf

プラグインに共通する情報（フェーズ、テスト識別子等）を格納しているESFRW_COMMONアドレスを設定します。

cltinf

テスト実行単位の情報（引継ぎ情報等）を格納したESFRW_CLIENTアドレスを設定します。それ以外の場合はNULLを設定します。

telinf

ユーザが設定する項目です。

interval_time

ユーザが設定する項目です。システム検証支援はデフォルト値として、0を設定します。

interval_time

ユーザが設定する項目です。システム検証支援はデフォルト値として、1を設定します。

ESFRW_COMMONのパラメタ項目

run_mode

フレームワークのフェーズを設定します。以下の何れかとなります。

ESFRW_RUNMODE_CREATE_C：電文作成フェーズ（PCAP）

ESFRW_RUNMODE_CREATE_A：電文作成フェーズ（キャプチャ）

ESFRW_RUNMODE_TEST_R：テスト実行フェーズ

ESFRW_RUNMODE_TEST_C：テスト実行フェーズ（PCAP）

test_id

システムテスト支援開始時に指定したテスト識別子を設定します。

plg_name

framework_definition定義の-pオプションのnameフラグメンバで指定したプラグイン名称を設定します。

max_msg_sz

framework_definition定義の-bオプションのmax_message_sizeフラグメンバで指定した最大電文サイズを設定します。

protocol

address_destinationで指定したプロトコルを設定します。以下の論理和となります。

ESFRW_PROT_TCP ：TCP

ESFRW_PROT_HTTP：HTTP

ESFRW_PROT_RPC：RPC

tel_filetype

電文ファイルの種別を設定します。以下の何れかの値となります。

ESFRW_FILE_AFL：蓄積ファイル

ESFRW_FILE_CSV：csvファイル

電文ファイルの種別は、framework_definition定義の-fオプションのtelegram_file_typeフラグメンバ値で指定します。

res_filetype

テスト実行フェーズの場合、結果ファイルの種別を設定します。以下の何れかの値となります。

ESFRW_FILE_AFL：蓄積ファイル

ESFRW_FILE_CSV：csvファイル

電文ファイルの種別は、framework_definition定義の-fオプションのresult_file_typeフラグメンバ値で指定します。電文作成フェーズの場合は、ESFRW_FILE_NONE（無し）を設定します。

sel_mode

電文作成フェーズでは、ESFRW_SELMODE_NONEを設定します。

テスト実行フェーズでは、開始終了プラグインで設定された実行モードを設定します。開始終了プラグインを指定していない場合は、ESFRW_SELMODE_SEQ（逐次実行モード）を設定します。

ESFRW_CLIENTのパラメタ項目

continf: テスト実行単位の引継ぎ領域情報（サイズ等）を格納したESFRW_CONTAINERアドレスを設定します。framework_definition定義の-bオプションのclient_area_sizeに0（引継ぎ領域を使用しない）を指定した場合、NULLを設定します。
client_id: テストの実行単位となるクライアント識別子を設定します。

ESFRW_CONNECTIONのパラメタ項目

protocol

コネクションのプロトコル種別を設定します。以下の何れかとなります。

ESFRW_PROT_TCP：TCP

ESFRW_PROT_HTTP：HTTP

ESFRW_PROT_RPC：RPC

conntype

当該コネクションの種別を設定します。以下の何れかとなります。

ESFRW_CONTYPE_PRO：本番環境のコネクション

ESFRW_CONTYPE_TST：テスト環境のコネクション

clt_addr

クライアント側のアドレス情報（IPアドレス、ポート番号等）を設定します。

本番環境の場合は、外部システムのアドレス情報となります。テスト環境の場合は、システム検証支援基盤のアドレス情報となります。

clt_addr

サーバ側のアドレス情報を設定します。

本番環境の場合は、既存システムのアドレス情報となります。テスト環境の場合は、テスト対象システムのアドレス情報となります。

continf

コネクション用の引継ぎ領域情報（サイズ等）を格納したESFRW_CONTAINERアドレスを設定します。framework_definition定義の-bオプションのconnection_area_sizeに0（引継ぎ領域を使用しない）を指定した場合、NULLを設定します。

ESFRW_TELEGRAMのパラメタ項目

protocol

当該電文のプロトコル種別を設定します。以下の何れかとなります。

ESFRW_PROT_TCP：TCP

ESFRW_PROT_HTTP：HTTP

msgtype

電文種別を設定します。以下の何れかとなります。

ESFRW_MSGTYPE_REQUEST_PRO：要求電文（本番環境）

ESFRW_MSGTYPE_RESPONSE_PRO：応答電文（本番環境）

ESFRW_MSGTYPE_RESPONSE_TST：応答電文（テスト環境）

msgform

電文種別を設定します。以下の何れかとなります。

ESFRW_MSGFORM_NONE：電文形態未決定

ESFRW_MSGFORM_SYNC_ANSWER：同期応答型

ESFRW_MSGFORM_NOANSWER：非応答型

head_area

プロトコル種別がHTTPの場合、電文のHTTPヘッダ情報（サイズ等）を設定します。なお、HTTP電文先頭のリクエスト行／レスポンス行、及び、HTTPヘッダとHTTPボディの間の空行（\r\n）も、HTTPヘッダに含みます。

HTTP以外の場合は、領域サイズが0、領域アドレスがNULLとなります。

body_area

電文のデータ情報（サイズ等）を設定します。プロトコル種別がHTTPで、HTTPヘッダ部のみの場合（GETリクエスト等）、領域サイズが0、領域アドレスがNULLとなります。

src_addr

電文送信元のアドレス情報（IPアドレス、ポート番号等）を設定します。

dst_addr

電文送信先のアドレス情報（IPアドレス、ポート番号等）を設定します。

continf

電文用の引継ぎ領域情報（サイズ等）を格納したESFRW_CONTAINERアドレスを設定します。framework_definition定義の-bオプションのtelegram_area_sizeに0（引継ぎ領域を使用しない）を指定した場合、NULLを設定します。

pair_telinf

NULLを設定します。

pair_telinf

以下の全ての条件を満たす場合、電文ファイル内の拡張情報1及び2を設定します。

テスト実行フェーズ
電文ファイル種別がCSVファイル
CSVファイル内に拡張情報が存在する（電文作成フェーズにおいて、電文ファイルに拡張情報を追加した）

protocol_telinf

プロトコル固有の編集情報を格納した構造体のアドレスを設定します。各プロトコル用の構造体にキャストして使用してください。

RPC：ESFRW_SEND_IF_RPC

RPC以外：NULL

ESFRW_CONTAINERのパラメタ項目

contid

引継ぎ領域毎に割当てる通番を設定します。

conttype

引継ぎ領域の種別を設定します。以下の何れかとなります。

ESFRW_CONTTYPE_TEL：電文単位

ESFRW_CONTTYPE_CON：コネクション単位

ESFRW_CONTTYPE_CLT：テスト実行単位

contstat

引継ぎ領域の状態を設定します。以下の何れかとなります。

ESFRW_CONTST_NEW：初回（新規割当て）

ESFRW_CONTST_RENEW：初回（再割当て）

ESFRW_CONTST_CONTINUE：2回目以降

data_area

引継ぎ領域の情報（サイズ等）を設定します。

ユーザが設定するパラメタ項目

ESFRW_SEL_IFのパラメタ項目

telinf

呼び出し契機がESFRW_TIMING_TEL（電文選択）の場合、要求電文のESFRW_TELEGRAMアドレスを設定してください。設定するESFRW_TELEGRAMアドレスは、電文情報プラグインで渡したアドレスです。

呼び出し契機がESFRW_TIMING_TEL（電文選択）以外の場合、設定する必要はありません。システムテスト支援は設定値を無視します。

interval_time

呼び出し契機がESFRW_TIMING_TEL（電文選択）、かつ、テスト実行までの間隔を空けたい場合は、テスト実行までの時間（ミリ秒単位）を設定してください。

設定可能な値は0〜1048576です。なお、CPU状態やシステムテスト支援の状態等により、指定時間より遅れてテスト実行される場合があります。

呼び出し契機がESFRW_TIMING_TEL（電文選択）以外の場合、設定する必要はありません。システムテスト支援は設定値を無視します。

scenario_cnt

呼び出し契機がESFRW_TIMING_SCENARIO（シナリオ数選択）の場合、同時実行するシナリオ数を設定してください。設定可能な値は0〜65535です。呼び出し契機がESFRW_TIMING_TEL（電文選択）の場合は設定する必要はありません。システムテスト支援は設定値を無視します。

リターン値

次のコードでリターン値を設定してください。

ESFRW_OK

call_timingがESFRW_TIMING_SCENARIOの場合は、シナリオ数を追加します。

call_timingがESFRW_TIMING_TELの場合は、シナリオを継続します。

ESFRW_END

call_timingがESFRW_TIMING_SCENARIOの場合は、シナリオ数を追加しません。

call_timingがESFRW_TIMING_TELの場合は、シナリオを終了します。

ESFRW_END2

call_timingがESFRW_TIMING_SCENARIOの場合は、シナリオ数を追加しません。

call_timingがESFRW_TIMING_TELの場合は、シナリオを終了します。シナリオ数を再選択します。

ESFRW_NG

プラグイン処理中に異常が発生しました。ESFRW_ENDをリターンした時と同じ動作を行います。

上記以外

指定リターン値以外でリターンした場合、ESFRW_ENDをリターンした時と同じ動作を行います。

7.3.9 電文選択プラグイン

7.3.9　電文選択プラグイン