7.3.6　電文送信プラグイン

機能

送信する電文の編集や情報設定を行います。

形式

ANSI C、C++の形式

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

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

説明

電文送信プラグインは、テスト対象システムの要求電文の送信前に、電文の編集や電文情報の設定を行います。

パラメタの内容

ESFRW_SEND_IFのパラメタ内容

typedef struct es_frw_send_interface {
  ESULONG         call_timing;  …………… 呼び出し契機
  char            reserve1[4];  …………… ペアリングキー
  ESFRW_COMMON    *cominf;  ………………… プラグイン共通情報
  ESFRW_CLIENT    *cltinf;  ………………… テスト実行単位情報
  ESFRW_TELEGRAM  *tst_telinf;  …………… 要求電文（テスト環境）情報
  ESFRW_TELEGRAM  *pro_telinf;  …………… 要求電文（本番環境）情報
  ESCOM_AREA      edit_area;  ……………… 編集電文格納領域
  ESULONG         head_sz;  ………………… 電文のヘッダサイズ（HTTPのみ）
  ESULONG         data_sz;  ………………… 電文のデータサイズ
  char            pair_key[64]; …………… ペアリングキー
  void            *protocol_edit; ………… プロトコル固有の編集情報
} ESFRW_SEND_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;    ………………… 電文拡張情報
  void            *protocol_telinf; ……… プロトコル固有情報
} ESFRW_TELEGRAM;

ESFRW_SEND_IF_RPCの内容

typedef struct es_frw_send_interface_rpc {
  char         group[32]; ………………… サービスグループ名
  char         service[32]; ……………… サービス名
   ESULONG     out_len; …………………… 応答データ長
} ESFRW_SEND_IF_RPC;

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_EDIT_IFのパラメタ項目

call_timing

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

ESFRW_TIMING_PKTSND：テスト対象への送信時

cominf

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

cltinf

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

tst_telinf

編集前の要求電文（テスト環境）の情報（サイズ等）を格納しているESFRW_TELEGRAMアドレスを設定します。

tst_telinf

編集前の要求電文（本番環境）の情報（サイズ等）を格納しているESFRW_TELEGRAMアドレスを設定します。

edit_area

編集後電文の格納領域情報（格納先アドレス、領域サイズ）を設定します。領域サイズは、framework_definition定義の-bオプションのmax_message_sizeフラグメンバ値となります。

head_sz

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

data_sz

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

pair_key

ユーザが設定する項目です。システム検証支援では、電文情報プラグイン（ESFRW_TIMING_FILRED）で設定した要求電文（本番環境）のペアリングキー値を基に、デフォルト値を設定します。

要求電文（本番環境）のペアリングキーが、コネクション（本番環境）毎にユニークとなる値（デフォルト値をそのまま使用）の場合、デフォルト値として、コネクション（テスト環境）毎にユニークとなる値を設定します。このデフォルト値を使用した場合、同一コネクションの要求電文と応答電文がペアリングされます。

それ以外の場合、デフォルト値として、要求電文（本番環境）と同じペアリングキーを設定します。

protocol_telinf

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

RPC：ESFRW_SEND_IF_RPC

RPC以外：NULL

ESFRW_COMMONのパラメタ項目

run_mode

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

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

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

ESCLT_RUNMODE_R：テスト実行フェーズ

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

ESFRW_PROT_RPC：RPC

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ファイル内に拡張情報が存在する（電文作成フェーズにおいて、電文ファイルに拡張情報を追加した）

[図データ]

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_SEND_IF_RPCのパラメタ項目

group: ユーザが設定する項目です。システム検証支援では、本番環境のサービスグループ名を、デフォルト値として設定します。

service: ユーザが設定する項目です。システム検証支援では、本番環境のサービス名を、デフォルト値として設定します。

out_len: ユーザが設定する項目です。システム検証支援では、応答型の要求電文の場合は本番環境の応答データ長（dc_rpc_call()等で指定したout_len値）を設定します。それ以外の場合は0を設定します。

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

ESFRW_SEND_IFのパラメタ項目

head_sz

プロトコル種別がHTTPの場合、HTTPヘッダ（リクエスト行／レスポンス行、HTTPヘッダとHTTPボディ間の空行（\r\n）含む）のサイズを1〜max_message_sizeの範囲で設定してください。HTTPヘッダを編集しない場合は、編集前のHTTPヘッダを編集後領域へ複写後、編集前のHTTPヘッダサイズを設定してください。

プロトコル種別がTCPの場合、設定する必要はありません。システムテスト支援は設定値を無視し、0バイトとして処理します。

ヘッダサイズとデータサイズの合計値がmax_message_size以下となるように設定してください。

data_sz

データのサイズを設定してください。

プロトコル種別がHTTPの場合、HTTPボディ部のサイズを0〜max_message_sizeの範囲を設定してください。0を指定した場合、HTTPヘッダのみの電文として処理を行います。

プロトコル種別がTCPの場合、データのサイズを1〜max_message_sizeの範囲を設定してください。

ヘッダサイズとデータサイズの合計値がmax_message_size以下となるように設定してください。

pair_key

プロトコル種別がTCP、かつ電文形態が同期応答型の場合、ペアとなる要求電文と応答電文で同じ値となるペアリングキーを設定してください。

ペアとなる応答電文（テスト環境）の受信時は、電文情報プラグインにおいて、このペアリングキーと同じ値を設定してください。

[図データ]

ESFRW_SEND_IF_RPCのパラメタ項目

group: 本番環境とテスト環境でサービスグループ名が異なる場合、テスト環境のサービスグループ名を設定してください。

service: 本番環境とテスト環境でサービス名が異なる場合、テスト環境のサービス名を設定してください。

out_len: 本番環境とテスト環境で応答データ長が異なる場合、テスト環境の応答データ長を設定してください。非応答型の場合、設定値を無視します。

リターン値

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

ESFRW_OK: 正常に終了しました。編集前の電文を送信します。
ESFRW_OK_EDIT: 正常に終了しました。編集後の電文を送信します。
ESFRW_CANCEL: 電文を送信しません。
ESFRW_NG: プラグイン処理中に異常が発生しました。電文を送信しません。
上記以外: 指定リターン値以外でリターンした場合、電文を送信しません。

注意事項

UOCで設定した値に不正があった場合、電文を送信しません。

ページの先頭へ

7.3.6 電文送信プラグイン

7.3.6　電文送信プラグイン