リクエスト単体テストの実施方法(同期応答メッセージ受信処理)¶
テストクラスの書き方¶
テストクラスは以下の条件を満たすように作成する。
- テストクラスのパッケージは、テスト対象のActionクラスと同じとする。
- <Actionクラス名>RequestTestというクラス名でテストクラスを作成する。
nablarch.test.core.http.MessagingRequestTestSupportを継承する。
例えば、テスト対象のActionクラスが、nablarch.sample.ss21AA.RM21AA001Actionだとすると、テストクラスは以下のようになる。
package nablarch.sample.ss21AA;
// ～中略～
public class RM21AA001ActionRequestTest extends MessagingRequestTestSupport {
テストデータの書き方¶
テストデータを記載したExcelファイルは、クラス単体テストと同様にテストソースコードと同じディレクトリに同じ名前で格納する（拡張子のみ異なる）。
テストデータの記述方法詳細については、「Excelによるテストデータ記述」を参照。
テストクラスで共通のデータベース初期値¶
ウェブアプリケーションの場合と同様である。「テストクラスで共通のデータベース初期値」を参照。
テストショット一覧¶
LIST_MAPのデータタイプで１テストメソッド分のテストショット表を記載する。IDは、testShotsとする。
１ケース毎に以下の要素を持たせる。
| カラム名 | 説明 | 必須 |
|---|---|---|
| no | テストケース番号を1からの連番で記載する。 | 必須 |
| description | そのテストケースの説明を記載する。 | 必須 |
| expectedStatusCode | 期待するステータスコード | 必須 |
| setUpTable | 各テストケース実行前にデータベースに登録する場合は、同じシート内に記載したデータのグループIDを記載する[1]。データの投入は自動テストフレーム ワークにより行われる。 | |
| expectedTable | データベースの内容を比較する場合、期待するテーブルのグループIDを記載する[1]。 | |
| expectedLog | 期待するログメッセージのIDを記載する。そのログメッセージが実際に出力されたかどうか、 自動テストフレームワークにて検証される。 | |
| diConfig | 常駐プロセスを実行する際のコンポーネント設定ファイルへのパスを記載する 。 (コマンドライン引数を参照)[2] | 必須 |
| requestPath | 常駐プロセスを実行する際のリクエストパスを記載する。 (コマンドライン引数を参照)[2] | 必須 |
| userId | 常駐プロセス実行ユーザIDを記載する。 (コマンドライン引数を参照)[2] | 必須 |
| [1] | (1, 2) デフォルトのグループIDを使用したい（グループIDを使わない）場合は、defaultと記載する。 デフォルトのグループIDと個別のグループは併用可能である。 両方のデータが混在した場合、デフォルトのグループIDのデータとグループID指定のデータ両方が有効になる。 |
| [2] | (1, 2, 3) ここで言う「常駐プロセス」とは、メッセージ送受信を行うプロセスのことである。 |
各種準備データ¶
テスト実施に際して必要となる各種準備データの記述方法を説明する。 バッチでは、データベース、リクエストメッセージを準備する。
リクエストメッセージ¶
テストの入力データとなる要求電文を記載する。以下に例を示す。
MESSAGE=setUpMessages
// 共通情報（ディレクティブ、フレームワーク制御ヘッダ）
text-encoding Windows-31J record-separator CRLF requestId RM11AC0101 // メッセージボディ
no レコード区分 ユーザID 半角 半角 1 10 1 7 0000000001 2 2 0000000001
- 先頭行
テスト対象リクエストに対する要求電文を準備する。名前は、MESSAGE=setUpMessages固定とする。
- 共通情報
名前の次行以降には以下の情報を記載する。これらの値は、リクエストメッセージの全メッセージで共通の値となる。
- ディレクティブ
- フレームワーク制御ヘッダ
書式は、key-value形式である。
キー 値
重要
フレームワーク制御ヘッダの項目をPJで変更している場合、
以下のようにpropertiesファイルに reader.fwHeaderfields というキーでフレームワーク制御ヘッダ名を指定する必要がある。
# フレームワーク制御ヘッダ名をカンマ区切りで指定する。
reader.fwHeaderfields=requestId,addHeader
- メッセージボディ
フレームワーク制御ヘッダ以降のメッセージを記載する。 1行目～3行目は、外部インターフェース設計書の記載内容と同じであり、 設計書から行列を入れ替えてコピーすると効率良く作成できる。
行 記述内容 備考 1行目 フィールド名称 先頭セルは”no”とする。 2行目 データタイプ 先頭セルは空白 3行目 フィールド長 先頭セルは空白 4行目以降 データ 先頭セルは1からの通番
重要
フィールド名称に重複した名称は許容されない。 例えば、「氏名」というフィールドが2つ以上存在してはならない。 （通常、このような場合は「本会員氏名」と「家族会員氏名」のようにユニークなフィールド名称が付与される）
本表は、テストショット一覧のnoと対応関係にある。すなわち、テストショットno1で使用される要求電文は、本表の1行目（no 1）のデータとなる。
各種期待値¶
検索結果、データベースを期待値と比較する場合は、 それぞれのデータとテストケース一覧とをIDで紐付けする。
レスポンスメッセージ¶
リクエストメッセージと同じ。
ただし、名前がMESSAGE=expectedMessagesとなる。
また、テストデータのディレクティブに設定されたfile-typeの値により、以下のように応答電文のアサート方法が変化する。
file-typeの値 アサート方法 Fixed または 指定なし テストデータに記載された項目単位に電文を分割し、アサートを行う。 その他の値 電文全体を文字列として扱い、アサートを行う。
フォーマット定義ファイルではなく、テストデータにfile-typeを設定する必要があるので、注意すること。
なお、項目単位にアサートを行うfile-typeの値は以下の値を環境設定ファイルに定義することにより変更可能である。
messaging.assertAsMapFileType=<カンマ区切りのfile-typeリスト>
補足
テストメソッドの書き方¶
スーパクラスについて¶
MessagingRequestTestSupportクラスを継承する。
このクラスでは、準備したテストデータを元に以下の手順でリクエスト単体テストを実行する。
スーパクラスのメソッド呼び出し¶
テストメソッド内で、スーパクラスの以下のいずれかのメソッドを呼び出す。
- void execute()
- void execute(String sheetName)
引数ありのexecuteメソッドでは、テストデータのシート名を指定できる。 引数なしのexecuteメソッドを使用すると、引数ありのexecuteメソッドに テストデータのシート名にテストメソッド名を指定した場合と同じ動作となる。
通常、テストシート名とテストメソッド名は同一であるので、 引数なしのexecuteメソッドを使用するとよい。
@Test
public void testRegisterUser() {
execute(); // 【説明】execute("testRegisterUser") と等価
}
テスト起動方法¶
クラス単体テストと同様。通常のJUnitテストと同じように実行する。