そこにいるすべてのSpringユーザーにとって、これは今日の通常の統合テスト方法であり、非同期動作が関係しています。
非同期タスク（I / O呼び出しなど）が完了したときに、製品コードでアプリケーションイベントを発生させます。ほとんどの場合、本番環境で非同期操作の応答を処理するには、このイベントが必要です。
このイベントを配置すると、テストケースで次の戦略を使用できます。
- テスト中のシステムを実行する
- イベントをリッスンして、イベントが発生したことを確認します
- あなたの主張をする
これを分解するには、最初に何らかのドメインイベントを発生させる必要があります。ここでは、完了したタスクを識別するためにUUIDを使用していますが、固有のものである限り、他のものを使用してもかまいません。
（次のコードスニペットもLombokアノテーションを使用してボイラープレートコードを取り除くことに注意してください）
@RequiredArgsConstructor
class TaskCompletedEvent() {
private final UUID taskId;
// add more fields containing the result of the task if required
}
量産コード自体は通常、次のようになります。
@Component
@RequiredArgsConstructor
class Production {
private final ApplicationEventPublisher eventPublisher;
void doSomeTask(UUID taskId) {
// do something like calling a REST endpoint asynchronously
eventPublisher.publishEvent(new TaskCompletedEvent(taskId));
}
}
次に、Spring @EventListenerを使用して、公開されたイベントをテストコードでキャッチできます。イベントリスナーは、スレッドセーフな方法で2つのケースを処理する必要があるため、少し複雑です。
- 本番コードはテストケースよりも高速で、テストケースがイベントをチェックする前にイベントがすでに発生している、または
- テストケースは製品コードよりも高速で、テストケースはイベントを待機する必要があります。
CountDownLatchここで他の回答で述べられているように、A は2番目のケースに使用されます。また@Order、イベントハンドラーメソッドのアノテーションは、このイベントハンドラーメソッドが、本番環境で使用される他のイベントリスナーの後に呼び出されることを確認します。
@Component
class TaskCompletionEventListener {
private Map<UUID, CountDownLatch> waitLatches = new ConcurrentHashMap<>();
private List<UUID> eventsReceived = new ArrayList<>();
void waitForCompletion(UUID taskId) {
synchronized (this) {
if (eventAlreadyReceived(taskId)) {
return;
}
checkNobodyIsWaiting(taskId);
createLatch(taskId);
}
waitForEvent(taskId);
}
private void checkNobodyIsWaiting(UUID taskId) {
if (waitLatches.containsKey(taskId)) {
throw new IllegalArgumentException("Only one waiting test per task ID supported, but another test is already waiting for " + taskId + " to complete.");
}
}
private boolean eventAlreadyReceived(UUID taskId) {
return eventsReceived.remove(taskId);
}
private void createLatch(UUID taskId) {
waitLatches.put(taskId, new CountDownLatch(1));
}
@SneakyThrows
private void waitForEvent(UUID taskId) {
var latch = waitLatches.get(taskId);
latch.await();
}
@EventListener
@Order
void eventReceived(TaskCompletedEvent event) {
var taskId = event.getTaskId();
synchronized (this) {
if (isSomebodyWaiting(taskId)) {
notifyWaitingTest(taskId);
} else {
eventsReceived.add(taskId);
}
}
}
private boolean isSomebodyWaiting(UUID taskId) {
return waitLatches.containsKey(taskId);
}
private void notifyWaitingTest(UUID taskId) {
var latch = waitLatches.remove(taskId);
latch.countDown();
}
}
最後のステップは、テストケースでテスト中のシステムを実行することです。ここではJUnit 5でSpringBootテストを使用していますが、これはSpringコンテキストを使用するすべてのテストで同じように機能するはずです。
@SpringBootTest
class ProductionIntegrationTest {
@Autowired
private Production sut;
@Autowired
private TaskCompletionEventListener listener;
@Test
void thatTaskCompletesSuccessfully() {
var taskId = UUID.randomUUID();
sut.doSomeTask(taskId);
listener.waitForCompletion(taskId);
// do some assertions like looking into the DB if value was stored successfully
}
}
ここでの他の回答とは異なり、このソリューションは、テストを並行して実行し、複数のスレッドが同時に非同期コードを実行する場合にも機能することに注意してください。