如何使用 mockito 测试运行异步线程的方法

Question

我有以下要测试的代码：

@Slf4j
@Component
public class DispatcherTask {

    private final MyClassService myClassService;
    private final SreamingService streamingService;
    private ExecutorService executor = Executors.newCachedThreadPool();
    private final Set < String > dispatching = new ConcurrentSkipListSet < > ();
    private final RetryPolicy < Object > httpRetryPolicy;

    public DispatcherTask(MyClassService myClassService, SreamingService streamingService) {
        this.myClassService = myClassService;
        this.streamingService = streamingService;
        this.httpRetryPolicy = new RetryPolicy < > ()
            .handle(HttpClientErrorException.class)
            .onRetriesExceeded(e - > log.warn("Max retries have been exceeded for http exception"))
            .withBackoff(2, 3, ChronoUnit.SECONDS)
            .withMaxRetries(5);
    }

    public void initMethod(MyClass myclass) {
        Failsafe.with(httpRetryPolicy).with(executor)
            .onFailure((e) - > {
                // TODO log.error();
                myClassService.updateStatus(myclass.getId(), Status.FAILED);
            })
            .onSuccess((o) - > {
                MyClass updatedMyClass = myClassService.updateStatus(myclass.getId(), GameStatus.ENDED);
                streamingService.storeData(updateMyClass);
                dispatching.remove(myclass.getPlatformId());
                //TODO log.info()
            })
            .runAsync(() - > {
                MyClass updatedMyClass =
                myClassService.updateStatus(myclass.getId(), Status.STREAMING);
                streamingService.polling(StreamedClass.builder().myclass(updatedMyClass).build());
                // TODO log.info()
            });
    }
}

这是我的 JUnit 测试Mockito ：

@ExtendWith(MockitoExtension.class)
public class DispatcherTaskTest {

    @Mock private MyClassService myClassService;
    @Mock private StreamingService streamingService;
    @InjectMocks private DispatcherTask dispatcherTask;

    @Test
    void test() throws InterruptedException {
        //given
        MyClass myclass = new MyClass().setId(1L).setName("name").setStatus(Status.CREATED);
        when(myClassService.updateStatus(myclass.getId(), Status.STREAMING)).thenReturn(myclass);
        when(myClassService.updateStatus(myclass.getId(), Status.ENDED)).thenReturn(myclass);
        doNothing().when(streamingService).polling(any());
        doNothing().when(streamingService).storeData(any());
        //when
        dispatcherTask.initMethod(myclass)
        //then
        verify(myClassService, times(1)).updateStatus(myclass.getId(), Status.STREAMING);
        verify(myClassService, times(1)).updateStatus(myclass.getId(), Status.ENDED);
    }
}

如果我像这样运行它，检查状态ENDED的最后一个验证失败。 如果我添加一个Thread.sleep(3l); 它通过了。 有没有更好或更安全的方法来通过测试而不添加sleep()方法？

Answer 1

两种可能有效的选择

1 - 在 Dispatcher 中添加shutdown和await方法

您可以在 Dispatcher Class 中添加shutdown和awaitTermination方法。 （如果需要，您可以统一它们）

public class DispatcherTask 
{    
  //...
  public void shutdownExecutor()
  {
     executor.shutdown();
  }
  public void waitToFinish(long seconds)
  {
     executor.awaitTermination(seconds,TimeUnit.SECONDS);
  }
  //...
}

boolean awaitTermination

在关闭请求后阻塞，直到所有任务都完成执行，或者发生超时，或者当前线程被中断，以先发生者为准。

---

使用 Dispatcher 中的此方法，可以更改测试，以便您可以：

@Test
void test() throws InterruptedException {
    //...
    dispatcherTask.initMethod(myclass);
    verify(myClassService, times(1)).updateStatus(myclass.getId(), Status.STREAMING);
   
    dispatcherTask.shutdownExecutor();
    dispatcherTask.waitToFinish(3L); //this will block without manually sleeping
    verify(myClassService, times(1)).updateStatus(myclass.getId(), Status.ENDED);
}

---

2 - 添加一个getExecutor方法并在测试中调用shutdown/await

public class DispatcherTask 
{    
  //...
  public ExecutorService getExecutor()
  {
     return executor;
  }
  //...
}

在你的测试中：

@Test
void test() throws InterruptedException {
    //...
     dispatcherTask.initMethod(myclass);
     verify(myClassService, times(1)).updateStatus(myclass.getId(), Status.STREAMING);
    
     //create a variable in the test or just invoke getExecutor
     dispatcherTask.getExecutor().shutdown();
     dispatcherTask.getExecutor().awaitTermination(3L, TimeUnit.SECONDS); 
     verify(myClassService, times(1)).updateStatus(myclass.getId(), Status.ENDED);
}

Answer 2

很难测试Failsafe的策略，例如：你将如何模拟一个测试：“我将重试 3 次，第 4 次我会成功。”，因为你确实有这个withMaxRetries(5) 。 为此，我建议您阅读thenAnswer中的Mockito所做的，而不是thenReturn 。 至少这是我们测试使用Failsafe的代码的方式。

不过，对于您的问题，只需使用dependency injection （人们认为仅存在于Spring中）。 因此，将您的代码重新编写为：

 public DispatcherTask(MyClassService myClassService, StreamingService streamingService, ExecutorService executor ) {

请注意，您的ExecutorService现在已在构造函数中传递。 现在创建一个DispatcherTask的真实实例，并模拟它的所有依赖项：

 DispatcherTask dt = new DispatcherTask(
       myClassService,       // this one is a Mock
       streamingService,     // this one is a Mock
       someExecutorService   // and what is this?
 );

什么是someExecutorService ？ 好吧，它是一个ExecutorService ，它将在运行单元测试的同一线程中执行您的代码。 从这里选择任何一个，例如。 请记住ExecutorService是一个interface ，因此创建一个在同一线程中运行的实现是微不足道的，就像这个答案一样。

Answer 3

我什至不尝试在单元测试中管理其他线程。 我不确定您的示例中的executor来自哪里，但我会在您的测试中注入一个在当前线程上执行的版本。 Guava 从 com.google.common.util.concurrent.MoreExecutors::directExecutor 返回一个。