什么是Mock?
在單元測試中,我們往往想去獨立地去測一個類中的某個方法,但是這個類可不是獨立的,它會去調(diào)用一些其它類的方法和service,這也就導致了以下兩個問題:
- 外部服務可能無法在單元測試的環(huán)境中正常工作,因為它們可能需要訪問數(shù)據(jù)庫或者使用一些其它的外部系統(tǒng)。
- 我們的測試關注點在于這個類的實現(xiàn)上,外部類的一些行為可能會影響到我們對本類的測試,那也就失去了我們進行單測的意義。
為了解決這種問題,Mockito和PowerMock誕生了。這兩種工具都可以用一個虛擬的對象來替換那些外部的、不容易構造的對象,便于我們進行單元測試。兩者的不同點在于Mockito對于大多數(shù)的標準單測case都很適用,而PowerMock可以去解決一些更難的問題(比如靜態(tài)方法、私有方法等)。
Mockito
話不多說,就上干貨。在下面這個例子中,我們要測試的class是DummyService
,DummyRepository
用來從數(shù)據(jù)庫中獲取數(shù)據(jù)。getDummyNameUpperCase()
方法會根據(jù)id獲取數(shù)據(jù),且該方法有一些數(shù)據(jù)處理的邏輯,如果我們只想測試這個邏輯:
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"));
}
}
根據(jù)經(jīng)驗,在大多數(shù)項目中,都會使用一些依賴注入框架(PicoContainer、Avalon、Excalibur等),因此這里的例子是基于Spring且我們使用了對應的Mockito注釋@Mock
來創(chuàng)建虛擬對象。對于被測class,使用@injectMocks
進行注釋即可。
實際上,mock的發(fā)生時機是當程序執(zhí)行至”when-method-call-then-return”之類的語句時,上例中,也就是執(zhí)行到when(dummyRepository.findById("dm1")).thenReturn(mockedDummy)
時,mock就已經(jīng)發(fā)生了;當程序運行至verify(dummyRepository, times(1)).findById("dm1")
類的語句時,我們可以確認的是方法已經(jīng)被調(diào)用了,這在測試一個類的邏輯流程時格外地有效。
上例展示了Mockito的基本用法,然后實際測試可能不會這么簡單。比如我們需要將對象傳遞給mock的對象作為參數(shù)時,需要使用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,但是如果方法是靜態(tài)的該怎么辦呢?那就是——PowerMock。
PowerMock
PowerMock基本上cover了所有Mockito不能支持的case(大多數(shù)情況也就是靜態(tài)方法,但其實也可以支持私有方法和構造函數(shù)的調(diào)用)。PowerMock使用了字節(jié)碼操作,因此它是自帶Junit runner的。在使用PowerMock時,必須使用@PrepareForTest
注釋被測類,mock才會被執(zhí)行:
@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>
注意,被測類如果包含了靜態(tài)方法,必須使用mockStatic()
方法;與Mockito相似,當程序執(zhí)行至when-then-mocking類語句時,我們可以認為方法被成功調(diào)用了。
PowerMock另外一個很好用的特性是當使用@PowerMockRunnerDelegate
作為代理。比如在Spring中一般使用的是SpringJUnit4ClassRunner,但是這樣@PrepairForTest
就不能用了,因此:
@RunWith(PowerMockRunner.class)
@PowerMockRunnerDelegate(Parameterized.class)
@PrepareForTest({StaticService.class})
public class DummyServiceTest {
...
}
總結
Mockito提供了可讀性較強、易于使用的mocking測試方法,而PowerMock提供了Mockito-like API是它使用方法基本與Mockito有很大類似,且它能解決靜態(tài)方法、私有方法等“問題方法”