AbstractHttpRequestTestTemplate (Nablarch-API)

java.lang.Object
- nablarch.test.event.TestEventDispatcher
- - nablarch.test.core.http.HttpRequestTestSupport
  - - nablarch.test.core.http.AbstractHttpRequestTestTemplate<INF>

型パラメータ:: INF - テストケース情報の型

直系の既知のサブクラス:: BasicHttpRequestTestTemplate

@Published
public abstract class AbstractHttpRequestTestTemplate<INF extends TestCaseInfo>
extends HttpRequestTestSupport

リクエスト単体テストをテンプレート化するクラス。
本クラスを使用することで、リクエスト単体テストのテストソース、テストデータを定型化することができる。

 指定されたテストシートに定義されたテストを実行する.

 実行順序は以下のとおり。
 1. データシートからテストケースリスト(testCases LISTMAP）を取得
 2. 取得したテストケース分、以下を繰り返し実行
    1) データベース初期化
    2) ExecutionContext、HTTPリクエストを生成
    3) 業務テストコード用拡張ポイント呼出(beforeExecuteRequestメソッド）
    4) Tokenが必要な場合、Tokenを設定
    5) テスト対象のリクエスト実行
    6) 実行結果の検証
      ・HTTPステータスコード および メッセージID
      ・HTTPレスポンス値(リクエストスコープ値)
      ・検索結果
      ・テーブル更新結果
      ・フォワード先URI
      ・メッセージ同期送信で送信されたメッセージ
    7) 業務テストコード用拡張ポイント呼出(afterExecuteRequestメソッド）

 ※セッションスコープは原則利用しないため検証しない。
 　必要な場合afterExecuteRequestメソッドを拡張して検証すること。

テンプレートの拡張が可能となるよう、TestCaseInfoの型を総称化している。 TestCaseInfo のサブクラスを作成し、本クラスのサブクラスでその型を指定することで、テンプレートを拡張できる。以下に例を示す。

 public abstract class SpecialHttpRequestTestTemplate extends AbstractHttpRequestTestTemplate {

ネストされたクラスのサマリー
- クラスから継承されたネストされたクラス/インタフェース nablarch.test.core.http.HttpRequestTestSupport
  HttpRequestTestSupport.HtmlResourceExtensionFilter

フィールドのサマリー
- クラスから継承されたフィールド nablarch.test.core.http.HttpRequestTestSupport
  testClass
- クラスから継承されたフィールド nablarch.test.event.TestEventDispatcher
  testName

コンストラクタのサマリー

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`AbstractHttpRequestTestTemplate()` コンストラクタ。
	`AbstractHttpRequestTestTemplate(java.lang.Class<?> testClass)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`afterExecuteRequest(INF testCaseInfo, ExecutionContext context, Advice<INF> advice)` 各業務テストコードの拡張ポイントテスト対象リクエストの実行後に呼び出される。
`protected void`	`assertAll(INF testCaseInfo, java.util.Map<java.lang.String,java.lang.String> testCaseParams, ExecutionContext context, HttpResponse response)` 全アサートを実行する。
`protected void`	`assertContentFileName(INF testCaseInfo, HttpResponse response, ExecutionContext context)` コンテンツディスポジション・ヘッダに指定されたファイル名をアサートする。
`protected void`	`assertContentLength(INF testCaseInfo, ExecutionContext context)` コンテンツレングス・ヘッダの値をアサートする。
`protected void`	`assertContentType(INF testCaseInfo, HttpResponse response)` コンテンツタイプ・ヘッダの値をアサートする。
`protected void`	`assertForwardUri(INF testCaseInfo)` フォワード先URIをアサートする。
`protected void`	`assertResponse(INF testCaseInfo, HttpResponse response)` HTTPレスポンスオブジェクトの内容をアサートする。
`protected void`	`beforeExecuteRequest(INF testCaseInfo, ExecutionContext context, Advice<INF> advice)` 各業務テストコードの拡張ポイントテスト対象リクエストの実行前に呼び出される。
`protected void`	`clearPreviousTestData(INF testCaseInfo)` テストで使用するデータのキャッシュをクリアする
`protected ExecutionContext`	`createExecutionContext(INF testCaseInfo)` ExecutionContextを生成する。
`protected HttpRequest`	`createHttpRequest(INF testCaseInfo)` HTTPRequestパラメータを生成する。
`protected INF`	`createTestCaseInfo(java.lang.String sheetName, java.util.Map<java.lang.String,java.lang.String> testCaseParams)` テストケース情報を作成する。
`protected INF`	`createTestCaseInfo(java.lang.String sheetName, java.util.Map<java.lang.String,java.lang.String> testCaseParams, java.util.List<java.util.Map<java.lang.String,java.lang.String>> contexts, java.util.List<java.util.Map<java.lang.String,java.lang.String>> requests, java.util.List<java.util.Map<java.lang.String,java.lang.String>> expectedResponses, java.util.List<java.util.Map<java.lang.String,java.lang.String>> cookie)` テストケース情報を作成する。
`void`	`execute(java.lang.String sheetName)` テストを実行する。
`void`	`execute(java.lang.String sheetName, Advice<INF> advice)` テストを実行する。
`void`	`execute(java.lang.String sheetName, Advice<INF> advice, boolean shouldSetUpDb)` テストを実行する。
`void`	`execute(java.lang.String sheetName, boolean shouldSetUpDb)` テストを実行する。
`protected void`	`executeTestCase(java.lang.String sheetName, java.util.Map<java.lang.String,java.lang.String> testCaseParams, Advice<INF> advice)` テストケースを実行する。
`protected abstract java.lang.String`	`getBaseUri()` ベースURIを返却する。
`protected java.util.List<java.util.Map<java.lang.String,java.lang.String>>`	`getCachedListMap(java.lang.String sheetName, java.lang.String listMapName)` キャッシュからLIST_MAPを取得する。
`protected void`	`setUp(INF testCaseInfo, java.util.Map<java.lang.String,java.lang.String> testCaseParams)` 準備を行う。
`protected void`	`setUpDbForTestCase(INF testCaseInfo)` テストケース毎のデータベースセットアップを行う。
`protected void`	`setUpMessage(INF testCaseInfo, java.util.Map<java.lang.String,java.lang.String> testCaseParams)` メッセージ同期送信のリクエスト単体テストを実行するための準備を行う

クラスから継承されたメソッド nablarch.test.core.http.HttpRequestTestSupport
assertApplicationMessageId, assertApplicationMessageId, assertApplicationMessageId, assertApplicationMessageId, assertEntity, assertForward, assertObjectArrayPropertyEquals, assertObjectListPropertyEquals, assertObjectPropertyEquals, assertSqlResultSetEquals, assertSqlRowEquals, assertStatusCode, assertTableEquals, assertTableEquals, assertTableEquals, copyHtmlResourceToDumpDir, createExecutionContext, createHttpRequest, createHttpRequestWithConversion, createHttpServer, createHttpServer, deleteHtmlResourceFile, execute, execute, getAbsoluteCssUriPrefix, getDumpFile, getFileFilter, getListMap, getListParamMap, getParamMap, getTestSupportHandler, initializeIfNotYet, is3XXStatusCode, prepareHandlerQueue, resetHttpServer, rewritePath, rewriteResourceFile, setDumpFile, setHttpHeader, setToken, setUpDb, setUpDb, setValidToken

クラスから継承されたメソッド nablarch.test.event.TestEventDispatcher
dispatchEventOfAfterTestClass, dispatchEventOfAfterTestMethod, dispatchEventOfBeforeTestClassAndBeforeSuit, dispatchEventOfBeforeTestMethod, getMethodName

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - AbstractHttpRequestTestTemplate
```
protected AbstractHttpRequestTestTemplate()
```
    コンストラクタ。
  - AbstractHttpRequestTestTemplate
```
public AbstractHttpRequestTestTemplate(java.lang.Class<?> testClass)
```
    コンストラクタ。
    
    パラメータ:
    
    testClass - テストクラス
- メソッドの詳細
  - execute
```
public void execute(java.lang.String sheetName)
```
    テストを実行する。
    実行前後に特別な処理が不要な場合は、このメソッドを使用する。
    
    パラメータ:
    
    sheetName - テスト対象のシート名
  - execute
```
public void execute(java.lang.String sheetName,
                    boolean shouldSetUpDb)
```
    テストを実行する。データベースのセットアップ要否を指定できる。
    
    パラメータ:
    
    sheetName - シート名
    
    shouldSetUpDb - データベースのセットアップ要否
  - execute
```
public void execute(java.lang.String sheetName,
                    Advice<INF> advice)
```
    テストを実行する。テスト前後に特別な準備処理や結果確認処理が必要な場合はこのメソッドを使用する。
    
    パラメータ:
    
    sheetName - テスト対象シート名
    
    advice - 実行前後の処理を実装したAdvice
  - execute
```
public void execute(java.lang.String sheetName,
                    Advice<INF> advice,
                    boolean shouldSetUpDb)
```
    テストを実行する。
    
    パラメータ:
    
    sheetName - シート名
    
    advice - コールバック
    
    shouldSetUpDb - データベースのセットアップ要否
  - executeTestCase
```
protected void executeTestCase(java.lang.String sheetName,
                               java.util.Map<java.lang.String,java.lang.String> testCaseParams,
                               Advice<INF> advice)
```
    テストケースを実行する。
    
    パラメータ:
    
    sheetName - シート名
    
    testCaseParams - テストケースパラメータ
    
    advice - 実行前後の処理を実装したAdvice
  - clearPreviousTestData
```
protected void clearPreviousTestData(INF testCaseInfo)
```
    テストで使用するデータのキャッシュをクリアする
    
    パラメータ:
    
    testCaseInfo - テストケース情報
  - setUp
```
protected void setUp(INF testCaseInfo,
                     java.util.Map<java.lang.String,java.lang.String> testCaseParams)
```
    準備を行う。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    testCaseParams - テストケースパラメータ
  - setUpDbForTestCase
```
protected void setUpDbForTestCase(INF testCaseInfo)
```
    テストケース毎のデータベースセットアップを行う。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
  - setUpMessage
```
protected void setUpMessage(INF testCaseInfo,
                            java.util.Map<java.lang.String,java.lang.String> testCaseParams)
```
    メッセージ同期送信のリクエスト単体テストを実行するための準備を行う
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    testCaseParams - テストケースパラメータ
  - createTestCaseInfo
```
protected INF createTestCaseInfo(java.lang.String sheetName,
                                 java.util.Map<java.lang.String,java.lang.String> testCaseParams)
```
    テストケース情報を作成する。
    
    パラメータ:
    
    sheetName - シート名
    
    testCaseParams - テストケースパラメータ
    
    戻り値:
    
    作成したテストケース情報
  - createTestCaseInfo
```
protected INF createTestCaseInfo(java.lang.String sheetName,
                                 java.util.Map<java.lang.String,java.lang.String> testCaseParams,
                                 java.util.List<java.util.Map<java.lang.String,java.lang.String>> contexts,
                                 java.util.List<java.util.Map<java.lang.String,java.lang.String>> requests,
                                 java.util.List<java.util.Map<java.lang.String,java.lang.String>> expectedResponses,
                                 java.util.List<java.util.Map<java.lang.String,java.lang.String>> cookie)
```
    テストケース情報を作成する。
    
    パラメータ:
    
    sheetName - シート名
    
    testCaseParams - テストケースパラメータ
    
    contexts - コンテキスト全件
    
    requests - リクエスト全件
    
    expectedResponses - 期待するレスポンス全件
    
    cookie - 本テストで使用するクッキー情報
    
    戻り値:
    
    作成したテストケース情報
  - createExecutionContext
```
protected ExecutionContext createExecutionContext(INF testCaseInfo)
```
    ExecutionContextを生成する。
    
    パラメータ:
    
    testCaseInfo - テスト情報
    
    戻り値:
    
    ExecutionContextインスタンス
  - createHttpRequest
```
protected HttpRequest createHttpRequest(INF testCaseInfo)
```
    HTTPRequestパラメータを生成する。
    
    パラメータ:
    
    testCaseInfo - テスト情報
    
    戻り値:
    
    HttpRequestインスタンス
  - assertAll
```
protected void assertAll(INF testCaseInfo,
                         java.util.Map<java.lang.String,java.lang.String> testCaseParams,
                         ExecutionContext context,
                         HttpResponse response)
```
    全アサートを実行する。
    以下の項目についてアサートを実施する。
    - HTTPステータスコードおよびメッセージID
    - リクエストスコープの値検証
    - 検索結果の検証
    - テーブル更新結果の検証
    - フォワード先URI
    - メッセージ同期送信で送信されたメッセージ
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    testCaseParams - テストケースパラメータ
    
    context - ExecutionContextインスタンス
    
    response - HttpResponseインスタンス
  - assertResponse
```
protected void assertResponse(INF testCaseInfo,
                              HttpResponse response)
```
    HTTPレスポンスオブジェクトの内容をアサートする。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    response - レスポンスオブジェクト
  - assertContentLength
```
protected void assertContentLength(INF testCaseInfo,
                                   ExecutionContext context)
```
    コンテンツレングス・ヘッダの値をアサートする。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    context - ExecutionContext
  - assertContentType
```
protected void assertContentType(INF testCaseInfo,
                                 HttpResponse response)
```
    コンテンツタイプ・ヘッダの値をアサートする。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    response - HTTPレスポンス
  - assertContentFileName
```
protected void assertContentFileName(INF testCaseInfo,
                                     HttpResponse response,
                                     ExecutionContext context)
```
    コンテンツディスポジション・ヘッダに指定されたファイル名をアサートする。
    コンテンツタイプがHTMLの場合はアサートしない。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    response - HTTPレスポンス
    
    context - ExecutionContext
  - assertForwardUri
```
protected void assertForwardUri(INF testCaseInfo)
```
    フォワード先URIをアサートする。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
  - getCachedListMap
```
protected java.util.List<java.util.Map<java.lang.String,java.lang.String>> getCachedListMap(java.lang.String sheetName,
                                                                                            java.lang.String listMapName)
```
    キャッシュからLIST_MAPを取得する。
    キャッシュにない場合は、データシートから取得しメモリ上にキャッシュする。
    
    パラメータ:
    
    sheetName - データシート名
    
    listMapName - LIST_MAP名
    
    戻り値:
    
    LIST_MAP
  - getBaseUri
```
protected abstract java.lang.String getBaseUri()
```
    ベースURIを返却する。
    
    戻り値:
    
    ベースURI
  - beforeExecuteRequest
```
protected void beforeExecuteRequest(INF testCaseInfo,
                                    ExecutionContext context,
                                    Advice<INF> advice)
```
    各業務テストコードの拡張ポイント
    テスト対象リクエストの実行前に呼び出される。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    context - ExecutionContextインスタンス
    
    advice - 実行前後の処理を実装したAdvice
  - afterExecuteRequest
```
protected void afterExecuteRequest(INF testCaseInfo,
                                   ExecutionContext context,
                                   Advice<INF> advice)
```
    各業務テストコードの拡張ポイント
    テスト対象リクエストの実行後に呼び出される。処理が不要であれば空実装でかまわない。
    
    パラメータ:
    
    testCaseInfo - テストケース情報
    
    context - ExecutionContextインスタンス
    
    advice - 実行前後の処理を実装したAdvice

クラス AbstractHttpRequestTestTemplate<INF extends TestCaseInfo>

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース nablarch.test.core.http.HttpRequestTestSupport

フィールドのサマリー

クラスから継承されたフィールド nablarch.test.core.http.HttpRequestTestSupport

クラスから継承されたフィールド nablarch.test.event.TestEventDispatcher

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド nablarch.test.core.http.HttpRequestTestSupport

クラスから継承されたメソッド nablarch.test.event.TestEventDispatcher

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

AbstractHttpRequestTestTemplate

AbstractHttpRequestTestTemplate

メソッドの詳細

execute

execute

execute

execute

executeTestCase

clearPreviousTestData

setUp

setUpDbForTestCase

setUpMessage

createTestCaseInfo

createTestCaseInfo

createExecutionContext

createHttpRequest

assertAll

assertResponse

assertContentLength

assertContentType

assertContentFileName

assertForwardUri

getCachedListMap

getBaseUri

beforeExecuteRequest

afterExecuteRequest