单元测试之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有很大类似,且它能解决静态方法、私有方法等“问题方法”

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260

推荐阅读更多精彩内容

  • 在博客Android单元测试之JUnit4中,我们简单地介绍了:什么是单元测试,为什么要用单元测试,并展示了一个简...
    水木飞雪阅读 9,059评论 4 18
  • 几点说明:代码中的 //<== 表示跟上面的相比,这是新增的,或者是修改的代码,不知道怎么样在代码块里面再强调几行...
    邹小创阅读 13,792评论 15 41
  • 一、百变怪 Mockito Mockito可谓是Java世界的百变怪,使用它,可以轻易的复制出各种类型的对象,并与...
    罗力阅读 3,798评论 3 17
  • 什么是单元测试 在计算机编程中,单元测试(Unit Testing)又称为模块测试, 是针对程序模块(软件设计的最...
    HelloCsl阅读 10,808评论 1 46
  • 单元测试 单测定义 单元测试(Unit Testing)又称为模块测试, 是针对程序模块(软件设计的最小单位)来进...
    运维开发笔记阅读 1,952评论 0 2