SpringBoot x MyBatis x TestContainersでSQLテストを行う

by k_sasaki

Slide 1

Slide 1 text

SpringBoot x MyBatis x TestContainersでSQLテストを行うエキサイト株式会社佐々木興平

Slide 2

Slide 2 text

免責本資料に掲載されている情報、ロゴ、画像などの知的財産権は、各権利者に帰属します。本資料の利用は、個人的な目的の範囲内にとどめてください。本資料は、投資勧誘を目的とするものではありません。投資に関する決定は、ご自身の判断で行ってください。本資料に記載されている情報は、作成時点におけるものであり、今後予告なしに変更されることがあります。本資料の内容に基づいて行われたいかなる行為についても、作成者は一切の責任を負いません。本資料の内容は、作成者個人の見解であり、必ずしも所属会社の公式な見解を代表するものではありません。

Slide 3

Slide 3 text

自己紹介佐々木興平 ( X: @earu) 所属: エキサイト(株) (4年6ヶ月)(ex.セレス,CA,ぐるなび) 職種: メディア事業部事業部長兼メディア事業部開発責任者やっていること: - PdM - テックリード最近チームでよくさわっている : - SpringBoot / Java / htmx / alpine.js / Tailwind CSS / MySQL PostgreSQL / Redis / AWS 色々/ AWS copilot CLI / Terraform ポリシー: - 設計は難しくても正しいものに寄せる - 設定は簡単なものに寄せる

Slide 4

Slide 4 text

JJUG CCC 初登壇になります今回送ったプロポーザルは下記です。 (話しやすい順に並べています) Spring-boot-adminで簡易モニタリングを行い、開発生産性を上げる SpringBoot x htmx x Alpine.js x Tailwind.css による怖くないWeb開発 Spring AI x AWS Bedrockで簡単なAIアプリケーションを作る SpringBoot x Mybatis x TestContainerでSQLテストを行う <= 採択

Slide 5

Slide 5 text

ユニットテストで SQLテストしていますか？

Slide 6

Slide 6 text

NewSQLの登場と浸透 RDBは、負荷(特に書き込み負荷)に弱く、代替手段としてNoSQL(MongoDBやDynamo など)にするしかないと思われていた。 NewSQLの登場でこの問題が解消され、移行も多くのRDBの機能継承しているので比較的容易。今後のRDBに期待。

Slide 7

Slide 7 text

メディア事業部もほぼ RDBにすべてのデータを寄せているメリット - データ型がある - ある程度柔軟な検索ができる - データ移行ツールなどが充実している - キャッシュと組み合わせると結構負荷にも耐えられるデメリット - 設計力は結構必要 - 定期的にメンテナンス時間が必要 (セキュリティアップデートなど

Slide 8

Slide 8 text

SQLを試す環境はあるローカルマシン上 ● ローカルにDBをインストール ● ローカルにDockerで構築 ● H2Databaseを起動する(MySQL、PostgreSQL, 一部制限あり?) サーバ上 ● 開発者ごとにサンドボックススキーマを立てる Web上 ● DB<> Fiddle (MySQL, Postgres, Db2, Firebird, SQL Server SQLite, YugabyteDB, Oracle) ● SQL Fiddle (MySQL, Postgres, SQL Server SQLite) ● DB Fiddle (MySQL, Postgres, SQLite)

Slide 9

Slide 9 text

Slide 10

Slide 10 text

SQLテストを行うには？ ● (ローカルでもリモートでも) DBを立ち上げる ● DBのマイグレーションを正確に行う ○ これを実施しないと、テストが色々な理由で失敗するようになる ● テストコードを書く下記の3つを行う必要がある。通常、SSHやdocker composeでDBを立ち上げる必要があるが、Testcontainersは、DBの立ち上げ部分をテストコードに書けるというのが良い。

Slide 11

Slide 11 text

DBの環境構築をどうするか？ Testcontainersを使用して、テスト時に環境構築をしてもらおう

Slide 12

Slide 12 text

TestContainersとは? DB、メッセージング、Web系サービスなどテスト用のDockerコンテナを提供するためのオープンソースになります。モック作成や設定ファイルなどの細かい環境設定ではなく、テストコードの中にテスト環境をコードとして定義するように設計されています。

Slide 13

Slide 13 text

TestContainersとは?(2) Moduleの提供も順次追加されています。これがあると専用の起動クラスやパラメータ等が用意されるます。 RDB, VectorDB, NoSQL Database, MessageBrokerなど JavaとGoとC#に提供されているModuleが多い Minio、Redis、pg vector などもある

Slide 14

Slide 14 text

TestContainersを立ち上げてみる DEMO

Slide 15

Slide 15 text

TestContainersを立ち上げてみる (1) - Testcontainers/Modulesのページで使用したい Modulesを検索 - Maven/Gradleのdependenciesに記載する

Slide 16

Slide 16 text

TestContainersを立ち上げてみる (2) - 各言語のテストコードでコンテナを立ち上げる - ほぼワンソースでいける。 - @DynamicPropertySourceでJDBCの接続先を指定する必要があるので注意

Slide 17

Slide 17 text

TestContainersを立ち上げてみる (3) - 各設定情報はインスタンス変数の中身を見るとわかる。 - ポート番号・ホスト名は動的にすることのがオススメ (固定することも可能) - 固定にすると他のコンテナが立ち上がっているときに失敗するため - これを使用して、テストコードを記述する。

Slide 18

Slide 18 text

テストデータの管理をしよう環境構築は終わったので、テストデータの管理をどうするか考える

Slide 19

Slide 19 text

テストデータの管理の方法テストデータを用意する必要がある。方法1: TestcontainerにSQLファイルが入ったディレクトリをマウントする方法2: @Sqlアノテーションを使用する方法3: JDBCドライバのTC_INITSCRIPTでSQLを実行指定する方法4: マイグレーションツールでテストデータを管理する

Slide 20

Slide 20 text

テストデータの管理 (方法1:マウント機能を利用する ) メリット: - SQLファイルが分散しない - マイグレーションツール等を用意しなくていいデメリット: - マイグレーションツールを使用している場合、開発とテストで異なるものを使用するので、ダブルメンテになる

Slide 21

Slide 21 text

テストデータの管理 (方法2:@Sqlを使用する ) メリット: - SQLファイルが分散しない - マイグレーションツール等を用意しなくていいデメリット: - マイグレーションツールを使用している場合、開発とテストで異なるものを使用するので、ダブルメンテになる可能性がある

Slide 22

Slide 22 text

テストデータの管理 (方法2:@Sqlを使用する ) @Sqlもいくつか書き方がある - script指定、SQL文指定 @Sqlはメソッドから抜けるとロールバックされるので注意 (外からの確認が難しい)

Slide 23

Slide 23 text

テストデータの管理 (方法3:JDBCのTC_INITSCRIPTで...) JDBCドライバの設定で接続時にSQLが実行できる。メリット: - コード側で意識しなくても実行可能デメリット: - 個別で必要な場合には全く向かない

Slide 24

Slide 24 text

テストデータの管理 (方法4:マイグレーションツールを使用する) Flywayの場合、依存関係を解決し、 SQLファイルを設定すると、SpringBootが起動時にマイグレーション用のSQLが実行される。メリット: - 普段使っているマイグレーションツールと同じものが使用でき、二重管理にならないデメリット: - マイグレーション処理が遅い場合にテストで待たされる

Slide 25

Slide 25 text

DB環境・データの準備は完了 DB環境の用意 => TestcontainersでOK マイグレーション => Flyway、SQLスクリプト、@Sql など... (お好みで)

Slide 26

Slide 26 text

SpringBoot x MyBatis x Testcontainers 連携 DB環境・データの準備は完了したので、テストコードを書く。 SpringBootを使用していれば、難しいことはなく淡々とSQLに接続しているソースに対してテストコードを書くだけでいい。

Slide 27

Slide 27 text

テストコード SpringBootを使用した通常のテストコードを書くだけになります。

Slide 28

Slide 28 text

デモ

Slide 29

Slide 29 text

まとめ SpringBootとTestcontainersは相性がよく、既存のテストコードに簡単に導入することができました。コンテナイメージのダウンロード以外は起動も速く、生産性は上がると思います。環境構築が大変なのかSQLテストを書いてる現場はあまり多くない印象があります。Testcontainersを使用することで、この問題を解消できると思うので導入をしてみてください。

Slide 30

Slide 30 text

ご清聴ありがとうございました !

Slide 31

Slide 31 text

Appendix. FAQ - SpringBoot Docker Compose Support との棲み分け - Dockerは開発とテストで同じものを使用するか？ - コンテナイメージはTestcontainersのモジュールにあるものしか使えないのか？

Slide 32

Slide 32 text

SpringBoot Docker Compose Support との棲み分け SpringBootにもDocker Compose Support が入っています。開発時に別ターミナルで「docker compose up」を打たずに、SpringBootのアプリケーション起動時に一緒に docker-compose.ymlに書いてあるコンテナを起動してくれます。

Slide 33

Slide 33 text

SpringBoot Docker Compose Support との棲み分け (2) テスト時は処理をDocker Composeの起動処理をスキップするプロパティがあるので、これをセットすればOK

Slide 34

Slide 34 text

Dockerは開発とテストで同じものを使用するか？ Answer. 基本的にNG 基本的には開発とテストは完全にわけて使います。同じものを使用すると個人環境に依存しすぎてしまうので、危険です。

Slide 35

Slide 35 text

コンテナイメージは Testcontainersのモジュール以外でも使えるのか？ Answer: YES. 汎用的にコンテナを触るようにAPIが用意されています。起動処理やパラメータ設定などを書く必要がありますが、基本的にはどんなコンテナでも使えます。