この記事でわかること
Springのテストで assertTimeoutPreemptively() を使うと、別スレッドで行ったINSERTがテスト終了後に残ることがあります。通知履歴の1行をH2へ追加し、assertTimeout() へ変えたとき、終了後の行数が1から0になることを確かめます。


題材は予約確定の通知履歴です。テスト中に履歴を1件作り、終了後には残さない前提で、次のテストが「履歴は0件」を期待しています。1件残ると、次に実行したテストの件数が合わなかったり、同じIDの登録が主キー重複で失敗したりします。まず実行順を変えず、前のテストがどこへ書いたかを確かめます。
実行サンプル
H2のテーブル定義、JUnit比較テスト2件、pom.xml、READMEを収録。JDK 17とMaven 3.9系を用意して、ZIPを展開したフォルダで mvn clean test を実行します。通知履歴を追加した後の行数を、タイムアウト指定ごとに確認できます。
どちらも時間内に成功し、終了後の行数だけが変わる
NotificationTimeoutTest は、Spring Bootの @JdbcTest で組み込みH2と JdbcTemplate を用意します。@JdbcTest は通常、テストごとにトランザクションを開始し、終了時にロールバックします。両テストは同じ insertLog() を使い、比較しやすいように行IDを100と200に分けます。
制限時間はどちらも10秒です。この例のINSERTは時間内に終わるため、タイムアウトを起こす待ち時間は入れていません。各テスト内では countRows() が1で、@AfterTransaction に入ってから、改めて同じIDの行を数えます。
package example.notification;
import java.time.Duration;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.autoconfigure.jdbc.JdbcTest;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.test.context.transaction.AfterTransaction;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTimeout;
import static org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;
@JdbcTest
class NotificationTimeoutTest {
private static final Duration LIMIT = Duration.ofSeconds(10);
@Autowired
private JdbcTemplate jdbc;
private long rowId;
private int expectedAfterRollback;
@Test
void preemptiveTimeoutLeavesTheInsertedRow() {
rowId = 100;
expectedAfterRollback = 1;
Thread testThread = Thread.currentThread();
Thread insertThread = assertTimeoutPreemptively(LIMIT, () -> insertLog(rowId));
System.out.printf("id=%d sameThread=%b%n", rowId, testThread == insertThread);
assertEquals(1, countRows());
}
@Test
void sameThreadTimeoutRollsBackTheInsertedRow() {
rowId = 200;
expectedAfterRollback = 0;
Thread testThread = Thread.currentThread();
Thread insertThread = assertTimeout(LIMIT, () -> insertLog(rowId));
System.out.printf("id=%d sameThread=%b%n", rowId, testThread == insertThread);
assertEquals(1, countRows());
}
@AfterTransaction
void checkAndCleanAfterRollback() {
try {
int remaining = countRows();
System.out.printf("id=%d rowsAfterRollback=%d%n", rowId, remaining);
assertEquals(expectedAfterRollback, remaining, "rows after the test transaction");
} finally {
jdbc.update("DELETE FROM notification_log WHERE id = ?", rowId);
}
}
private Thread insertLog(long id) {
jdbc.update("INSERT INTO notification_log (id, message) VALUES (?, ?)", id, "reservation confirmed");
return Thread.currentThread();
}
private int countRows() {
return jdbc.queryForObject(
"SELECT COUNT(*) FROM notification_log WHERE id = ?", Integer.class, rowId);
}
}
@SpringBootApplication
class NotificationTestApplication {}| タイムアウトの指定 | INSERTを実行した場所 | テスト中 | 終了後 |
|---|---|---|---|
assertTimeoutPreemptively(ID 100) | 別スレッド | 1行 | 1行 |
assertTimeout(ID 200) | 同じスレッド | 1行 | 0行 |
id=100 sameThread=false
id=100 rowsAfterRollback=1
id=200 sameThread=true
id=200 rowsAfterRollback=0この出力は、ID順に並べて抜き出したものです。両テストが成功するのは、比較用のテストとして「別スレッドでは1行残る」ことも明示的に期待しているためです。配布サンプルは観察後に自分のIDを消すので、この再現で別のテストに履歴を残しません。
テストのトランザクションは、INSERTした別スレッドに引き継がれない
Springはテストの開始時に、トランザクションの状態をテストスレッドに関連付けます。JdbcTemplate が同じスレッドで動くと、そのトランザクションの接続を使います。assertTimeoutPreemptively() はラムダを別スレッドで実行するので、そこで使うJDBC接続はテストのトランザクションに参加しません。このサンプルでは、別スレッドのINSERTが自動コミットされます。
テスト終了時にSpringが戻すのは、テストスレッドで始めたトランザクションです。別の接続ですでにコミットしたID 100には作用しません。同じSQL・データソースを使っていても、実行スレッドを変えただけで結果が変わります。この挙動は Spring Frameworkのテストのトランザクション管理にも記載されています。
ロールバックさせる書き込みは、assertTimeout() で同じスレッドに置く
書き込みをテストトランザクションへ参加させたまま、処理が制限時間内だったことを確認したい場合は assertTimeout() を使います。サンプルの sameThreadTimeoutRollsBackTheInsertedRow() では、この呼び出しで insertLog() を包みます。テスト中はID 200を1行読めますが、終了後に0行になります。
assertTimeout() は処理が戻った後に経過時間を評価します。時間を超えた瞬間にSQLを止める必要があるなら、要件に合うJDBCやデータベースのタイムアウトを別に設計します。assertTimeoutPreemptively() が時間超過でワーカーへ割り込みを試みても、処理が割り込みに応じるかは別です。サンプルが比較するのは時間内に終わったINSERTの参加先です。二つのアサーションの違いは JUnitのアサーションガイドで確認できます。
残った行は @AfterTransaction で数えてから消す
テストの最後で countRows() を呼ぶだけだと、どちらも1件です。@AfterEach も、トランザクション付きのテストでは通常まだその中で動きます。終了後のDBを見るには @AfterTransaction で数えます。サンプルは件数を確かめた後、アサーションが失敗した場合も finally で対象IDだけを削除します。
追試では、同じスレッドのテストにある assertTimeout() の1行を assertTimeoutPreemptively() へ戻します。INSERT直後は1件のままですが、終了後も1件となるため、@AfterTransaction の0件を期待するテストが失敗します。DDLとMaven設定もZIPに含まれ、外部DBなしで比較できます。
schema.sqlの全文を見る
CREATE TABLE notification_log (
id BIGINT PRIMARY KEY,
message VARCHAR(100) NOT NULL
);pom.xmlの全文を見る
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.5.16</version>
<relativePath/>
</parent>
<groupId>example</groupId>
<artifactId>spring-test-timeout-rollback</artifactId>
<version>1.0.0</version>
<properties>
<java.version>17</java.version>
</properties>
<dependencies>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</project>レビューでは、書き込みと後片付けの実行場所を確認する
通知履歴のINSERTは終了時に戻す仕様です。
assertTimeoutPreemptively()では別スレッドに出て1行残るので、assertTimeout()に変更しました。@AfterTransactionでID 200が0行になることを確認しています。
- 終了時にロールバックする対象を、テーブル名とテスト用IDで説明できる。
- タイムアウトの設定が、DBを書く処理を別スレッドで実行するか確認した。
- INSERT直後と、トランザクション終了後の両方で同じIDを確認した。
- 非同期処理自体がテスト対象なら、タスクの完了を待ち、専用DBと対象行の明示的な削除で隔離する。
DBを使うテストの準備と後片付けを整理したいときの1冊
『単体テストの考え方/使い方』のデータベースを扱う章は、DBを使ったテストでどこまで実データを用意し、テスト同士が影響しないようにするかを考えるときに使えます。読みながら、自分のテストに対して「どのデータは終了時に戻るか」「別の接続で確定したデータを誰が片付けるか」を、テーブルとIDで書き出してみてください。
単体テストの考え方/使い方
単体テストで「何を検証するか」の判断基準を学ぶ。
モックの使いどころや壊れにくいテストの考え方を整理できます。コード例はC#です。JUnitの操作入門ではなく、テストの設計と価値を深める本です。
- テスト対象の切り分けに迷っている
- 保守しやすい単体テストを書きたい
当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。
この記事とあわせて読みたい
まとめ
通知履歴がテスト後も残るときは、INSERTがどのスレッドと接続で実行されたかを確かめます。この例では assertTimeout() へ変えるとテストのトランザクションに参加し、終了後は0行です。修正の結果は、テスト中の件数に加えて @AfterTransaction で確認できます。



