单元测试之Mockito与PowerMock

什么是Mock?

在单元测试中,我们往往想去独立地去测一个类中的某个方法,但是这个类可不是独立的,它会去调用一些其它类的方法和service,这也就导致了以下两个问题:

  • 外部服务可能无法在单元测试的环境中正常工作,因为它们可能需要访问数据库或者使用一些其它的外部系统。
  • 我们的测试关注点在于这个类的实现上,外部类的一些行为可能会影响到我们对本类的测试,那也就失去了我们进行单测的意义。

为了解决这种问题,Mockito和PowerMock诞生了。这两种工具都可以用一个虚拟的对象来替换那些外部的、不容易构造的对象,便于我们进行单元测试。两者的不同点在于Mockito对于大多数的标准单测case都很适用,而PowerMock可以去解决一些更难的问题(比如静态方法、私有方法等)。

Mockito

话不多说,就上干货。在下面这个例子中,我们要测试的class是DummyServiceDummyRepository用来从数据库中获取数据。getDummyNameUpperCase()方法会根据id获取数据,且该方法有一些数据处理的逻辑,如果我们只想测试这个逻辑:

public class DummyServiceTest {
 
    @Mock
    private DummyRepository dummyRepository;
 
    @InjectMocks
    private DummyService dummyService;
 
    @Before
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
    }
 
    @Test
    public void getDummyNameUpperCase() {
 
        Dummy mockedDummy = new Dummy("dm1", "Dummy 1", "This is dummy 1", 2000, true);
        when(dummyRepository.findById("dm1")).thenReturn(mockedDummy);
 
        String result = dummyService.getDummyNameUpperCase("dm1");

        verify(dummyRepository, times(1)).findById("dm1");
        assertThat(result, is("DUMMY 1"));
    }
}

根据经验,在大多数项目中,都会使用一些依赖注入框架(PicoContainer、Avalon、Excalibur等),因此这里的例子是基于Spring且我们使用了对应的Mockito注释@Mock来创建虚拟对象。对于被测class,使用@injectMocks进行注释即可。

实际上,mock的发生时机是当程序执行至”when-method-call-then-return”之类的语句时,上例中,也就是执行到when(dummyRepository.findById("dm1")).thenReturn(mockedDummy)时,mock就已经发生了;当程序运行至verify(dummyRepository, times(1)).findById("dm1")类的语句时,我们可以确认的是方法已经被调用了,这在测试一个类的逻辑流程时格外地有效。

上例展示了Mockito的基本用法,然后实际测试可能不会这么简单。比如我们需要将对象传递给mock的对象作为参数时,需要使用doAnswer

@Test
public void testAddressCombination() {
 

    Customer customer = new Customer("100089", "Zhang San", "1 Zhongguancun East Rd");
 
    doAnswer(new Answer<Customer>() {
        @Override
        public Customer answer(InvocationOnMock invocation) throws Throwable {
            Object originalArgument = (invocation.getArguments())[0];
            Customer param = (Customer) originalArgument;
            param.setHost("TestHost");
            return null;
        }
    }).when(hostService).expand(any(Customer.class));
 
    when(addressService.getPLZForCustomer(customer)).thenReturn(47891);
    doNothing().when(addressService).updateExternalSystems(customer);
 

    String address = customerService.getAddressCombination(customer, true);
 

    Mockito.verify(addressService, times(1)).updateExternalSystems(any(Customer.class));
    assertThat(address, is("47891_1 Zhongguancun East Rd_TestHost"));
}

以上的两个例子足以延伸并cover掉大部分普通的单测case,但是如果方法是静态的该怎么办呢?那就是——PowerMock。

PowerMock

PowerMock基本上cover了所有Mockito不能支持的case(大多数情况也就是静态方法,但其实也可以支持私有方法和构造函数的调用)。PowerMock使用了字节码操作,因此它是自带Junit runner的。在使用PowerMock时,必须使用@PrepareForTest注释被测类,mock才会被执行:

@RunWith(PowerMockRunner.class)
@PrepareForTest({StaticService.class})
public class DummyServiceTest {
 
    @Mock
    private DummyRepository dummyRepository;
 
    @InjectMocks
    private DummyService dummyService;
 
    @Before
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
    }
 
    @Test
    public void readDummyDescriptionWithoutIOException() throws IOException {
 
        String fileName = "DummyName";
 
        mockStatic(StaticService.class);
        when(StaticService.readFile(fileName)).thenReturn("Dummy");
 
        String value = dummyService.readDummyDescription(fileName);
 
        verifyStatic(times(1));
        StaticService.readFile(fileName);
        assertThat(value, equalTo("Dummy"));
    }
}

从上例可以看出,PowerMock的写法与Mockito基本相同,主要原因是PowerMock其实是从Mockito的一个特殊的API衍化而来,我们从Maven的摘录中可以看到,我们不仅导入了PowerMock Junit-module,还导入了Mockito-API:

<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-module-junit4</artifactId>
    <version>1.6.4</version>
    <scope>test</scope>
</dependency>
 
<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-api-mockito</artifactId>
    <version>1.6.4</version>
    <scope>test</scope>
    </dependency>

注意,被测类如果包含了静态方法,必须使用mockStatic()方法;与Mockito相似,当程序执行至when-then-mocking类语句时,我们可以认为方法被成功调用了。

PowerMock另外一个很好用的特性是当使用@PowerMockRunnerDelegate作为代理。比如在Spring中一般使用的是SpringJUnit4ClassRunner,但是这样@PrepairForTest就不能用了,因此:

@RunWith(PowerMockRunner.class)
@PowerMockRunnerDelegate(Parameterized.class)
@PrepareForTest({StaticService.class})
public class DummyServiceTest {
...
}

总结

Mockito提供了可读性较强、易于使用的mocking测试方法,而PowerMock提供了Mockito-like API是它使用方法基本与Mockito有很大类似,且它能解决静态方法、私有方法等“问题方法”

推荐阅读更多精彩内容