[译]Java将Powermock和Mockito搭配进行单元测试

本文为Powermock官方文档Mockito篇的中文翻译
原文:https://github.com/powermock/powermock/wiki/Mockito
翻译:却把清梅嗅

笔者的Android单元测试相关系列:

Android单元测试:Mockito使用详解
Android单元测试:使用本地数据测试Retrofit
Android单元测试:测试RxJava的同步及异步操作
Java 将Powermock和Mockito搭配进行单元测试
Android 自动化测试 Espresso篇:简介&基础使用
Android 自动化测试 Espresso篇:异步代码测试

简介

Powermock提供了基础的PowerMockito类,你仍然可以通过初始化 mock/object/class 并配置它们的校验、期望行为、或者其他,以达到通过Mockito配置和验证你的预期(例如times(), anyInt())的目的。

所有的操作都需要再Class层级上配置 @RunWith(PowerMockRunner.class) 和 @PrepareForTest 注解

版本支持

image.png

用法


在下面的示例中,我们不对Mockito或PowerMockito API中的方法使用静态导入的方式,这便于我们观察实际代码是如何被测试的。 但是,我们强烈建议您静态导入方法的方式,以提高可读性。

请注意:Mockito团队在2.1.0的版本中增加了mock final 类型Class/Methods 的能力。 PowerMock 1.7.0版本之后支持此功能(请使用Mockito 2.8.9进行测试)。 使用PowerMock配置可以启用该功能。 如果您使用Mockito 2,建议使用Mockito来mock final 类型Class/Methods。

Mock 静态方法

下面的代码将展示如何Mock以及打桩(stub):

1.添加 @PrepareForTest 注解在你的Class层级上。

@PrepareForTest(Static.class) // Static.class contains static methods

2.调用PowerMockito.mockStatic() 以mock静态类(使用PowerMockito.spy(class) 来mock制定的方法).

PowerMockito.mockStatic(Static.class);

3.使用Mockito.when()配置你的期望:

Mockito.when(Static.firstStaticMethod(param)).thenReturn(value);

注意:如果需要模拟java系统/ bootstrap类加载器(在java.lang或java.net等中定义的类)加载的类,则需要调用[this](Mock-System)方法。

如何验证行为

想要验证静态方法是否被执行完毕,通过以下两个步骤:

1.首先,调用 PowerMockito.verifyStatic(Static.class) 来开始验证行为;
2.然后调用 Static.class 的静态方法进行验证。

例如:

PowerMockito.verifyStatic(Static.class); // 1
Static.firstStaticMethod(param); // 2

重要:对于每一个方法的验证,你都需要去调用 verifyStatic(Static.class)方法。

如何使用参数匹配器

Mockito的匹配器依然被应用在了PowerMock 的mock行为中,下面的代码讲述如何为每个被mock的静态方法使用自定义的参数匹配器:

PowerMockito.verifyStatic(Static.class);
Static.thirdStaticMethod(Mockito.anyInt());

如何验证方法被调用的准确次数

你仍然可以使用Mockito.VerificationMode (e.g Mockito.times(x)) 通过PowerMockito.verifyStatic(Static.class, Mockito.times(2))的方式验证。

PowerMockito.verifyStatic(Static.class, Mockito.times(1));

如何为返回值为Void类型的静态方法抛出异常

如果不是Private修饰的方法,则:

PowerMockito.doThrow(new ArrayStoreException("Mock error")).when(StaticService.class);
StaticService.executeMethod();

注意,您可以对final修饰的 类和方法 执行相同的操作:

PowerMockito.doThrow(new ArrayStoreException("Mock error")).when(myFinalMock).myFinalMethod();

对于Private的方法,请使用PowerMockito.when(),比如:

when(tested, "methodToExpect", argument).thenReturn(myReturnValue);

一个完整的案例,讲述了如何mock、打桩以及验证静态方法

@RunWith(PowerMockRunner.class)
@PrepareForTest(Static.class)
public class YourTestCase {
    @Test
    public void testMethodThatCallsStaticMethod() {
        // mock all the static methods in a class called "Static"
        PowerMockito.mockStatic(Static.class);
        // use Mockito to set up your expectation
        Mockito.when(Static.firstStaticMethod(param)).thenReturn(value);
        Mockito.when(Static.secondStaticMethod()).thenReturn(123);

        // execute your test
        classCallStaticMethodObj.execute();

        // Different from Mockito, always use PowerMockito.verifyStatic(Class) first
        // to start verifying behavior
        PowerMockito.verifyStatic(Static.class, Mockito.times(2));
        // IMPORTANT:  Call the static method you want to verify
        Static.firstStaticMethod(param);


        // IMPORTANT: You need to call verifyStatic(Class) per method verification, 
        // so call verifyStatic(Class) again
        PowerMockito.verifyStatic(Static.class); // default times is once
        // Again call the static method which is being verified 
        Static.secondStaticMethod();

        // Again, remember to call verifyStatic(Class)
        PowerMockito.verifyStatic(Static.class, Mockito.never());
        // And again call the static method. 
        Static.thirdStaticMethod();
    }
}

局部Mock

您可以通过使用PowerMockito.spy来局部mock一个方法,请注意(以下内容取自Mockito文档并同样适用于PowerMockito):

有时,你并不能使用默认的 when(..)方法为spies打桩,例如:

List list = new LinkedList();
List spy = spy(list);
//Impossible: real method is called so spy.get(0) throws IndexOutOfBoundsException (the list is yet empty)
when(spy.get(0)).thenReturn("foo");

//You have to use doReturn() for stubbing
doReturn("foo").when(spy).get(0);

如何验证行为

你只需要使用 Mockito.vertify() 进行默认的校验:

Mockito.verify(mockObj, times(2)).methodToMock();

如何校验private的行为

使用 PowerMockito.verifyPrivate(), 比如:

verifyPrivate(tested).invoke("privateMethodName", argument1);

这种方式同样适用于private 的静态方法。

如何对对象的创建进行mock

使用 PowerMockito.whenNew(), 比如:

whenNew(MyClass.class).withNoArguments().thenThrow(new IOException("error message"));

请注意,您必须准备类creating用于测试的新MyClass实例,而不是MyClass本身。 (翻译无能,请参考下面的举例...)

比如说,如果执行new MyClass()的类被称为X,那么你必须执行@PrepareForTest(X.class)以使whenNew工作:

@RunWith(PowerMockRunner.class)
@PrepareForTest(X.class)
public class XTest {
        @Test
        public void test() {
                whenNew(MyClass.class).withNoArguments().thenThrow(new IOException("error message"));

                X x = new X();
                x.y(); // y is the method doing "new MyClass()"
               
                ..
        }
}

如何验证新对象的实例化

使用 PowerMockito.verifyNew :

verifyNew(MyClass.class).withNoArguments();

如何使用参数匹配器

Mockito的匹配器依然被应用在了PowerMock中:

Mockito.verify(mockObj).methodToMock(Mockito.anyInt());  

译者注: 以参数匹配器为例,官方文档似乎重复讲了两次,实际上,这两处分别针对静态方法和普通的方法进行了分开的阐述,对于静态方法,我们只能通过PowerMock的API进行校验,但是对于普通的成员方法,使用Mockito提供的API即可。

一个完整讲述了Spy的案例:

@RunWith(PowerMockRunner.class)
// We prepare PartialMockClass for test because it's final or we need to mock private or static methods
@PrepareForTest(PartialMockClass.class)
public class YourTestCase {
    @Test
    public void spyingWithPowerMock() {        
        PartialMockClass classUnderTest = PowerMockito.spy(new PartialMockClass());

        // use Mockito to set up your expectation
        Mockito.when(classUnderTest.methodToMock()).thenReturn(value);

        // execute your test
        classUnderTest.execute();

        // Use Mockito.verify() to verify result
        Mockito.verify(mockObj, times(2)).methodToMock();
    }
}

一个完整讲述了对Private方法的局部Mock的案例(PowerMock 1.3.6+版本后提供的支持):

@RunWith(PowerMockRunner.class)
// We prepare PartialMockClass for test because it's final or we need to mock private or static methods
@PrepareForTest(PartialMockClass.class)
public class YourTestCase {
    @Test
    public void privatePartialMockingWithPowerMock() {        
        PartialMockClass classUnderTest = PowerMockito.spy(new PartialMockClass());

        // use PowerMockito to set up your expectation
        PowerMockito.doReturn(value).when(classUnderTest, "methodToMock", "parameter1");

        // execute your test
        classUnderTest.execute();

        // Use PowerMockito.verify() to verify result
        PowerMockito.verifyPrivate(classUnderTest, times(2)).invoke("methodToMock", "parameter1");
    }
}

更多信息

想了解更多,请查看GitHub中的source

另请阅读Jayway团队博客中的PowerMockito相关[博客](http://blog.jayway.com/2009/10/28/untestable-code-with-mockito-and-powermock/)。

关于译者

却把清梅嗅
Github:https://github.com/qingmei2
CSDN:https://blog.csdn.net/mq2553299
简书:https://www.jianshu.com/u/df76f81fe3ff

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

推荐阅读更多精彩内容