Java 单元测试 - 如何使用 mockito 答案对异步方法（使用回调）进行单元测试

Question

我在类Logic中有以下方法

public class Logic implements ILogic {

@Override
public void doSomethingInterestingAsync(final int number, 
                                        final ICallback callback){
    new Thread(new Runnable() {
        @Override
        public void run() {
            callback.response(number+1);
        }
    }).start();
  }
}

我通常用

来称呼它

ILogic.doSomethingInterestingAsync(1, new ICallback() {
    @Override
    public void response(int number) {
        System.out.println(String.format("response - %s", number));
    }
});

现在我想对其进行单元测试。

所以我想一个解决方案是使用CountDownLatch（在other SO 线程中找到）
如下：

@Test
public void testDoSomethingInterestingAsync_CountDownLatch() throws Exception {
    final CountDownLatch lock = new CountDownLatch(1);

    ILogic ILogic = new Logic();
    final int testNumber = 1;
    ILogic.doSomethingInterestingAsync(testNumber, new ICallback() {
        @Override
        public void response(int number) {
            assertEquals(testNumber + 1, number);
            lock.countDown();
        }
    });
    assertEquals(true, lock.await(10000, TimeUnit.MILLISECONDS));
}

而且效果很好。
但我也读过关于 Mockito 中的答案可能是一个更好的做法，
但我不能完全按照这些例子。
如何使用 Mockito 工具为使用回调的方法编写单元测试？
谢谢。

Answer 1

我不明白您为什么需要以 CountDownLatch 开头（根据您发布的代码判断），所以我将在我的回答中跳过它，请随时添加评论来解释我的意思不见了。

我会测试如下：

@Test
public void testDoSomethingInterestingAsyncIncrementsParameter() {
    ILogic logic = new Logic();
    ICallback callback = mock(ICallback.class);

    logic.doSomethingInterestingAsync(SOME_NUMBER, callback);

    verify(callback, timeout(1000)).response(SOME_NUMBER + 1);
}

Answer 2

CoundownLatch 方法可以正常工作，但如果回调中的断言失败，则无论如何测试仍会成功。为什么？主测试线程不知道其他线程在做什么——因此只有在主测试线程中发生断言失败时才会注意到它们。

测试线程/异步代码的更好和更简单的方法是使用类似ConcurrentUnit：

final Waiter waiter = new Waiter();

new Thread(() -> {
  doSomeWork();
  waiter.assertTrue(true);
  waiter.resume();
}).start();

// Wait for resume() to be called
waiter.await(1000);

无需像您期望的那样使用 CountdownLatch 和通过 Waiter 完成的断言。

Answer 3

我之前没有尝试过 CountDownLatch，但是可以，Mockito 中的 doAnswer 会完成异步方法验证。

我有这个方法可以测试：

// initialization
loginTabPresenter = new LoginTabPresenterImpl(iLoginTabView, iUserDAO);
// method to test
loginTabPresenter.onLoginClicked();

它在 iUserDAO 接口中调用异步方法的地方：

public void loginPhoneNumber(String phoneNumber, String password, final IDAOGetCallback callback)
// async method to test
iUserDAO.loginPhoneNumber(phone, password, callback)
// IDAOGetCallback is callback
callback.done(T item, DAOException e);

这是我的代码在使用项目调用 callback.done 时所做的：

//item is an user model, it's set when callback.done
setUserModel(userModel);

那么我是如何在 Mockito 中使用 doAnswer 完成单元测试的：

doAnswer(new Answer() {
            @Override
            public Object answer(InvocationOnMock invocation) throws Throwable {
                Object[] objects = invocation.getArguments();
                // Cast 2nd argument to callback
                ((IDAOGetCallback) objects[2]).done(iUserModel, null);
                return null;
            }
        }).when(iUserDAO).loginPhoneNumber(anyString(), anyString(), any(IDAOGetCallback.class));

稍微解释一下：当 iUserDAO.loginPhoneNumber 使用 3 个参数（任何 String、任何 String 和任何 Callback.class）调用时，它会调用 callback.done 方法以返回一个 Model 实例。

然后测试并验证：

loginTabPresenter.onLoginClicked();
verify(iMainView, times(1)).setUserModel(any(IUserModel.class));