Hitachi

Hitachi System Information Capture リファレンス 


7.3.2 開始終了プラグイン

機能

プラグインの開始終了処理を行います。

形式

ANSI C、C++の形式

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

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

説明

システムテスト支援プロセスの開始/終了時に1回だけ呼び出されるプラグインです。

プラグインでは、プラグイン用の初期化処理や後処理等を行います。

パラメタの内容

ESFRW_STEN_IFのパラメタ内容

typedef struct es_frw_sten_interface {
  ESULONG         call_timing; ……………… 呼び出し契機
  char            reserve1[4]; ……………… 予備
  ESFRW_COMMON    *cominf; …………………… プラグイン共通項目
  ESULONG         sel_mode; …………………… 実行モード
  ESFRW_EXT_INF   extinf;   …………………… CSVファイル拡張情報
} ESFRW_STEN_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];……………… 予備
  char            user_file[512]; ………… シナリオファイル名
  ESULONG         execution_count;………… シナリオ実行回数
  ESULONG         parallel_count; ………… シナリオ同時実行数
  char            *esstop_execution; ……  esstopコマンド実行有無
} ESFRW_COMMON;

ESFRW_EXT_INFのパラメタ内容

typedef struct es_frw_cominfo {
  char            info1[256]; ……………… 拡張情報1
  char            info2[256]; ……………… 拡張情報2
} ESFRW_EXT_INF;

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

[図データ]

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

ESFRW_STEN_IFのパラメタ項目

call_timing

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

ESFRW_TIMING_ST:プロセス開始時

ESFRW_TIMING_EN:プロセス終了時

cominf

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

sel_mode

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

システム検証支援はデフォルト値として、ESFRW_MODE_SEQ(逐次実行モード)を設定します。

extinf

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

システムテスト支援では、NULLクリアしてプラグインを読み出します。

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を設定します。

user_file

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

execution_count

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

parallel_count

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

esstop_execution

esstopコマンドが実行されたか否かを設定します。以下のどちらかとなります。

ESCOM_NO:esstopコマンド未実行

ESCOM_YES:esstopコマンド実行済み

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

ESFRW_STEN_IFのパラメタ項目

sel_mode

以下の条件を全て満たす場合、実行モードを設定してください。

  • テスト実行フェーズ

  • 呼び出し契機がESFRW_TIMING_ST(プロセス開始時)

設定値は以下のどちらかとなります。

ESFRW_SELMODE_SEQ:逐次実行モード(デフォルト値)

ESFRW_SELMODE_SCE:シナリオ実行モード

条件を満たさない場合は設定する必要はありません。条件を満たさない場合の設定値は、テスト実行時に無視されます。

extinf

電文出力先ファイル(電文ファイル又は結果ファイル)がCSVファイルの場合、CSVファイル拡張情報として、プラグインが任意の情報を最大で2列まで出力する事ができます。以下の条件を全て満たす場合、ファイル拡張情報の1つ目(拡張情報1)と2つ目(拡張情報2)のヘッダ名称を設定してください。設定した名称は、各ファイルの先頭のヘッダ列として出力されます。

  • 呼び出し契機がESFRW_TIMING_ST(プロセス開始時)

  • 電文ファイル又は結果ファイルの種別がCSVファイル

  • CSVファイル内に拡張情報を追加する

ESFRW_COMMONのパラメタ項目

execution_count

以下の条件を全て満たす場合、シナリオの実行回数を設定してください。

  • バッチ実行実行フェーズ

  • 呼び出し契機がESFRW_TIMING_ST(プロセス開始時)

本項目で設定した値が、framework_definition定義の-pオプションのexecution_countフラグメンバで設定したものとして扱われます。

条件を満たさない場合は設定する必要はありません。システム検証支援基盤は設定値を無視します。

parallel_count

以下の条件を全て満たす場合、シナリオの同時実行数を設定してください。

  • バッチ実行実行フェーズ

  • 呼び出し契機がESFRW_TIMING_ST(プロセス開始時)

本項目で設定した値が、framework_definition定義の-pオプションのparallel_countフラグメンバで設定したものとして扱われます。

条件を満たさない場合は設定する必要はありません。システム検証支援基盤は設定値を無視します。

ESFRW_EXT_INFのパラメタ項目

info1

CSVファイルの拡張情報1を設定してください。

info2

CSVファイルの拡張情報2を設定してください。

リターン値

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

ESFRW_OK

正常にリターンしました。処理を続行します。

ESFRW_NG

エラーが発生しました。システム検証支援プロセスは終了します。

上記以外

指定リターン値以外でリターンした場合、システム検証支援プロセスは終了します。

注意事項