单元测试浅谈(二)——Mock和Stub

实际单元测试场景中，我们可能面对比较复杂的状况：

1. 真实的对象很难被创建
2. 真实的对象是通过文件系统、数据库或者网络异步获取的
3. 真实的对象运行效率低
4. 真实的对象难以模拟，比如网络错误等
5. 真实对象的行为有不确定性，无法通过真实对象覆盖全部场景

这时候就需要使用mock对象来提高单元测试的效率了。
本文基于OCMock简单说明一下Mock和Stub的使用场景。

简单的Mock和Stub

比如有如下场景，我们有一个租书系统，通过RentalService对外提供服务，RentalService通过持久化层查询某个人当前的租借记录，进而算出应付的租金，代码如下：

// RentalService
- (NSDecimalNumber *)rentForPerson:(NSString *)name
{
    NSArray *rentals = [self.persistence rentalsWithPersonName:name];
    
    return [self rentWithRentals:rentals];
}

假设persistence创建起来非常麻烦，并且需要访问数据库才能获取到具体的租借信息，这时候我们就可以使用mock来创建一个persistence对象，通过stub让这个persistence的-[RentalPersistence rentalsWithPersonName:]方法返回我们预期的数据，测试代码如下：

- (void)testRentForPerson
{
    id persistMock = OCMClassMock([RentalPersistence class]);
    
    Rental *rental = [[Rental alloc] initWithDictionary:@{@"person":@"Sam",
                                                          @"book":@"西游记",
                                                          @"price":[NSDecimalNumber numberWithFloat:1.5],
                                                          @"days":@(20)}];
    
    OCMStub([persistMock rentalsWithPersonName:[OCMArg any]]).andReturn(@[rental]);
    
    RentalService *service = [[RentalService alloc] initWithRentalPersist:persistMock];
    
    NSDecimalNumber *rent = [service rentForPerson:@"Jimmy"];
    XCTAssertEqualObjects(rent, [NSDecimalNumber numberWithInt:30], @"rent for person error");
    OCMVerify([persistMock rentalsWithPersonName:[OCMArg any]]);
}

第三行，我们使用mock创建了一个persistence对象，第十行我们通过stub让方法-[RentalPersistence rentalsWithPersonName:]返回了我们期望的一个数组，第十五行我们验证了使用我们提供的数据后，计算结果是否符合我们的期望，第十六行是mock的另外一个很重要的用法，它验证了在这个测试过程中，我们是否确实调用了-[RentalPersistence rentalsWithPersonName:]方法。

Block和异步方法的Mock和Stub

前面说过，persistence对象可能需要访问数据库才能获取到我们需用的信息，很有可能-[RentalPersistence rentalsWithPersonName:]方法是一个异步的实现，比如：

typedef void (^completion)(NSArray *rentals);
- (void)rentalsWithPersonName:(NSString *)name completion:(completion)comp;

租借记录是通过comp这个block传递出来的，这时候测试代码可以这样写：

- (void)testRentForPersonAsyn
{
    id persistMock = OCMClassMock([RentalPersistence class]);
    
    Rental *rental = [[Rental alloc] initWithDictionary:@{@"person":@"Sam",
                                                          @"book":@"西游记",
                                                          @"price":[NSDecimalNumber numberWithFloat:1.5],
                                                          @"days":@(20)}];
                                                        
    OCMStub([persistMock rentalsWithPersonName:[OCMArg any] completion:([OCMArg invokeBlockWithArgs:@[rental], nil])]);
    
    RentalService *service = [[RentalService alloc] initWithRentalPersist:persistMock];
    
    NSDecimalNumber *rent = [service rentForPersonAsyn:@"Jimmy"];
    
    XCTAssertEqualObjects(rent, [NSDecimalNumber numberWithInt:30], @"rent for person error");
    OCMVerify([persistMock rentalsWithPersonName:[OCMArg any] completion:[OCMArg any]]);
}

上述测试代码与非异步的代码最大的区别是第十行，第十行stub了方法- (void)rentalsWithPersonName:(NSString *)name completion:(completion)comp，让comp这个block使用了我们提供的参数执行，其余的测试代码与上面的完全一致
也可以使用另外一种方法进行block的单元测试：

- (void)testRentForPersonAsynUsingAndDo
{
    id persistMock = OCMClassMock([RentalPersistence class]);
    
    Rental *rental = [[Rental alloc] initWithDictionary:@{@"person":@"Sam",
                                                          @"book":@"西游记",
                                                          @"price":[NSDecimalNumber numberWithFloat:1.5],
                                                          @"days":@(20)}];
    
    OCMStub([persistMock rentalsWithPersonName:[OCMArg any] completion:[OCMArg any]]).andDo(^(NSInvocation *invocation){
        void (^completion)(NSArray *rentals);
        [invocation getArgument:&completion atIndex:3];
        
        NSArray *rentals = @[rental];
        completion(rentals);
    });
    
    __block BOOL isCalled = NO;
    OCMStub([persistMock rentalsWithPersonName:[OCMArg any]]).andDo(^(NSInvocation *invocation){
        isCalled = YES;
    });
    
    RentalService *service = [[RentalService alloc] initWithRentalPersist:persistMock];
    
    NSDecimalNumber *rent = [service rentForPersonAsyn:@"Jimmy"];
    
    XCTAssertEqualObjects(rent, [NSDecimalNumber numberWithInt:30], @"rent for person error");
    OCMVerify([persistMock rentalsWithPersonName:[OCMArg any] completion:[OCMArg any]]);
    XCTAssertFalse(isCalled);
}

这个实现与上个实现最大的差别是在第10-16行，这个实现使用了OCMStub([mockClass someMethod]).andDo(^(NSInvocation *invocation){ });来处理block参数。
我们首先在invocation参数里找到对应的block，然后让block使用我们提供的参数来执行。
这里我们还展示了OCMStub([mockClass someMethod]).andDo(^(NSInvocation *invocation){ });的另外一种用法：验证在这个单元测试中，某个方法不会被调用，在代码行的第18-21和第29行

Mock和Stub总结

1. Mock和Stub都是通过一种更加快捷的方式让我们能够及时迅速的获取到我们期望的对象和数据。
2. Stub更关注于状态，它可以通过硬编码一些输入或者输出，让我们获取我们需要的数据。
3. Mock更关注于行为，它可以记录对象中各个方法都调用情况，如：是否被调用，调用了几次、在某种情况下是否会抛出异常等。

备注

1. stub一个mock对象的方法后，不能在同一个mock对象上再一次stub这个方法，第二次的stub无效。
2. 不可stub一个非mock对象的方法，这种操作stub是无效的。