nablarch.test.core.http

クラス HttpRequestTestSupport

java.lang.Object

nablarch.test.event.TestEventDispatcher

nablarch.test.core.http.HttpRequestTestSupport

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

AbstractHttpRequestTestTemplate

@Published
public class HttpRequestTestSupport
extends TestEventDispatcher

HTTPリクエストテスト用の基底クラス。

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

ネストされたクラス

修飾子とタイプ	クラスと説明
protected class	HttpRequestTestSupport.HtmlResourceExtensionFilter コピー対象となるHTMLリソースの拡張子。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected java.lang.Class<?>	testClass テストクラス

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

testName

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

コンストラクタ

修飾子	コンストラクタと説明
protected	HttpRequestTestSupport() コンストラクタ 本メソッドはサブクラスから使用されることを想定している。
	HttpRequestTestSupport(java.lang.Class<?> testClass) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	assertApplicationMessageId(java.lang.String[] expected, ExecutionContext actual) メッセージIDのアサートを行う。
void	assertApplicationMessageId(java.lang.String expectedCommaSeparated, ExecutionContext actual) メッセージIDのアサートを行う。
void	assertApplicationMessageId(java.lang.String msg, java.lang.String[] expected, ExecutionContext actual) メッセージIDのアサートを行う。
void	assertApplicationMessageId(java.lang.String msg, java.lang.String expectedCommaSeparated, ExecutionContext actual) メッセージIDのアサートを行う。
void	assertEntity(java.lang.String sheetName, java.lang.String id, java.lang.Object actual) EntityTestSupport.assertGetterMethod(String, String, Object)への移譲メソッド。
void	assertForward(java.lang.String msg, java.lang.String expectedUri) フォワード先URIが想定通りであることを表明する。
void	assertObjectArrayPropertyEquals(java.lang.String message, java.lang.String sheetName, java.lang.String id, java.lang.Object[] actual) Object配列に設定されたプロパティをアサートする。
void	assertObjectListPropertyEquals(java.lang.String message, java.lang.String sheetName, java.lang.String id, java.util.List<?> actual) Object に設定されたプロパティをアサートする。
void	assertObjectPropertyEquals(java.lang.String message, java.lang.String sheetName, java.lang.String id, java.lang.Object actual) Object に設定されたプロパティをアサートする。
void	assertSqlResultSetEquals(java.lang.String message, java.lang.String sheetName, java.lang.String id, SqlResultSet actual) DbAccessTestSupport.assertSqlResultSetEquals(String, String, String, nablarch.core.db.statement.SqlResultSet) への委譲メソッド。
void	assertSqlRowEquals(java.lang.String message, java.lang.String sheetName, java.lang.String id, SqlRow actual) DbAccessTestSupport.assertSqlRowEquals(String, String, String, nablarch.core.db.statement.SqlRow) への委譲メソッド。
protected void	assertStatusCode(java.lang.String message, int expected, HttpResponse response) ステータスコードが想定通りであることを表明する。
void	assertTableEquals(java.lang.String sheetName) DbAccessTestSupport.assertTableEquals(String)への委譲メソッド。
void	assertTableEquals(java.lang.String sheetName, java.lang.String groupId) DbAccessTestSupport.assertTableEquals(String, String)への委譲メソッド。
void	assertTableEquals(java.lang.String message, java.lang.String sheetName, java.lang.String groupId) DbAccessTestSupport.assertTableEquals(String, String, String) への委譲メソッド。
protected void	copyHtmlResourceToDumpDir(HttpTestConfiguration config, java.io.File destDir, ResourceLocator warBaseLocator) HTMLリソースをダンプファイルの出力ディレクトリへコピーする。
ExecutionContext	createExecutionContext(java.lang.String userId) ExecutionContextを生成する。
HttpRequest	createHttpRequest(java.lang.String requestUri, java.util.Map<java.lang.String,java.lang.String[]> params) リクエストパラメータを作成する。
HttpRequest	createHttpRequestWithConversion(java.lang.String requestUri, java.util.Map<java.lang.String,java.lang.String> commaSeparated, java.util.Map<java.lang.String,java.lang.String> cookie) リクエストパラメータを作成する。
protected HttpServer	createHttpServer() HttpServerのインスタンスを生成する。
protected HttpServer	createHttpServer(HttpTestConfiguration config) HttpServerを生成する。
protected void	deleteHtmlResourceFile(java.io.File srcDir, java.io.File destDir) ダンプディレクトリのHTMLリソースファイルを削除する。
HttpResponse	execute(java.lang.Class<?> testClass, java.lang.String caseName, HttpRequest req, ExecutionContext ctx) 自動テスト用HTTPサーバを使用して、リクエスト単体テストを実現する。
protected HttpResponse	execute(java.lang.String caseName, HttpRequest req, ExecutionContext ctx) 自動テスト用HTTPサーバを使用して、リクエスト単体テストを実現する。
protected java.lang.String	getAbsoluteCssUriPrefix(java.lang.String uri, java.lang.String replaceAbsolutePath) URI型の絶対パス参照文字列から、URIのプレフィックスを取得する。
protected java.io.File	getDumpFile(ExecutionContext ctx) HTTPレスポンスボディが出力されたファイルを取得する。
protected java.io.FileFilter	getFileFilter(HttpTestConfiguration config) FileFilterを取得する。
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getListMap(java.lang.String sheetName, java.lang.String id) DbAccessTestSupport.getListMap(String, String)への委譲メソッド。
java.util.List<java.util.Map<java.lang.String,java.lang.String[]>>	getListParamMap(java.lang.String sheetName, java.lang.String id) DbAccessTestSupport.getListParamMap(String, String)への委譲メソッド。
java.util.Map<java.lang.String,java.lang.String[]>	getParamMap(java.lang.String sheetName, java.lang.String id) DbAccessTestSupport.getParamMap(String, String)への委譲メソッド。
static HttpRequestTestSupportHandler	getTestSupportHandler() サポートハンドラを取得する。
protected void	initializeIfNotYet(HttpTestConfiguration config, java.io.File dumpDir, java.lang.String className) 初回時のみ初期化を実行する。
boolean	is3XXStatusCode(int statusCode) 300系の HTTP ステータスコードかどうか判定する
protected void	prepareHandlerQueue(java.util.List<Handler> handlerQueue) ハンドラキューの準備を行う。
static void	resetHttpServer() キャッシュした HttpServer をリセットする。
protected java.lang.String	rewritePath(java.lang.String text, java.lang.String replaceAbsolutePath) 静的リソース内のパスを置き換える。
protected void	rewriteResourceFile(HttpTestConfiguration config, java.io.File dumpDir, ResourceLocator warBaseLocator) HTMLリソースディレクトリ内のCSSファイルを置換する。
protected void	setDumpFile(ExecutionContext ctx, java.io.File file) HTTPレスポンスボディが出力されたファイルを設定する。
protected static void	setHttpHeader(HttpRequest req, HttpTestConfiguration config) HTTPHeaderを設定する。
void	setToken(HttpRequest request, ExecutionContext context, boolean valid) トークンをリクエストパラメータとセッションスコープに設定する。
void	setUpDb(java.lang.String sheetName) DbAccessTestSupport.setUpDb(String)への委譲メソッド。
void	setUpDb(java.lang.String sheetName, java.lang.String groupId) DbAccessTestSupport.setUpDb(String, String)への委譲メソッド。
void	setValidToken(HttpRequest request, ExecutionContext context) 有効なトークンをリクエストパラメータとセッションスコープに設定する。

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

dispatchEventOfAfterTestClass, dispatchEventOfAfterTestMethod, dispatchEventOfBeforeTestClassAndBeforeSuit, dispatchEventOfBeforeTestMethod, getMethodName

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

testClass

protected final java.lang.Class<?> testClass

テストクラス

コンストラクタの詳細

HttpRequestTestSupport

public HttpRequestTestSupport(java.lang.Class<?> testClass)

コンストラクタ。

パラメータ:

testClass - テストクラス

HttpRequestTestSupport

protected HttpRequestTestSupport()

コンストラクタ
本メソッドはサブクラスから使用されることを想定している。

メソッドの詳細

execute

protected HttpResponse execute(java.lang.String caseName,
                               HttpRequest req,
                               ExecutionContext ctx)

自動テスト用HTTPサーバを使用して、リクエスト単体テストを実現する。

パラメータ:

req - テスト対象のアクションを呼び出すためのHttpRequest

caseName - テストケース名

ctx - ExecutionContext

戻り値:

HttpResponse

initializeIfNotYet

protected void initializeIfNotYet(HttpTestConfiguration config,
                                  java.io.File dumpDir,
                                  java.lang.String className)

初回時のみ初期化を実行する。

パラメータ:

config - HttpTestConfiguration

dumpDir - HTMLダンプ先のディレクトリ

className - テストクラス

execute

public HttpResponse execute(java.lang.Class<?> testClass,
                            java.lang.String caseName,
                            HttpRequest req,
                            ExecutionContext ctx)

自動テスト用HTTPサーバを使用して、リクエスト単体テストを実現する。

パラメータ:

testClass - テストクラス

req - テスト対象のアクションを呼び出すためのHttpRequest

caseName - テストケース名

ctx - ExecutionContext

戻り値:

HttpResponse

createHttpServer

protected HttpServer createHttpServer(HttpTestConfiguration config)

HttpServerを生成する。

パラメータ:

config - HttpTestConfiguration

戻り値:

HTTPサーバ

getTestSupportHandler

public static HttpRequestTestSupportHandler getTestSupportHandler()

サポートハンドラを取得する。

戻り値:

サポートハンドラ

prepareHandlerQueue

protected void prepareHandlerQueue(java.util.List<Handler> handlerQueue)

ハンドラキューの準備を行う。

パラメータ:

handlerQueue - ハンドラキュー

createHttpServer

protected HttpServer createHttpServer()

HttpServerのインスタンスを生成する。

戻り値:

HttpServerのインスタンス

copyHtmlResourceToDumpDir

protected void copyHtmlResourceToDumpDir(HttpTestConfiguration config,
                                         java.io.File destDir,
                                         ResourceLocator warBaseLocator)

HTMLリソースをダンプファイルの出力ディレクトリへコピーする。

パラメータ:

config - HttpTestConfiguration

destDir - 出力ディレクトリ

warBaseLocator - warベースディレクトリのリソースロケータ

deleteHtmlResourceFile

protected void deleteHtmlResourceFile(java.io.File srcDir,
                                      java.io.File destDir)

ダンプディレクトリのHTMLリソースファイルを削除する。

パラメータ:

srcDir - HTMLリソースフォルダ

destDir - HTMLリソースのコピーフォルダ

rewriteResourceFile

protected void rewriteResourceFile(HttpTestConfiguration config,
                                   java.io.File dumpDir,
                                   ResourceLocator warBaseLocator)

HTMLリソースディレクトリ内のCSSファイルを置換する。 出力したCSSファイルのタイムスタンプには、出力元CSSファイルのタイムスタンプを設定する。 次回、出力時にはタイムスタンプに変更がない限り、出力は行わない。

パラメータ:

config - HttpTestConfiguration

dumpDir - 出力先ディレクトリ

warBaseLocator - warベースのリソースロケータ

rewritePath

protected java.lang.String rewritePath(java.lang.String text,
                                       java.lang.String replaceAbsolutePath)

静的リソース内のパスを置き換える。

パラメータ:

text - 文字列

replaceAbsolutePath - ファイルの絶対パスからwarのルートパスを取り除いたパス。

戻り値:

置換後の文字列

getAbsoluteCssUriPrefix

protected java.lang.String getAbsoluteCssUriPrefix(java.lang.String uri,
                                                   java.lang.String replaceAbsolutePath)

URI型の絶対パス参照文字列から、URIのプレフィックスを取得する。

パラメータ:

uri - URI型の絶対パス参照文字列

replaceAbsolutePath - HTMLリソースの絶対パスからwarのルートパスを取り除いたパス。

戻り値:

URIのプレフックス

getFileFilter

protected java.io.FileFilter getFileFilter(HttpTestConfiguration config)

FileFilterを取得する。

パラメータ:

config - HttpTestConfiguration

戻り値:

FileFilter

setHttpHeader

protected static void setHttpHeader(HttpRequest req,
                                    HttpTestConfiguration config)

HTTPHeaderを設定する。
すでにHttpRequestに設定されている項目は、設定しない。

パラメータ:

req - HTTPHeaderを設定するHttpRequest

config - HttpTestConfiguration

assertForward

public void assertForward(java.lang.String msg,
                          java.lang.String expectedUri)

フォワード先URIが想定通りであることを表明する。

パラメータ:

msg - アサート失敗時のメッセージ

expectedUri - 期待するフォワード先URI

assertStatusCode

protected void assertStatusCode(java.lang.String message,
                                int expected,
                                HttpResponse response)

ステータスコードが想定通りであることを表明する。
内蔵サーバから戻り値で返却されたHTTPレスポンスがリダイレクトである場合、 ステータスコードが303または302であることを表明する。 このとき、内蔵サーバから返却されるHTTPレスポンスと比較しないのは、後方互換性を保つためである。 （内蔵サーバは、リダイレクト時のステータスコードに'302 FOUND'を使用する） 上記以外の場合は、HttpRequestTestSupportHandler.getStatusCode() のステータスコードを比較対象とする。

パラメータ:

message - アサート失敗時のメッセージ

expected - 期待するステータスコード値

response - HTTPレスポンス

関連項目:

HttpRequestTestSupportHandler

is3XXStatusCode

public boolean is3XXStatusCode(int statusCode)

300系の HTTP ステータスコードかどうか判定する

パラメータ:

statusCode - 判定対象のHTTPステータスコード

戻り値:

300系の HTTP ステータスコードであれば true

assertApplicationMessageId

public void assertApplicationMessageId(java.lang.String expectedCommaSeparated,
                                       ExecutionContext actual)

メッセージIDのアサートを行う。

パラメータ:

expectedCommaSeparated - 期待するメッセージID（カンマ区切り）

actual - 実行結果(メッセージIDをリクエストスコープにもつExecutionContext)

assertApplicationMessageId

public void assertApplicationMessageId(java.lang.String msg,
                                       java.lang.String expectedCommaSeparated,
                                       ExecutionContext actual)

メッセージIDのアサートを行う。

パラメータ:

msg - 任意のメッセージ

expectedCommaSeparated - 期待するメッセージID（カンマ区切り）

actual - 実行結果(メッセージIDをリクエストスコープにもつExecutionContext)

assertApplicationMessageId

public void assertApplicationMessageId(java.lang.String[] expected,
                                       ExecutionContext actual)

メッセージIDのアサートを行う。

パラメータ:

expected - 期待するメッセージIDの配列

actual - 実行結果(メッセージIDをリクエストスコープにもつExecutionContext)

assertApplicationMessageId

public void assertApplicationMessageId(java.lang.String msg,
                                       java.lang.String[] expected,
                                       ExecutionContext actual)

メッセージIDのアサートを行う。

パラメータ:

msg - 任意のメッセージ

expected - 期待するメッセージIDの配列

actual - 実行結果(メッセージIDをリクエストスコープにもつExecutionContext)

setValidToken

public void setValidToken(HttpRequest request,
                          ExecutionContext context)

有効なトークンをリクエストパラメータとセッションスコープに設定する。
二重サブミットを防止しているアクションのメソッドをテストする場合は、このメソッドを呼び出しトークンを設定する。

パラメータ:

request - テスト対象のアクションを呼び出すためのHttpRequest

context - ExecutionContext

setToken

public void setToken(HttpRequest request,
                     ExecutionContext context,
                     boolean valid)

トークンをリクエストパラメータとセッションスコープに設定する。
引数validが真の場合、有効なトークンを設定する。偽の場合はトークンを無効にする。

パラメータ:

request - テスト対象のアクションを呼び出すためのHttpRequest

context - ExecutionContext

valid - 有効なトークンを設定するかどうか

createHttpRequest

public HttpRequest createHttpRequest(java.lang.String requestUri,
                                     java.util.Map<java.lang.String,java.lang.String[]> params)

リクエストパラメータを作成する。

パラメータ:

requestUri - リクエストURI

params - パラメータが格納されたMap

戻り値:

リクエストパラメータ

createHttpRequestWithConversion

public HttpRequest createHttpRequestWithConversion(java.lang.String requestUri,
                                                   java.util.Map<java.lang.String,java.lang.String> commaSeparated,
                                                   java.util.Map<java.lang.String,java.lang.String> cookie)

リクエストパラメータを作成する。

パラメータ:

requestUri - リクエストURI

commaSeparated - パラメータが格納されたMap

cookie - Cookie情報が格納されたMap

戻り値:

リクエストパラメータ

createExecutionContext

public ExecutionContext createExecutionContext(java.lang.String userId)

ExecutionContextを生成する。

パラメータ:

userId - セッションスコープに格納するユーザID

戻り値:

生成したExecutionContext

getDumpFile

protected java.io.File getDumpFile(ExecutionContext ctx)

HTTPレスポンスボディが出力されたファイルを取得する。

パラメータ:

ctx - ExecutionContext

戻り値:

ファイル。HTTPダンプ出力が無効な場合はnull

setDumpFile

protected void setDumpFile(ExecutionContext ctx,
                           java.io.File file)

HTTPレスポンスボディが出力されたファイルを設定する。

パラメータ:

ctx - ExecutionContext

file - ファイル

setUpDb

public void setUpDb(java.lang.String sheetName)

DbAccessTestSupport.setUpDb(String)への委譲メソッド。

パラメータ:

sheetName - シート名

関連項目:

DbAccessTestSupport.setUpDb(String)

setUpDb

public void setUpDb(java.lang.String sheetName,
                    java.lang.String groupId)

DbAccessTestSupport.setUpDb(String, String)への委譲メソッド。

パラメータ:

sheetName - シート名

groupId - グループID

関連項目:

DbAccessTestSupport.setUpDb(String, String)

assertSqlResultSetEquals

public void assertSqlResultSetEquals(java.lang.String message,
                                     java.lang.String sheetName,
                                     java.lang.String id,
                                     SqlResultSet actual)

DbAccessTestSupport.assertSqlResultSetEquals(String, String, String, nablarch.core.db.statement.SqlResultSet) への委譲メソッド。

パラメータ:

message - 比較失敗時のメッセージ

sheetName - 期待値を格納したシート名

id - シート内のデータを特定するためのID

actual - 実際の値

関連項目:

DbAccessTestSupport.assertSqlResultSetEquals(String, String, String, nablarch.core.db.statement.SqlResultSet)

assertSqlRowEquals

public void assertSqlRowEquals(java.lang.String message,
                               java.lang.String sheetName,
                               java.lang.String id,
                               SqlRow actual)

DbAccessTestSupport.assertSqlRowEquals(String, String, String, nablarch.core.db.statement.SqlRow) への委譲メソッド。

パラメータ:

message - 比較失敗時のメッセージ

sheetName - 期待値を格納したシート名

id - シート内のデータを特定するためのID

actual - 実際の値

getListMap

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getListMap(java.lang.String sheetName,
                                                                                   java.lang.String id)

DbAccessTestSupport.getListMap(String, String)への委譲メソッド。

パラメータ:

sheetName - シート名

id - ID

戻り値:

List-Map形式のデータ

関連項目:

DbAccessTestSupport.getListMap(String, String)

getListParamMap

public java.util.List<java.util.Map<java.lang.String,java.lang.String[]>> getListParamMap(java.lang.String sheetName,
                                                                                          java.lang.String id)

DbAccessTestSupport.getListParamMap(String, String)への委譲メソッド。

パラメータ:

sheetName - シート名

id - ID

戻り値:

List-Map形式のデータ

関連項目:

DbAccessTestSupport.getListParamMap(String, String)

getParamMap

public java.util.Map<java.lang.String,java.lang.String[]> getParamMap(java.lang.String sheetName,
                                                                      java.lang.String id)

DbAccessTestSupport.getParamMap(String, String)への委譲メソッド。

パラメータ:

sheetName - シート名

id - ID

戻り値:

Map形式のデータ

関連項目:

DbAccessTestSupport.getParamMap(String, String)

assertTableEquals

public void assertTableEquals(java.lang.String sheetName)

DbAccessTestSupport.assertTableEquals(String)への委譲メソッド。

パラメータ:

sheetName - 期待値を格納したシート名

関連項目:

DbAccessTestSupport.assertTableEquals(String)

assertTableEquals

public void assertTableEquals(java.lang.String sheetName,
                              java.lang.String groupId)

DbAccessTestSupport.assertTableEquals(String, String)への委譲メソッド。

パラメータ:

sheetName - 期待値を格納したシート名

groupId - グループID（オプション）

関連項目:

DbAccessTestSupport.assertTableEquals(String, String)

assertTableEquals

public void assertTableEquals(java.lang.String message,
                              java.lang.String sheetName,
                              java.lang.String groupId)

DbAccessTestSupport.assertTableEquals(String, String, String) への委譲メソッド。

パラメータ:

message - 比較失敗時のメッセージ

groupId - グループID（オプション）

sheetName - 期待値を格納したシート名

関連項目:

DbAccessTestSupport.assertTableEquals(String, String, String)

assertEntity

public void assertEntity(java.lang.String sheetName,
                         java.lang.String id,
                         java.lang.Object actual)

EntityTestSupport.assertGetterMethod(String, String, Object)への移譲メソッド。

パラメータ:

sheetName - シート名

id - ケース表のID(LIST_MAP=testの場合は、testを指定する。)

actual - 実行結果のオブジェクト(Java Beansオブジェクト)

assertObjectPropertyEquals

public void assertObjectPropertyEquals(java.lang.String message,
                                       java.lang.String sheetName,
                                       java.lang.String id,
                                       java.lang.Object actual)

Object に設定されたプロパティをアサートする。
チェック条件の詳細は Assertion.assertProperties(java.util.Map, Object) を参照。

パラメータ:

message - メッセージ

sheetName - シート名

id - ケース表のID(LIST_MAP=testの場合は、testを指定する。)

actual - 実際の値

assertObjectArrayPropertyEquals

public void assertObjectArrayPropertyEquals(java.lang.String message,
                                            java.lang.String sheetName,
                                            java.lang.String id,
                                            java.lang.Object[] actual)

Object配列に設定されたプロパティをアサートする。
チェック条件の詳細は Assertion.assertProperties(java.util.Map, Object) を参照。

パラメータ:

message - メッセージ

sheetName - シート名

id - ケース表のID(LIST_MAP=testの場合は、testを指定する。)

actual - 実際の値

assertObjectListPropertyEquals

public void assertObjectListPropertyEquals(java.lang.String message,
                                           java.lang.String sheetName,
                                           java.lang.String id,
                                           java.util.List<?> actual)

Object に設定されたプロパティをアサートする。
チェック条件の詳細は Assertion.assertProperties(java.util.Map, Object) を参照。

パラメータ:

message - メッセージ

sheetName - シート名

id - ケース表のID(LIST_MAP=testの場合は、testを指定する。)

actual - 実際の値

resetHttpServer

public static void resetHttpServer()

キャッシュした HttpServer をリセットする。