สำหรับผู้ใช้สปริงทุกคนนี่คือวิธีที่ฉันมักจะทำการทดสอบการรวมระบบของฉันทุกวันนี้ที่มีการใช้งาน async:
เริ่มเหตุการณ์แอปพลิเคชันในรหัสการผลิตเมื่องาน async (เช่นการโทร I / O) เสร็จสิ้น ส่วนใหญ่เหตุการณ์นี้มีความจำเป็นต่อการตอบสนองของการดำเนินการ async ในการผลิต
เมื่อมีเหตุการณ์นี้เกิดขึ้นคุณสามารถใช้กลยุทธ์ต่อไปนี้ในกรณีทดสอบของคุณ:
- ดำเนินการระบบภายใต้การทดสอบ
- ฟังเหตุการณ์และตรวจสอบให้แน่ใจว่าเหตุการณ์นั้นเริ่มต้นขึ้น
- ทำการยืนยันของคุณ
ในการแยกแยะสิ่งนี้ก่อนอื่นคุณต้องมีกิจกรรมโดเมนก่อน ฉันใช้ UUID ที่นี่เพื่อระบุงานที่เสร็จ แต่คุณสามารถใช้งานได้อย่างอิสระตราบใดที่มันไม่เหมือนใคร
(โปรดทราบว่าข้อมูลโค้ดต่อไปนี้ใช้หมายเหตุประกอบลอมบอกเพื่อกำจัดรหัสแผ่นบอยเลอร์)
@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เพื่อตรวจจับเหตุการณ์ที่เผยแพร่ในรหัสทดสอบ ผู้ฟังเหตุการณ์มีส่วนเกี่ยวข้องเพิ่มขึ้นเล็กน้อยเนื่องจากมีการจัดการสองกรณีในลักษณะที่ปลอดภัยของเธรด:
- รหัสการผลิตเร็วกว่ากรณีทดสอบและเหตุการณ์ได้เริ่มต้นแล้วก่อนที่กรณีทดสอบจะตรวจสอบเหตุการณ์หรือ
- กรณีทดสอบเร็วกว่ารหัสการผลิตและกรณีทดสอบต้องรอเหตุการณ์
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
}
}
โปรดทราบว่าในทางตรงกันข้ามกับคำตอบอื่น ๆ ที่นี่การแก้ปัญหานี้จะใช้งานได้หากคุณดำเนินการทดสอบในแบบคู่ขนานและหลายเธรดใช้รหัส async พร้อมกัน