优雅的单测-Mock_综合

一、背景

测试替身

测试替身	说明
Dummy	假数据，填充参数，无实际意义
stub	插桩
spy	伪装的真实对象
mock	模拟对象
fake	假对象，内存数据库

二、Mock

为什么需要mock

测试驱动的开发( TDD)要求我们先写单元测试，再写实现代码。在写单元测试的过程中，我们往往会遇到要测试的类有很多依赖，这些依赖的类/对象/资源又有别的依赖，从而形成一个大的依赖树，要在单元测试的环境中完整地构建这样的依赖，是一件很困难的事情。
在这里插入图片描述
为了测试类A，我们需要Mock B类和C类（用虚拟对象来代替）

Mock场景

提前创建测试，TDD中的先写单测用例
需求并行开发
需要创建演示程序
屏蔽无法访问的资源，如依赖方的RPC还没通，可以先MOCK调用，测试自己的功能
系统隔离

三、Mokito

Mockito是什么

Mockito是一款针对Java的单元测试mocking框架，它让你用简洁的API做测试。而且Mockito简单易学，它可读性强和验证语法简洁。
它与 EasyMock 和 jMock 很相似，都是为了简化单元测试过程中测试上下文( 或者称之为测试驱动函数以及桩函数 ) 的搭建而开发的工具
相较于EasyMock和JMock，Mockito支持了在执行后校验行为，使用更简洁。且默认集成在springboot2.x版本中，开箱即用。

常用的 Mockito 方法

序号	方法名	描述
1	Mockito.mock(classToMock)	模拟对象
2	Mockito.verify(mock)	验证行为是否发生
3	Mockito.when(methodCall).thenReturn(value1).thenReturn(value2)	触发时第一次返回value1，第n次都返回value2
4	Mockito.doThrow(toBeThrown).when(mock).[method]	模拟抛出异常
5	Mockito.mock(classToMock,defaultAnswer)	使用默认Answer模拟对象
6	Mockito.when(methodCall).thenReturn(value)	参数匹配
7	Mockito.doReturn(toBeReturned).when(mock).[method]	参数匹配（直接执行不判断）
8	Mockito.when(methodCall).thenAnswer(answer))	预期回调接口生成期望值
9	Mockito.doAnswer(answer).when(methodCall).[method]	预期回调接口生成期望值（直接执行不判断）
10	Mockito.spy(Object)	用spy监控真实对象,设置真实对象行为
11	Mockito.doNothing().when(mock).[method]	不做任何返回
12	Mockito.doCallRealMethod().when(mock).[method]	//等价于Mockito.when(mock.[method]).thenCallRealMethod(); 调用真实的方法
13	reset(mock)	重置mock

Mockito实现原理

Mockito基于ASM字节码层面实现的插桩实现。在Mock对象的时候，创建一个proxy对象，
比如这步操作 Mockito.when(mockedList.get(0)).thenReturn(“first”)
Mockito的代理对象会保存被调用的方法名（get），以及调用时候传递的参数（0），然后在调用thenReturn方法时再把“first”保存起来，这样就有了构建一个stub方法所需的所有信息，构建一个stub。
当get方法被调用的时候，实际上调用的是之前保存的proxy对象的get方法，返回之前保存的数据。

常用功能

1-验证行为

@Test
public void verifyBehaviour(){
    //模拟创建一个List对象List<Integer> mock = mock(List.class);//使用mock的对象mock.add(1);mock.clear();//验证add(1)和clear()行为是否发生verify(mock).add(1);verify(mock).clear();
}

2-模拟我们所期望的结果

@Test
public void when_thenReturn(){
    //mock一个Iterator类Iterator iterator = mock(Iterator.class);//预设当iterator调用next()时第一次返回hello，第n次都返回worldwhen(iterator.next()).thenReturn("hello").thenReturn("world");//使用mock的对象String result = iterator.next() + " " + iterator.next() + " " + iterator.next();//验证结果assertEquals("hello world world",result);
}

3-RETURNS_SMART_NULLS和RETURNS_DEEP_STUBS

@Test
public void returnsSmartNullsTest() {
    List mock = mock(List.class, RETURNS_SMART_NULLS);System.out.println(mock.get(0));//使用RETURNS_SMART_NULLS参数创建的mock对象，不会抛出NullPointerException异常。另外控制台窗口会提示信息“SmartNull returned by unstubbed get() method on mock”System.out.println(mock.toArray().length);
}
//RETURNS_DEEP_STUBS也是创建mock对象时的备选参数
//RETURNS_DEEP_STUBS参数程序会自动进行mock所需的对象，方法deepstubsTest和deepstubsTest2是等价的
@Test
public void deepStubsTest(){
    Account account=mock(Account.class,RETURNS_DEEP_STUBS);when(account.getRailwayTicket().getDestination()).thenReturn("Beijing");String destination = account.getRailwayTicket().getDestination();String destination1 = verify(account.getRailwayTicket()).getDestination();System.out.println("destination->"+destination);System.out.println("destination1->"+destination1);assertEquals("Beijing",destination);
}
@Test
public void deepStubsTest2(){
    Account account=mock(Account.class);RailwayTicket railwayTicket=mock(RailwayTicket.class);when(account.getRailwayTicket()).thenReturn(railwayTicket);when(railwayTicket.getDestination()).thenReturn("Beijing");String destination = account.getRailwayTicket().getDestination();String destination1 = verify(account.getRailwayTicket()).getDestination();System.out.println("destination->"+destination);System.out.println("destination1->"+destination1);assertEquals("Beijing",destination);
}

4-模拟方法体抛出异常

@Test
public void doThrow_when(){
    Assertions.assertThrows(RuntimeException.class, () -> {
    List list = mock(List.class);doThrow(new RuntimeException()).when(list).add(1);list.add(1);});
}

5-使用注解来快速模拟

@ExtendWith(MockitoExtension.class)
public class E_MockitoShorthand {
    @Mockprivate List mockList;@Testpublic void shorthand(){
    mockList.add(1);verify(mockList).add(1);}
}

6-参数匹配

@Test
public void with_arguments(){
    Comparable comparable = mock(Comparable.class);//预设根据不同的参数返回不同的结果when(comparable.compareTo("Test")).thenReturn(1);when(comparable.compareTo("Omg")).thenReturn(2);assertEquals(1, comparable.compareTo("Test"));assertEquals(2, comparable.compareTo("Omg"));//对于没有预设的情况会返回默认值assertEquals(0, comparable.compareTo("Not stub"));
}//如果你使用了参数匹配，那么所有的参数都必须通过matchers来匹配
@Test
public void all_arguments_provided_by_matchers(){
    Comparator comparator = mock(Comparator.class);comparator.compare("nihao","hello");//如果你使用了参数匹配，那么所有的参数都必须通过matchers来匹配verify(comparator).compare(anyString(),eq("hello"));
}

7-自定义参数匹配

@Test
public void with_unspecified_arguments(){
    List list = mock(List.class);//匹配任意参数when(list.get(anyInt())).thenReturn(1);when(list.contains(argThat(new isValid()))).thenReturn(true);assertEquals(1, list.get(1));assertEquals(1, list.get(999));assertTrue(list.contains(1));assertFalse(list.contains(3));
}
private class isValid implements ArgumentMatcher<Integer> {
    @Overridepublic boolean matches(Integer o) {
    return o == 1 || o == 2;}
}

8-捕获参数来进一步断言

//较复杂的参数匹配器会降低代码的可读性，有些地方使用参数捕获器更加合适。
@Test
public void capturing_args(){
    PersonDao personDao = mock(PersonDao.class);PersonService personService = new PersonService(personDao);ArgumentCaptor<Person> argument = ArgumentCaptor.forClass(Person.class);personService.update(1,"jack");verify(personDao).update(argument.capture());assertEquals(1,argument.getValue().getId());assertEquals("jack",argument.getValue().getName());
}class Person{
    private int id;private String name;Person(int id, String name) {
    this.id = id;this.name = name;}public int getId() {
    return id;}public String getName() {
    return name;}
}interface PersonDao{
    public void update(Person person);
}class PersonService{
    private PersonDao personDao;PersonService(PersonDao personDao) {
    this.personDao = personDao;}public void update(int id,String name){
    personDao.update(new Person(id,name));}
}

9-使用方法预期回调接口生成期望值（Answer结构）

@Test
public void answerTest(){
    //模拟创建一个List对象List mockList = mock(List.class);when(mockList.get(anyInt())).thenAnswer(new CustomAnswer());assertEquals("hello world:0",mockList.get(0));assertEquals("hello world:999",mockList.get(999));
}private class CustomAnswer implements Answer<String> {
    @Overridepublic String answer(InvocationOnMock invocation) throws Throwable {
    Object[] args = invocation.getArguments();return "hello world:"+args[0];}
}//也可使用匿名内部类实现
@Test
public void answer_with_callback(){
    //模拟创建一个List对象List mockList = mock(List.class);//使用Answer来生成我们我们期望的返回when(mockList.get(anyInt())).thenAnswer(new Answer<Object>() {
    @Overridepublic Object answer(InvocationOnMock invocation) throws Throwable {
    Object[] args = invocation.getArguments();return "hello world:"+args[0];}});assertEquals("hello world:0",mockList.get(0));assertEquals("hello world:999",mockList.get(999));
}

10-修改对未预设的调用返回默认期望

@Test
public void unstubbed_invocations(){
    //mock对象使用Answer来对未预设的调用返回默认期望值List mock = mock(List.class,new Answer() {
    @Overridepublic Object answer(InvocationOnMock invocationOnMock) throws Throwable {
    return 999;}});//下面的get(1)没有预设，通常情况下会返回NULL，但是使用了Answer改变了默认期望值assertEquals(999, mock.get(1));//下面的size()没有预设，通常情况下会返回0，但是使用了Answer改变了默认期望值assertEquals(999,mock.size());
}

11-用spy监控真实对象

//Mock不是真实的对象，它只是用类型的class创建了一个虚拟对象，并可以设置对象行为
//Spy是一个真实的对象，但它可以设置对象行为
//InjectMocks创建这个类的对象并自动将标记@Mock、@Spy等注解的属性值注入到这个中
@Test
public void spy_on_real_objects(){
    Assertions.assertThrows(IndexOutOfBoundsException.class, () -> {
    List list = new LinkedList();List spy = spy(list);//下面预设的spy.get(0)会报错，因为会调用真实对象的get(0)，所以会抛出越界异常//when(spy.get(0)).thenReturn(3);//使用doReturn-when可以避免when-thenReturn调用真实对象apidoReturn(999).when(spy).get(999);//预设size()期望值when(spy.size()).thenReturn(100);//调用真实对象的apispy.add(1);spy.add(2);assertEquals(100,spy.size());assertEquals(1,spy.get(0));assertEquals(2,spy.get(1));verify(spy).add(1);verify(spy).add(2);assertEquals(999,spy.get(999));spy.get(2);});
}

12-真实的部分mock

@Test
public void real_partial_mock(){
    //通过spy来调用真实的apiList list = spy(new ArrayList());assertEquals(0,list.size());A a  = mock(A.class);//通过thenCallRealMethod来调用真实的apiwhen(a.doSomething(anyInt())).thenCallRealMethod();assertEquals(999,a.doSomething(999));
}class A{
    public int doSomething(int i){
    return i;}
}

13-重置mock

@Test
public void resetMock(){
    List list = mock(List.class);when(list.size()).thenReturn(10);list.add(1);assertEquals(10,list.size());//重置mock，清除所有的互动和预设reset(list);assertEquals(0,list.size());
}

14-验证确切的调用次数

@Test
public void verifying_number_of_invocations(){
    List list = mock(List.class);list.add(1);list.add(2);list.add(2);list.add(3);list.add(3);list.add(3);//验证是否被调用一次，等效于下面的times(1)verify(list).add(1);verify(list,times(1)).add(1);//验证是否被调用2次verify(list,times(2)).add(2);//验证是否被调用3次verify(list,times(3)).add(3);//验证是否从未被调用过verify(list,never()).add(4);//验证至少调用一次verify(list,atLeastOnce()).add(1);//验证至少调用2次verify(list,atLeast(2)).add(2);//验证至多调用3次verify(list,atMost(3)).add(3);
}

15-连续调用

@Test
public void consecutiveCalls(){
    Assertions.assertThrows(RuntimeException.class, () -> {
    //模拟创建一个List对象List mockList = mock(List.class);//模拟连续调用返回期望值，如果分开，则只有最后一个有效when(mockList.get(0)).thenReturn(0);when(mockList.get(0)).thenReturn(1);when(mockList.get(0)).thenReturn(2);when(mockList.get(1)).thenReturn(0).thenReturn(1).thenThrow(new RuntimeException());assertEquals(2,mockList.get(0));assertEquals(2,mockList.get(0));assertEquals(0,mockList.get(1));assertEquals(1,mockList.get(1));//第三次或更多调用都会抛出异常mockList.get(1);});
}

16- 验证执行顺序

@Test
public void verification_in_order(){
    List list = mock(List.class);List list2 = mock(List.class);list.add(1);list2.add("hello");list.add(2);list2.add("world");//将需要排序的mock对象放入InOrderInOrder inOrder = inOrder(list,list2);//下面的代码不能颠倒顺序，验证执行顺序inOrder.verify(list).add(1);inOrder.verify(list2).add("hello");inOrder.verify(list).add(2);inOrder.verify(list2).add("world");
}

17-确保模拟对象上无互动发生

@Test
public void verify_interaction(){
    List list = mock(List.class);List list2 = mock(List.class);List list3 = mock(List.class);list.add(1);verify(list).add(1);verify(list,never()).add(2);//验证零互动行为verifyZeroInteractions(list2,list3);
}

18-找出冗余的互动(即未被验证到的)

@Test
public void find_redundant_interaction(){
    Assertions.assertThrows(NoInteractionsWanted.class, () -> {
    List list = mock(List.class);list.add(1);list.add(2);verify(list,times(2)).add(anyInt());//检查是否有未被验证的互动行为，因为add(1)和add(2)都会被上面的anyInt()验证到，所以下面的代码会通过verifyNoMoreInteractions(list);List list2 = mock(List.class);list2.add(1);list2.add(2);verify(list2).add(1);//检查是否有未被验证的互动行为，因为add(2)没有被验证，所以下面的代码会失败抛出异常verifyNoMoreInteractions(list2);});
}

持续更新中

优雅的单测-Mock

一、 背景