DB Tester

日本語

English

日本語

English

テーマ

SPIプロバイダー ​

APIモジュールSPI -- プロバイダーレイヤー ​

DataSetLoaderProvider ​

デフォルトのDataSetLoader実装を提供します。

パッケージ: io.github.seijikohara.dbtester.api.spi.DataSetLoaderProvider

インターフェース:

java
public interface DataSetLoaderProvider {
    DataSetLoader getLoader();
}

デフォルト実装: db-tester-coreのDefaultDataSetLoaderProvider

使用方法: Configuration.defaults()がローダーを取得する際に呼び出す。

OperationProvider ​

テーブルセットに対するデータベース操作を実行します。

パッケージ: io.github.seijikohara.dbtester.api.spi.OperationProvider

インターフェース:

java
public interface OperationProvider {
    void execute(
        Operation operation,
        TableSet tableSet,
        DataSource dataSource,
        TableOrderingStrategy tableOrderingStrategy,
        TransactionMode transactionMode,
        @Nullable Duration queryTimeout);

    // バッチサイズ制御付き（デフォルトではベースのexecuteに委譲）
    default void execute(
        Operation operation,
        TableSet tableSet,
        DataSource dataSource,
        TableOrderingStrategy tableOrderingStrategy,
        TransactionMode transactionMode,
        @Nullable Duration queryTimeout,
        int batchSize);
}

デフォルト実装: db-tester-coreのDefaultOperationProvider

パラメータ:

パラメータ型説明
operationOperation実行するデータベース操作
tableSetTableSetテーブルと行を含むテーブルセット
dataSourceDataSourceコネクション用のJDBCデータソース
tableOrderingStrategyTableOrderingStrategyテーブル処理順序の戦略
transactionModeTransactionModeトランザクション動作モード
queryTimeout@Nullable Durationクエリタイムアウト、またはタイムアウトなしの場合はnull
batchSizeintINSERTバッチあたりの行数（0 = 単一バッチ）、バッチオーバーロードで使用

操作:

操作説明
NONE操作なし
INSERT行を挿入
UPDATE主キーで更新
DELETE主キーで削除
DELETE_ALL全行を削除
UPSERTUpsert（挿入または更新）
TRUNCATE_TABLEテーブルを切り捨て
CLEAN_INSERT全削除後に挿入
TRUNCATE_INSERT切り捨て後に挿入

AssertionProvider ​

期待値検証のためのデータベースアサーションを実行します。

パッケージ: io.github.seijikohara.dbtester.api.spi.AssertionProvider

インターフェース:

java
public interface AssertionProvider {
    // コア比較メソッド
    void assertEquals(TableSet expected, TableSet actual);
    void assertEquals(TableSet expected, TableSet actual,
                      @Nullable AssertionFailureHandler failureHandler);
    void assertEquals(Table expected, Table actual);
    void assertEquals(Table expected, Table actual, Collection<String> additionalColumnNames);
    void assertEquals(Table expected, Table actual,
                      @Nullable AssertionFailureHandler failureHandler);

    // カラム除外付き比較
    void assertEqualsIgnoreColumns(TableSet expected, TableSet actual, String tableName,
                                   Collection<String> ignoreColumnNames);
    void assertEqualsIgnoreColumns(Table expected, Table actual,
                                   Collection<String> ignoreColumnNames);

    // カラム戦略付き比較
    void assertEqualsWithStrategies(Table expected, Table actual,
                                    Collection<ColumnStrategyMapping> columnStrategies);
}

デフォルト実装: db-tester-coreのDefaultAssertionProvider

主要メソッド:

メソッド説明
assertEquals(TableSet, TableSet)2つのテーブルセットを比較
assertEquals(Table, Table)2つのテーブルを比較
assertEqualsIgnoreColumns(...)特定カラムを無視して比較
assertEqualsWithStrategies(...)カラム固有の比較戦略を使用して比較

動作:

  1. 期待値と実際のテーブルセット/テーブルを比較
  2. カラムごとに比較戦略を適用（STRICT、IGNORE、NUMERICなど）
  3. すべての差異を収集（フェイルファストではない）
  4. 不一致時は人間が読みやすい要約 + YAML詳細を出力

出力形式の詳細についてはエラーハンドリング - 検証エラーを参照してください。

ExpectationProvider ​

期待テーブルセットに対するデータベース状態を検証します。

パッケージ: io.github.seijikohara.dbtester.api.spi.ExpectationProvider

インターフェース:

java
public interface ExpectationProvider {
    // 基本検証（abstract）
    void verifyExpectation(TableSet expectedTableSet, DataSource dataSource);

    // ExpectationContextパラメータオブジェクト付き（default）
    default void verifyExpectation(TableSet expectedTableSet, DataSource dataSource,
                                   ExpectationContext context);
}

デフォルト実装: db-tester-coreのDefaultExpectationProvider

メソッド:

メソッド説明
verifyExpectation(TableSet, DataSource)基本的なデータベース状態検証
verifyExpectation(TableSet, DataSource, ExpectationContext)フルコンテキスト付き検証（除外、戦略、順序、デフォルト）

ExpectationContext (io.github.seijikohara.dbtester.api.config.ExpectationContext):

オプションの検証パラメータをカプセル化するパラメータオブジェクト。

フィールド型説明
excludeColumnsSet<String>比較から除外するカラム名（大文字小文字区別なし）
columnStrategiesMap<String, ColumnStrategyMapping>カラム名でキーイングされたカラム比較戦略
rowOrderingRowOrdering行比較戦略（ORDEREDまたはUNORDERED）
operationDefaultsOperationDefaults比較設定を含む操作デフォルト（例: 浮動小数点イプシロン）
tableOrderingTableOrderingStrategyテーブル処理順序（AUTOまたはFOREIGN_KEY）
java
// デフォルトコンテキスト（除外なし、順序付き、標準デフォルト、AUTOテーブル順序）
var context = ExpectationContext.defaults();

// with*()コピーメソッドによるカスタムコンテキスト
var context = ExpectationContext.defaults()
    .withExcludeColumns(Set.of("CREATED_AT", "UPDATED_AT"))
    .withRowOrdering(RowOrdering.UNORDERED)
    .withTableOrdering(TableOrderingStrategy.FOREIGN_KEY);

// 4パラメータのファクトリメソッド（テーブル順序はAUTOがデフォルト）
var context = ExpectationContext.of(
    excludeColumns, columnStrategies, rowOrdering, operationDefaults);

// 5パラメータのファクトリメソッド（テーブル順序を明示指定）
var context = ExpectationContext.of(
    excludeColumns, columnStrategies, rowOrdering, operationDefaults,
    TableOrderingStrategy.FOREIGN_KEY);

プロセス:

  1. 期待テーブルセット内の各テーブルに対して、データベースから実際のデータを取得
  2. 実際のデータを期待テーブルに存在するカラムのみにフィルタリング
  3. コンテキストからカラム除外と比較戦略を適用
  4. フィルタリングされた実際のデータを期待データと比較
  5. 検証失敗時はValidationException（AssertionErrorをラップ）をスロー

ScenarioNameResolver ​

テストメソッドコンテキストからシナリオ名を解決します。

パッケージ: io.github.seijikohara.dbtester.api.scenario.ScenarioNameResolver

インターフェース:

java
public interface ScenarioNameResolver {
    int DEFAULT_PRIORITY = 0;

    ScenarioName resolve(Method testMethod);

    default boolean canResolve(Method testMethod) {
        return true;
    }

    default int priority() {
        return DEFAULT_PRIORITY;
    }
}

メソッド:

メソッド戻り値型デフォルト説明
resolve(Method)ScenarioName-テストメソッドからシナリオ名を解決
canResolve(Method)booleantrueリゾルバがメソッドを処理できるかを返す
priority()int0リゾルバ選択の優先度を返す（大きいほど優先）

実装:

実装モジュール説明
JUnitScenarioNameResolverdb-tester-junitJUnitメソッド名から解決
SpockScenarioNameResolverdb-tester-spockSpockフィーチャー名から解決
KotestScenarioNameResolverdb-tester-kotestKotestテストケース名から解決

解決ロジック:

  1. 登録されたすべてのリゾルバをpriority()で降順ソート
  2. 各リゾルバにcanResolve()を問い合わせ
  3. trueを返す最初のリゾルバを使用
  4. resolve()を呼び出してシナリオ名を取得

ExportProvider ​

データベースの内容を特定の形式のファイルにエクスポートします。

パッケージ: io.github.seijikohara.dbtester.api.spi.ExportProvider

インターフェース:

java
public interface ExportProvider {
    DataFormat supportedFormat();
    void export(DataSource dataSource, List<String> tableNames,
                Path outputDirectory, ExportConfiguration config);
    void exportQuery(DataSource dataSource, String query, String tableName,
                     Path outputDirectory, ExportConfiguration config);
}

メソッド:

メソッド説明
supportedFormat()このプロバイダーが処理するデータ形式を返す
export(...)指定されたテーブルを出力ディレクトリにファイルとしてエクスポート
exportQuery(...)SQLクエリの結果をファイルにエクスポート

選択: 設定されたDataFormatと一致するsupportedFormat()を持つプロバイダーが選択される。

QueryAssertionProvider ​

SQLクエリを実行し、結果を期待データセットと比較します。

パッケージ: io.github.seijikohara.dbtester.api.spi.QueryAssertionProvider

インターフェース:

java
public interface QueryAssertionProvider {
    void assertEqualsByQuery(TableSet expected, DataSource dataSource,
                             String tableName, String sqlQuery,
                             Collection<String> ignoreColumnNames);
    void assertEqualsByQuery(Table expected, DataSource dataSource,
                             String tableName, String sqlQuery,
                             Collection<String> ignoreColumnNames);
}

デフォルト実装: db-tester-coreのDefaultQueryAssertionProvider

読み込み元: DatabaseQueryAssertionファサードクラス

AssertionProviderとの違い: AssertionProviderはインメモリのデータセットを比較する。QueryAssertionProviderはデータベースでSQLクエリを実行し、その結果を比較する。

TypeHandler ​

データベース型のカスタム変換（読み取り、書き込み、フォーマット）を処理します。

パッケージ: io.github.seijikohara.dbtester.api.spi.TypeHandler

インターフェース:

java
public interface TypeHandler<T> {
    Class<T> getJavaType();
    List<Integer> getSqlTypes();
    default List<String> getSupportedDatabases();
    default int getPriority();
    T read(ResultSet resultSet, int columnIndex) throws SQLException;
    void write(PreparedStatement ps, int parameterIndex, T value) throws SQLException;
    String format(T value);
    T parse(String value);
}

メソッド:

メソッド説明
getJavaType()このハンドラーが生成するJava型を返す
getSqlTypes()このハンドラーがサポートするSQL型コード（java.sql.Types）を返す
getSupportedDatabases()データベース製品名を返す。全データベース対応の場合は空リスト
getPriority()ハンドラー選択の優先度（大きいほど優先）。デフォルト0
read(...)ResultSetから値を読み取る
write(...)PreparedStatementに値を書き込む
format(...)エクスポート用に値を文字列に変換する
parse(...)インポート用に文字列値を解析する

選択: 同一SQL型に複数のハンドラーが存在する場合、getPriority()が最も高いハンドラーを選択する。データベース固有のハンドラー（getSupportedDatabases()が空でない）は、製品名が一致する場合に汎用ハンドラーより優先される。

CoreモジュールSPI ​

FormatProvider ​

特定形式のデータセットファイルを解析します。

パッケージ: io.github.seijikohara.dbtester.internal.format.spi.FormatProvider

インターフェース:

java
public interface FormatProvider {
    FileExtension supportedFileExtension();
    TableSet parse(Path directory);
}

メソッド:

メソッド戻り値型説明
supportedFileExtension()FileExtension先頭ドットなしのファイル拡張子を返す（例: "csv"）
parse(Path)TableSetディレクトリ内のすべてのファイルをTableSetに解析

実装:

実装拡張子区切り文字
CsvFormatProvider.csvカンマ
TsvFormatProvider.tsvタブ
JsonFormatProvider.jsonJSON構造
YamlFormatProvider.yamlYAML構造

この内部SPIはパブリックAPI契約の一部ではなく、予告なく変更される可能性があります。

関連仕様 ​

Released under the MIT License.

Copyright © 2025 Seiji Kohara