在带有 Mockito 的 JUnit 中，如何等待异步方法完成？

Question

我正在针对某些代码编写集成测试，这些代码在数据库中更新不同的值时异步创建记录。我想在创建记录后检查系统的状态，验证它是否按预期创建。因此，测试需要等到记录创建。

我可以使用 Mockito 为创建记录的函数创建一个间谍。Mockito 甚至可以选择通过 等待方法被调用Mockito.timeout，如果在一段时间内没有调用该方法，则放弃：

// Use or create/wire in spy. In my case, this is set up with @SpyBean from spring-boot-test.
RecordCreationService recordCreationServiceSpy = ...;

testClass.update(someValue);

Mockito.verify(recordCreationServiceSpy, Mockito.timeout(10_000)).createRecord(ArgumentMatchers.any());

然而，这只是等待调用开始，而不是等待调用完成。因此，这会进入竞争条件，在该条件下，验证可以在所需调用完成之前完成。

在使用 Mockito 在 JUnit 中进行验证之前，如何干净且简单地等待流程完成？

Answer 1

此功能不直接存在于 Mockito 中，因为目前有一个未解决的问题可以将此功能添加到 Mockito（Mockito issue #1089）。

我目前使用的解决方案是为 spied 方法编写自定义答案，等待调用完成后再返回。然后我正常验证结果。

@SpyBean
private RecordCreationService recordCreationServiceSpy;

@Test(timeout = 10_000)
public void recordShouldBeCreatedWhenDataIsUpdated() {
    // Set up test here

    updateValueAndWait(value);

    assertEquals(1, recordRepository.findAll().size());
    // Perform any additional verifications
}

private void updateValueAndWait(String value) {
    CountDownLatch latch = new CountDownLatch(1);
    Mockito.doAnswer(invocation -> {
        Object result = invocation.callRealMethod();
        latch.countDown();
        return result;
    }).when(recordCreationServiceSpy).insertRecord(any());

    testClass.update(value);

    try {
        latch.await();
    } catch (InterruptedException e) {
        throw new RuntimeException(e);
    }
}