nablarch.test.core.db

クラス DbAccessTestSupport

java.lang.Object

nablarch.test.event.TestEventDispatcher

nablarch.test.core.db.DbAccessTestSupport

@Published
public class DbAccessTestSupport
extends TestEventDispatcher

データベースアクセス自動テスト用基底クラス。
データベースアクセスクラスの自動テストを行う場合には、本クラスを継承しテストクラスを作成する。
本クラス以外の基底クラスを継承しなければならない場合は、
本クラスのインスタンスを生成し処理を委譲することで代替可能である。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	DB_TRANSACTION_FOR_TEST テストクラス用トランザクション名
static java.lang.String	DB_TRANSACTION_FOR_TEST_FW テスティングフレームワーク用トランザクション名
static java.lang.String	TRANSACTIONS_KEY データベーストランザクション名を取得する為のキー

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

testName

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

コンストラクタ

修飾子	コンストラクタと説明
protected	DbAccessTestSupport() デフォルトコンストラクタ サブクラスからの呼び出しを想定している。
	DbAccessTestSupport(java.lang.Class<?> testClass) コンストラクタ
	DbAccessTestSupport(TestSupport testSupport) コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	assertSqlResultSetEquals(java.lang.String message, java.lang.String sheetName, java.lang.String id, SqlResultSet actual) SqlResultSetの値とExcelファイルに記載したデータの比較を行う。
void	assertSqlRowEquals(java.lang.String message, java.lang.String sheetName, java.lang.String id, SqlRow actual) SqlRowの値とExcelファイルに記載したデータの比較を行う。
void	assertTableEquals(java.lang.String sheetName) データベースのテーブルの値とExcelファイルに記載した値の比較を行う。
void	assertTableEquals(java.lang.String sheetName, java.lang.String groupId) テーブルの比較を行う。
void	assertTableEquals(java.lang.String message, java.lang.String sheetName, boolean failIfNoDataFound) テーブルの比較を行う。
void	assertTableEquals(java.lang.String message, java.lang.String sheetName, java.lang.String groupId) テーブルの比較を行う。
void	assertTableEquals(java.lang.String message, java.lang.String sheetName, java.lang.String groupId, boolean failIfNoDataFound) テーブルの比較を行う。
void	beginTransactions() データベースアクセスクラスのテスト用にトランザクションを開始する。
void	commitTransactions() コミットを実行する。
void	endTransactions() トランザクションを終了する。
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getListMap(java.lang.String sheetName, java.lang.String id) List-Map形式でデータを取得する。
java.util.List<java.util.Map<java.lang.String,java.lang.String[]>>	getListParamMap(java.lang.String sheetName, java.lang.String id) List-Map形式でデータを取得する。
java.util.Map<java.lang.String,java.lang.String[]>	getParamMap(java.lang.String sheetName, java.lang.String id) List-Map形式でデータを取得する。
TestSupport	getTestSupport() テストサポートクラスを返却する。
void	rollbackTransactions() トランザクションをロールバックする。
void	setThreadContextValues(java.lang.String sheetName, java.lang.String id) ThreadContextに値を設定する。
void	setUpDb(java.lang.String sheetName) データベースにデータを投入する。
void	setUpDb(java.lang.String sheetName, java.lang.String groupId) データベースにデータを投入する。

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

dispatchEventOfAfterTestClass, dispatchEventOfAfterTestMethod, dispatchEventOfBeforeTestClassAndBeforeSuit, dispatchEventOfBeforeTestMethod, getMethodName

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

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

フィールドの詳細

TRANSACTIONS_KEY

public static final java.lang.String TRANSACTIONS_KEY

データベーストランザクション名を取得する為のキー

関連項目:

定数フィールド値

DB_TRANSACTION_FOR_TEST

public static final java.lang.String DB_TRANSACTION_FOR_TEST

テストクラス用トランザクション名

関連項目:

定数フィールド値

DB_TRANSACTION_FOR_TEST_FW

public static final java.lang.String DB_TRANSACTION_FOR_TEST_FW

テスティングフレームワーク用トランザクション名

関連項目:

定数フィールド値

コンストラクタの詳細

DbAccessTestSupport

protected DbAccessTestSupport()

デフォルトコンストラクタ
サブクラスからの呼び出しを想定している。
サブクラス以外から本クラスを使用する場合は、DbAccessTestSupport(Class)を使用すること。

DbAccessTestSupport

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

コンストラクタ

パラメータ:

testClass - テストクラス（テスト対象クラスではない）

DbAccessTestSupport

public DbAccessTestSupport(TestSupport testSupport)

コンストラクタ

パラメータ:

testSupport - テストサポート

メソッドの詳細

beginTransactions

public void beginTransactions()

データベースアクセスクラスのテスト用にトランザクションを開始する。
開始対象のトランザクション名は、設定ファイルより取得する。
複数のトランザクションを開始する場合には、カンマ(",")区切りで複数のトランザクション名を設定する。
設定ファイル例:

 dbAccessTest.dbTransactionName = transaction-name1,transaction-name2
 

デフォルトのトランザクション(nablarch.core.db.connection.DbConnectionContext#getConnection()で取得されるトランザクション)は、
設定ファイルの記述の有無に関わらず開始される。
デフォルトのトランザクションのみを使用する場合は、設定ファイルへの記述は不要である。

commitTransactions

public void commitTransactions()

コミットを実行する。

rollbackTransactions

public void rollbackTransactions()

トランザクションをロールバックする。

endTransactions

public void endTransactions()

トランザクションを終了する。

setUpDb

public void setUpDb(java.lang.String sheetName)

データベースにデータを投入する。

パラメータ:

sheetName - シート名

setUpDb

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

データベースにデータを投入する。

パラメータ:

sheetName - シート名

groupId - グループID

setThreadContextValues

public void setThreadContextValues(java.lang.String sheetName,
                                   java.lang.String id)

ThreadContextに値を設定する。

パラメータ:

sheetName - 取得元シート名

id - 取得元ID

assertSqlResultSetEquals

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

SqlResultSetの値とExcelファイルに記載したデータの比較を行う。
検索系テスト実行結果の検索結果確認に使用する。

パラメータ:

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

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

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

actual - 実際の値

assertSqlRowEquals

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

SqlRowの値とExcelファイルに記載したデータの比較を行う。
検索系テスト実行結果の検索結果確認に使用する。

パラメータ:

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)

List-Map形式でデータを取得する。

パラメータ:

sheetName - シート名

id - ID

戻り値:

List-Map形式のデータ

getListParamMap

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

List-Map形式でデータを取得する。
HTTPパラメータと同じ形式で取得できる（Mapの値がString[]となる）。

パラメータ:

sheetName - シート名

id - ID

戻り値:

List-Map形式のデータ

関連項目:

HttpRequest.getParamMap()

getParamMap

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

List-Map形式でデータを取得する。
HTTPパラメータと同じ形式で取得できる（Mapの値がString[]となる）。

パラメータ:

sheetName - シート名

id - ID

戻り値:

Map形式のデータ

関連項目:

HttpRequest.getParamMap()

assertTableEquals

public void assertTableEquals(java.lang.String sheetName)

データベースのテーブルの値とExcelファイルに記載した値の比較を行う。
更新系テスト実行後の更新結果確認用に使用する。 テストクラスと同一のパッケージに存在するテストデータファイルから、 期待値を読み取り実際のテーブルと比較を行う。

パラメータ:

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

assertTableEquals

public void assertTableEquals(java.lang.String message,
                              java.lang.String sheetName,
                              boolean failIfNoDataFound)
                       throws java.lang.IllegalArgumentException

テーブルの比較を行う。
テストクラスと同一のパッケージに存在するテストデータファイルから、 期待値を読み取り実際のテーブルと比較を行う。

パラメータ:

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

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

failIfNoDataFound - データが存在しない場合に例外とするかどうか

例外:

java.lang.IllegalArgumentException - 期待値のデータが存在せず、failIfNoDataFoundが真の場合

assertTableEquals

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

テーブルの比較を行う。
テストクラスと同一のパッケージに存在するテストデータファイルから、 期待値を読み取り実際のテーブルと比較を行う。

パラメータ:

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

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

例外:

java.lang.IllegalArgumentException - 期待値のデータが存在しない場合

assertTableEquals

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

テーブルの比較を行う。
テストクラスと同一のパッケージに存在するテストデータファイルから、 期待値を読み取り実際のテーブルと比較を行う。

パラメータ:

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

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

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

例外:

java.lang.IllegalArgumentException - 期待値のデータが存在しない場合

assertTableEquals

public void assertTableEquals(java.lang.String message,
                              java.lang.String sheetName,
                              java.lang.String groupId,
                              boolean failIfNoDataFound)
                       throws java.lang.IllegalArgumentException

テーブルの比較を行う。
テストクラスと同一のパッケージに存在するテストデータファイルから、 期待値を読み取り実際のテーブルと比較を行う。

パラメータ:

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

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

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

failIfNoDataFound - データが存在しない場合に例外とするかどうか

例外:

java.lang.IllegalArgumentException - 期待値のデータが存在せず、failIfNoDataFoundが真の場合

getTestSupport

public TestSupport getTestSupport()

テストサポートクラスを返却する。

戻り値:

テストクラス