testcontainers-java で MySQL の複数のデータベースを構成する

趣旨

永続化層のための自動テストを testcontainers で用意する話。

前置き

複数の MySQL インスタンスの複数のデータベースに接続する重量級のアプリケーションがある
- フレームワークは Spring Framework
  - 宣言的トランザクション管理機能を使用
- 永続化層は JPA
- 永続化プロバイダは Hibernate
- データベースごとに JDBC データソースオブジェクトを構成している
testcontainers-java に含まれる MySQLContainer は mysql の Docker イメージを利用する前提になっている
- mysql の Docker イメージは環境変数による複数データベースの構成をサポートしていない
  - Allow creating multiple databases on startup. by tonio-ramirez · Pull Request #18 · docker-library/mysql · GitHub

やったこと

テストリソースディレクトリに DDL を配置
- データベース
- ユーザー
- テーブル・ビュー
GenericContainer を生成する static メソッドを定義
- MySQLContainer は使わない
- mysql イメージではなく ImageFromDockerfile.withDockerfileFromBuilder でイメージを作成
  - テストリソースディレクトリに配置した DDL を /docker-entrypoint-initdb.d に ADD する
    - mysql イメージの docker-entrypoint スクリプトはコンテナ起動時に /docker-entrypoint-initdb.d へ配置されたファイルを読み込むようになっている
      - https://github.com/docker-library/mysql/blob/master/5.7/docker-entrypoint.sh
テスト用のアプリケーションコンテキスト設定クラスを作成
- データソースを定義
  - データベース数ごとに定義
  - データベースの接続情報は GenericContainer.getContainerIpAddress と GenericContainer.getMappedPort で取得
  - アプリケーションコンテキストより先に GenericContainer が開始するよう JUnit Rule で制御している
- エンティティマネージャーファクトリーを定義
  - データソースごとに定義
- トランザクションマネージャーを定義
  - エンティティマネージャーファクトリーごとに定義
- @ComponentScan を定義
テストクラスを作成
- @ContextConfiguration(classes=) にテスト用のアプリケーションコンテキスト設定クラスを指定
- ClassRule(order=0) で修飾したクラスフィールドへ GenericContainer のインスタンスを束縛
  - order は JUnit 4.13-rc2 で追加される機能
  - JUnit 4.12 では指定できないので @BeforeClass と @AfterClass を利用するとよい
- ClassRule(order=1) で修飾したクラスフィールドへ SpringClassRule のインスタンスを束縛
- Rule で修飾したインスタンスフィールドへ SpringMethodRule のインスタンスを束縛
- (必要なら) テストクラスやテストメソッドを @Sql で修飾してテーブルの内容を準備
  - クラスパスに配置した DML を実行できる

詳細

こんな感じ。

bitbucket.org

参考リンク

www.testcontainers.org

mike-neck.hatenadiary.com