nablarch.test.core.http

クラス TestCaseInfo

java.lang.Object

nablarch.test.core.http.TestCaseInfo

@Published
public class TestCaseInfo
extends Object

データシートに定義されたテストケース情報を格納するクラス。

作成者:

Tsuyoshi Kawasaki

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected static String	CASE テストケースを記述しているカラム名
protected static String	CONTEXT_LIST_MAP コンテキストパラメータのLIST_MAP定義名
protected static String	COOKIE_LIST_MAP CookieのLIST_MAP定義名
protected static String	DEFAULT_SEARCH_RESULT_KEY リクエストスコープに格納する検索結果のキー名
protected static String	DESCRIPTION ショットの説明を記述しているカラム名
protected static String	EXPECTED_CONTENT_FILENAME コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_CONTENT_LENGTH コンテンツレングス・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_CONTENT_TYPE コンテンツタイプ・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_FORWARD_URI 期待するフォワードURIを定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_HTTP_STATUS_COLUMN HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_MESSAGE_COLUMN 要求電文の期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_MESSAGE_ID_COLUMN HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_SEARCH_COLUMN 検索結果の期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	EXPECTED_TABLE_COLUMN テーブル期待値を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	IS_VALID_TOKEN トークンを設定するかどうかを記述しているカラム名
protected static String	REQUEST_ID リクエストIDを定義しているカラム名
protected static String	RESPONSE_MESSAGE_COLUMN 応答電文を定義しているカラム名(LIST_MAP＝テストケース）
protected static String	SET_UP_TABLE データベースにデータを投入する際のグループIDを表すカラム名
protected static String	TEST_CASE_NO テストケース番号を定義しているカラム名
protected static String	USER_ID_COLUMN_NAME ユーザIDを定義しているカラム名

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

コンストラクタ

コンストラクタと説明
TestCaseInfo(String sheetName, Map testCaseParams, List<Map> context, List<Map> request, List<Map> expectedResponseListMap) コンストラクタ
TestCaseInfo(String sheetName, Map testCaseParams, List<Map> context, List<Map> request, List<Map> expectedResponseListMap, List<Map> cookie) コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Map	getCookie() Cookieを返却する。
String	getExpectedContentFileName() コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を返却する。
String	getExpectedContentLength() コンテンツレングス・ヘッダの期待値を返却する。
String	getExpectedContentType() コンテンツタイプ・ヘッダの期待値の期待値を返却する。
String	getExpectedForwardUri() フォワード先URIの期待値を返却する。
String	getExpectedMessage() 要求電文（期待値）を返却する.
String	getExpectedMessageId() メッセージID（期待値）を返却する.
Map	getExpectedRequestScopeVar() HTTPレスポンス（期待値）を返却する.
String	getExpectedSearchId() 検索結果検証の期待値を特定するIDを返却する.
String	getExpectedStatusCode() HTTPステータスコード(期待値)を返却する.
String	getExpectedTable() テーブル検証の期待値を特定するIDを返却する.
nablarch.fw.web.HttpRequest	getHttpRequest() HTTPリクエストを取得する。
String	getRequestId() テスト対象とするリクエストIDを返却する.
Map	getRequestParameters() データシートに定義されたリクエストパラメータを取得する デフォルトでは、LIST_MAP「testCases」の「requestParams」カラムで指定されている LIST_MAPのレコードを取得する
String	getResponseMessage() 応答電文を返却する.
String	getSearchResultKey() リクエストスコープ内に格納された検索結果を取得するためのキーを取得する。
String	getSetUpTableGroupId() テーブルセットアップデータ定義を特定するためのIDを返却する.
String	getSheetName() データシート名を返却する
String	getTestCaseName() テストケース名称を取得する.
String	getTestCaseNo() テストケース番号を取得する。
String	getUserId() ユーザIDを取得する。
protected String	getValue(Map row, String columnName) LIST_MAPから取得したレコードから、指定したカラム名に対応する値を取得する
boolean	isAssertApplicationMessageId() メッセージIDの検証を行うかどうかを返却する。
boolean	isAssertRequestScopeVar() リクエストスコープ値を比較検証するかどうかを返却する.
boolean	isAssertSearch() 検索結果の検証をするかどうかを返却する.
boolean	isAssertTable() テーブル値を検証するかどうか返却する.
boolean	isRequestParametersSet() リクエストパラメータを設定するかどうかを返却する
boolean	isSetUpTable() テーブルをセットアップするかどうかを返却する.
boolean	isValidToken() トークン制御を行うかどうかを返却する.
void	setIsAssertApplicationMessageId(boolean isAssert) メッセージIDの検証を行うかどうかを設定する。
void	setIsAssertRequestScopeVar(boolean isAssert) リクエストスコープ値を比較検証するかどうかを設定する 各テストケースにて比較検証を個別実装する場合にfalseに設定する。
void	setSearchResultKey(String searchResultKey) リクエストスコープ内に格納された検索結果を取得するためのキーを設定する。

フィールドの詳細

USER_ID_COLUMN_NAME

protected static final String USER_ID_COLUMN_NAME

ユーザIDを定義しているカラム名

関連項目:

定数フィールド値

REQUEST_ID

protected static final String REQUEST_ID

リクエストIDを定義しているカラム名

関連項目:

定数フィールド値

TEST_CASE_NO

protected static final String TEST_CASE_NO

テストケース番号を定義しているカラム名

関連項目:

定数フィールド値

CASE

protected static final String CASE

テストケースを記述しているカラム名

関連項目:

定数フィールド値

DESCRIPTION

protected static final String DESCRIPTION

ショットの説明を記述しているカラム名

関連項目:

定数フィールド値

CONTEXT_LIST_MAP

protected static final String CONTEXT_LIST_MAP

コンテキストパラメータのLIST_MAP定義名

関連項目:

定数フィールド値

COOKIE_LIST_MAP

protected static final String COOKIE_LIST_MAP

CookieのLIST_MAP定義名

関連項目:

定数フィールド値

IS_VALID_TOKEN

protected static final String IS_VALID_TOKEN

トークンを設定するかどうかを記述しているカラム名

関連項目:

定数フィールド値

SET_UP_TABLE

protected static final String SET_UP_TABLE

データベースにデータを投入する際のグループIDを表すカラム名

関連項目:

定数フィールド値

EXPECTED_HTTP_STATUS_COLUMN

protected static final String EXPECTED_HTTP_STATUS_COLUMN

HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

EXPECTED_MESSAGE_ID_COLUMN

protected static final String EXPECTED_MESSAGE_ID_COLUMN

HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

EXPECTED_SEARCH_COLUMN

protected static final String EXPECTED_SEARCH_COLUMN

検索結果の期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

EXPECTED_TABLE_COLUMN

protected static final String EXPECTED_TABLE_COLUMN

テーブル期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

EXPECTED_MESSAGE_COLUMN

protected static final String EXPECTED_MESSAGE_COLUMN

要求電文の期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

RESPONSE_MESSAGE_COLUMN

protected static final String RESPONSE_MESSAGE_COLUMN

応答電文を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

DEFAULT_SEARCH_RESULT_KEY

protected static final String DEFAULT_SEARCH_RESULT_KEY

リクエストスコープに格納する検索結果のキー名

関連項目:

定数フィールド値

EXPECTED_FORWARD_URI

protected static final String EXPECTED_FORWARD_URI

期待するフォワードURIを定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

EXPECTED_CONTENT_LENGTH

protected static final String EXPECTED_CONTENT_LENGTH

コンテンツレングス・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

EXPECTED_CONTENT_TYPE

protected static final String EXPECTED_CONTENT_TYPE

コンテンツタイプ・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

EXPECTED_CONTENT_FILENAME

protected static final String EXPECTED_CONTENT_FILENAME

コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を定義しているカラム名(LIST_MAP＝テストケース）

関連項目:

定数フィールド値

コンストラクタの詳細

TestCaseInfo

public TestCaseInfo(String sheetName,
                    Map testCaseParams,
                    List<Map> context,
                    List<Map> request,
                    List<Map> expectedResponseListMap)

コンストラクタ

パラメータ:

sheetName - テストシート名

testCaseParams - テストケースパラメータ

context - スレッドコンテキスト・ユーザコンテキスト生成用パラメータ

request - リクエストパラメータ

expectedResponseListMap - レスポンス期待値パラメータ

TestCaseInfo

public TestCaseInfo(String sheetName,
                    Map testCaseParams,
                    List<Map> context,
                    List<Map> request,
                    List<Map> expectedResponseListMap,
                    List<Map> cookie)

コンストラクタ

パラメータ:

sheetName - テストシート名

testCaseParams - テストケースパラメータ

context - スレッドコンテキスト・ユーザコンテキスト生成用パラメータ

request - リクエストパラメータ

expectedResponseListMap - レスポンス期待値パラメータ

cookie - Cookie情報

メソッドの詳細

getSearchResultKey

public String getSearchResultKey()

リクエストスコープ内に格納された検索結果を取得するためのキーを取得する。

戻り値:

キー

setSearchResultKey

public void setSearchResultKey(String searchResultKey)

リクエストスコープ内に格納された検索結果を取得するためのキーを設定する。

パラメータ:

searchResultKey - キー

getExpectedMessageId

public String getExpectedMessageId()

メッセージID（期待値）を返却する.

戻り値:

メッセージID（複数存在する場合はカンマ区切り）

getExpectedRequestScopeVar

public Map getExpectedRequestScopeVar()

HTTPレスポンス（期待値）を返却する.

戻り値:

リクエストスコープに設定されるはずの期待値

getExpectedSearchId

public String getExpectedSearchId()

検索結果検証の期待値を特定するIDを返却する.

戻り値:

テーブル期待値ID(expectedSearchカラムに定義したデータ)

getExpectedStatusCode

public String getExpectedStatusCode()

HTTPステータスコード(期待値)を返却する.

戻り値:

HTTPステータスコード

getExpectedTable

public String getExpectedTable()

テーブル検証の期待値を特定するIDを返却する.

戻り値:

テーブル期待値ID(expectedTableカラムに定義したデータ)

getExpectedForwardUri

public String getExpectedForwardUri()

フォワード先URIの期待値を返却する。

戻り値:

フォワード先URIの期待値

getExpectedContentLength

public String getExpectedContentLength()

コンテンツレングス・ヘッダの期待値を返却する。

戻り値:

コンテンツレングス・ヘッダの期待値

getExpectedContentType

public String getExpectedContentType()

コンテンツタイプ・ヘッダの期待値の期待値を返却する。

戻り値:

コンテンツタイプ・ヘッダの期待値の期待値

getExpectedContentFileName

public String getExpectedContentFileName()

コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を返却する。

戻り値:

コンテンツディスポジション・ヘッダに指定されたファイル名の期待値

getExpectedMessage

public String getExpectedMessage()

要求電文（期待値）を返却する.

戻り値:

要求電文（期待値）

getResponseMessage

public String getResponseMessage()

応答電文を返却する.

戻り値:

応答電文

getRequestId

public String getRequestId()

テスト対象とするリクエストIDを返却する.

戻り値:

リクエストID

getCookie

public Map getCookie()

Cookieを返却する。

戻り値:

Cookie情報

getRequestParameters

public Map getRequestParameters()

データシートに定義されたリクエストパラメータを取得する

 デフォルトでは、LIST_MAP「testCases」の「requestParams」カラムで指定されている
 LIST_MAPのレコードを取得する
 

戻り値:

リクエストパラメータ

isRequestParametersSet

public boolean isRequestParametersSet()

リクエストパラメータを設定するかどうかを返却する

戻り値:

boolean

getSetUpTableGroupId

public String getSetUpTableGroupId()

テーブルセットアップデータ定義を特定するためのIDを返却する.

 SETUP_TABLE[xxxx]=tableName  : 左記例のxxxの部分
 

戻り値:

セットアップデータID(setUpTableカラムに定義したデータ)

getSheetName

public String getSheetName()

データシート名を返却する

戻り値:

データシート名

getTestCaseName

public String getTestCaseName()

テストケース名称を取得する.
テスト失敗時のメッセージやHTMLファイル出力名に使用される。 デフォルトは、{データシート名}_{caseIndex}_{Case名}
例）RGBN00000000_Case0_初期表示

戻り値:

テストケース名称

getTestCaseNo

public String getTestCaseNo()

テストケース番号を取得する。

戻り値:

テストケース番号

getUserId

public String getUserId()

ユーザIDを取得する。

戻り値:

ユーザID

getValue

protected final String getValue(Map row,
                                String columnName)

LIST_MAPから取得したレコードから、指定したカラム名に対応する値を取得する

パラメータ:

row - 行レコード(LIST_MAPの各要素）

columnName - カラム名

戻り値:

指定したカラム名に対応する値

isAssertSearch

public boolean isAssertSearch()

検索結果の検証をするかどうかを返却する.

戻り値:

boolean

isAssertTable

public boolean isAssertTable()

テーブル値を検証するかどうか返却する.

戻り値:

boolean

isSetUpTable

public boolean isSetUpTable()

テーブルをセットアップするかどうかを返却する.

戻り値:

boolean

isValidToken

public boolean isValidToken()

トークン制御を行うかどうかを返却する.

戻り値:

boolean

isAssertRequestScopeVar

public boolean isAssertRequestScopeVar()

リクエストスコープ値を比較検証するかどうかを返却する.

戻り値:

boolean

setIsAssertRequestScopeVar

public void setIsAssertRequestScopeVar(boolean isAssert)

リクエストスコープ値を比較検証するかどうかを設定する

 各テストケースにて比較検証を個別実装する場合にfalseに設定する。
 AbstractHttpRequestTestTemplate.beforeExecuteRequest(TestCaseInfo, nablarch.fw.ExecutionContext, Advice)にて
 にてfalseへの設定を行うこと。
 

パラメータ:

isAssert - boolean(デフォルト値はTrue）

isAssertApplicationMessageId

public boolean isAssertApplicationMessageId()

メッセージIDの検証を行うかどうかを返却する。

戻り値:

boolean

setIsAssertApplicationMessageId

public void setIsAssertApplicationMessageId(boolean isAssert)

メッセージIDの検証を行うかどうかを設定する。

パラメータ:

isAssert - boolean(デフォルト値はTrue）

getHttpRequest

public nablarch.fw.web.HttpRequest getHttpRequest()

HTTPリクエストを取得する。

戻り値:

このテストケースのHTTPリクエスト