Mock is Useful and Necessary

Unit Test

一般来说,我们应该为一个类中每一个对外公开的方法创建单元测试。书写单元测试的一般步骤应该是这样的:

  • 创建对应的需要测试的类的实例;根据具体需要测试的方法来决定是否需要创建实例对象,静态方法不需要对应实例,实例方法则需要。
  • 调用需要测试的方法;调用具体的类方法或者是在上一步的实例对象上调用实例方法。
  • 使用Assert语句来断言。判断方法的返回值和我们预期的值是否相等,相等则测试通过;否则会抛出AssertionError,测试失败。JUnit不会立即终止执行,而是会统一记录这些失败的,等到所有Test Class执行完毕后最后给出结果反馈。

很简单,对吧?Not Exactly!!!上面的步骤其实是建立在测试方法有返回值的情况下的,如果一个方法仅仅执行某些动作,并没有返回值呢?

public class SomeActions {

    ActionsImp imp;

    public SomeActions(ActionsImp imp) {
        this.imp = imp;
    }

    public void noResultAction(int value){
        imp.doSomething(value);
    }
}

我们怎么测试SomeActions中的noResultAction方法?因为没有可用的返回值可用来比对,为了测试这个方法,我们只能换个角度去验证imp对象的doSomething方法被调用,且调用参数为value值。Oh,No!How To Do?别担心,一切的一切,使用Mock框架就行!

What is Mock & How to Use

到底什么是Mock呢?Mock的英文解释是模拟、伪造。废话不多说,Mock框架其实就是允许我们模拟需要测试的类,从而可以验证或者代理这个Mock类的某些行为。可能比较难理解,直接上代码说明如何使用mock。这里我们使用Mockito,它是广泛使用的mock框架之一。
 因为我们基于Android Studio,所以首先需要在build.gradle文件中添加Mockito的依赖:

testCompile 'org.mockito:mockito-core:2.0.73-beta'

要Mock一个类,首先需要调用Mockito.mock方法,mock方法有多个重载版本,但每个方法都需要指定一个Class类型参数用来指代需要mock的类,mock方法的返回值类型为Mock类的类型。使用Mock返回的对象,我们基本上可以为所欲为了!

    //Let's import Mockito statically so that the code looks clearer
   import static org.mockito.Mockito.*;
  
   //mock creation
   List mockedList = mock(List.class);
  • 验证mock对象的某些方法被正确调用

//using mock object
mockedList.add("one");
mockedList.clear();

//verification
verify(mockedList).add("one");
verify(mockedList).clear();

- 验证mock对象某些方法的调用次数
```java
//using mock
mockedList.add("once");

mockedList.add("twice");
mockedList.add("twice");

mockedList.add("three times");
mockedList.add("three times");
mockedList.add("three times");

//following two verifications work exactly the same - times(1) is used by default
verify(mockedList).add("once");
verify(mockedList, times(1)).add("once");

//exact number of invocations verification
verify(mockedList, times(2)).add("twice");
verify(mockedList, times(3)).add("three times");

//verification using never(). never() is an alias to times(0)
verify(mockedList, never()).add("never happened");

//verification using atLeast()/atMost()
verify(mockedList, atLeastOnce()).add("three times");
verify(mockedList, atLeast(2)).add("five times");
verify(mockedList, atMost(5)).add("three times");
  • 验证和mock对象的交互情况

//using mocks - only mockOne is interacted
mockOne.add("one");

//ordinary verification
verify(mockOne).add("one");

//verify that method was never called on a mock
verify(mockOne, never()).add("two");

//verify that other mocks were not interacted
verifyZeroInteractions(mockTwo, mockThree);

//using mocks
mockedList.add("one");
mockedList.add("two");

verify(mockedList).add("one");

//following verification will fail
verifyNoMoreInteractions(mockedList);

- 代理mock对象的某些方法的行为
```java
 //You can mock concrete classes, not just interfaces
 LinkedList mockedList = mock(LinkedList.class);

 //stubbing
 when(mockedList.get(0)).thenReturn("first");
 when(mockedList.get(1)).thenThrow(new RuntimeException());

 //following prints "first"
 System.out.println(mockedList.get(0));

 //following throws runtime exception
 System.out.println(mockedList.get(1));

 //following prints "null" because get(999) was not stubbed
 System.out.println(mockedList.get(999));

 //Although it is possible to verify a stubbed invocation, usually it's just redundant
 //If your code cares what get(0) returns, then something else breaks (often even before verify() gets executed).
 //If your code doesn't care what get(0) returns, then it should not be stubbed. Not convinced? See here.
 verify(mockedList).get(0);
- 默认情况下,调用mock对象的带返回值的方法会返回默认的值,比如返回null、0值或者false等。
- 允许多次代理mock对象的同一个方法,但具体的行为取决于该方法最近的一次代理行为。
- mock对象的代理方法,允许多次调用,只有不覆盖它的代理行为,那么每次调用的执行相同的行为或者返回相同的值
- 相同的方法和参数唯一确认一个代理。比如你可以分别代理get(int)方法在参数分别为0和1时的不同行为。
  • 代理mock对象的void方法
doThrow(new RuntimeException()).when(mockedList).clear();

   //following throws RuntimeException:
   mockedList.clear();
  • mock对象方法的参数匹配
//stubbing using built-in anyInt() argument matcher 
when(mockedList.get(anyInt())).thenReturn("element"); 
//stubbing using custom matcher (let's say isValid() returns your own matcher implementation):
when(mockedList.contains(argThat(isValid()))).thenReturn(true); 
//following prints "element" 
System.out.println(mockedList.get(999)); 
//**you can also verify using an argument matcher** 
verify(mockedList).get(anyInt());
  • mock对象方法的参数捕获
ArgumentCaptor<Person> argument = ArgumentCaptor.forClass(Person.class);
   verify(mock).doSomething(argument.capture());
   assertEquals("John", argument.getValue().getName());

Mockito还有其他用法,这里就不一一列举了,请自行参考Mockito类的说明文档。回到最开始的问题,现在我们可以使用Mockito轻松加愉快的创建对应测试方法测试noResultAction方法了。如下:

@Test
    public void testNoResultAction() throws Exception {
        ActionsImp mock = Mockito.mock(ActionsImp.class);
        SomeActions someActions = new SomeActions(mock);
        someActions.noResultAction(5);
        Mockito.verify(mock).doSomething(5);
    }

Othes

请注意,只有事先经过mock返回的mock对象,才能在其上运用上面的操作。

先Mock,再使用!

最后,在稍微提一下Mockito的原理!Mock框架一般都是基于Java提供的动态代理或者cglib(code generation lib)。由于Java动态代理仅仅支持接口,在mock一个具体的类时,mockito使用的是cglib库来创建动态代理对象。这里,我们不再深究mockito的实现原理!

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

推荐阅读更多精彩内容

  • 一、百变怪 Mockito Mockito可谓是Java世界的百变怪,使用它,可以轻易的复制出各种类型的对象,并与...
    罗力阅读 3,925评论 3 18
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,657评论 18 139
  • 在博客Android单元测试之JUnit4中,我们简单地介绍了:什么是单元测试,为什么要用单元测试,并展示了一个简...
    水木飞雪阅读 9,449评论 4 18
  • 本文主要针对测试框架 Mockito 在实践中的经常用到的代码做一示例汇总,并对其实现思想做以简单的分析。 介绍 ...
    alighters阅读 2,627评论 6 15
  • 冰橘自南来,红蕊向北开。 人间烟火意,星月影徘徊。
    李榆阅读 731评论 10 5