Для всіх користувачів Spring, саме зараз я зазвичай роблю свої інтеграційні тести, в яких бере участь асинхронна поведінка:
Запустіть подію програми у виробничому коді, коли завдання асинхронізації (наприклад, дзвінок вводу-виводу) завершено. Більшу частину часу ця подія так чи інакше потрібна для обробки відповіді на операцію асинхронізації у виробництві.
Коли ця подія відбулася, ви можете використовувати таку стратегію у своєму тестовому випадку:
- Виконати перевірену систему
- Прослухайте подію та переконайтеся, що подія почалася
- Зробіть свої твердження
Щоб вирішити цю проблему, спочатку вам знадобиться якась подія домену для запуску. Я тут використовую 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щоб зловити опубліковану подію в тестовому коді. Слухач події дещо більше задіяний, тому що йому належить безпечно обробляти два випадки:
- Виробничий код швидший, ніж тестовий випадок, і подія вже запустилася до перевірки тестового випадку на подію, або
- Тестовий випадок швидше, ніж виробничий код, і тестовий випадок повинен дочекатися події.
A CountDownLatchвикористовується для другого випадку, як згадується в інших відповідях тут. Також зауважте, що @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();
}
}
Останнім кроком є виконання тестової системи в тестовому випадку. Тут я використовую тест SpringBoot з JUnit 5, але це має працювати однаково для всіх тестів, що використовують 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
}
}
Зауважте, що на відміну від інших відповідей тут, це рішення також буде працювати, якщо ви будете виконувати свої тести паралельно і кілька потоків одночасно здійснювати код асинхронізації.