使用Quick,OCMock及OHHTTPStubs进行单元测试

说明

• Quick: 它是一个行为驱动开发 (BDD)的测试框架, 同时支持Swift和Objective-C
• OCMock: 它是一个用于仿制对象的框架, 在单元测试中, 我们主要利用它干以下3件事
  • 让对象的指定方法返回指定的值
  • 仿制多个对象, 验证对象间的交互方式
  • 仿制对象的局部, 重写已存在对象的方法
• OHHTTPStubs: 它是一个用于仿制网络请求的框架, 我们可以利用它干以下几件事情
  • 让指定的网络接口响应指定的内容, 包括指定的数据, 文件及JSON对象
  • 模拟慢速网络, 如设置请求/响应时间, 设置下载速度等

Quick

在Objective-C中使用Quick

1. 添加一个空的swift文件

Quick_1.png

在单元测试的Target中必须要包含一个swift文件, 否则测试运行后就会终止并且返回以下错误：

*** Test session exited(82) without checking in. Executable cannot be
loaded for some other reason, such as a problem with a library it
depends on or a code signature/entitlements mismatch.

2. 编译问题

pod install后可能会出现Not such module 'Quick' 或 Not such module 'Nimble', 尝试一下方式解决:

1. 关闭并重新打开 Xcode workspace
2. 删除 ~/Library/Developer/Xcode/DerivedData 整个目录，这里面包含了 ModuleCache
3. 在 Manage Schemes 对话框中，勾选 Quick 、Nimble 、Pods-ProjectnameTests ，然后重新编译它们

Quick_2.png

编译时如果出现The “Swift Language Version” (SWIFT_VERSION) build setting must be set to a supported value for targets which use Swift. This setting can be set in the build settings editor. 这个错误, 则检查一下Xcode是否支持对应版本的Swift

Quick_3.png

最新的Nimble要求Swift5, Xcode9不支持这个版本, 需要用Xcode10

编写单元测试

1. 规范

遵循下面的模式来编写有效的单元测试：

• Arrange － 安排好所有先要条件和输入
• Act － 对要测试的对象或方法进行演绎
• Assert － 作出预测结果的断言

例如:

Quick_4.png

2. 别测试代码，而应该验证程序的行为

测试应该只在程序的行为和预期的不一样时，才不通过。测试应该测试程序的代码做了什么，而不是测试程序如何实现。验证应用程序做了什么的，叫做行为测试。

如上图, 测试的对象是ZXAudioService, 测试的行为是decode, 所以在测试decode行为时, 我们实际关心以下两个方面的问题:

1. 在给定amr数据合法时, decode行为是否能解码出wave数据
2. 在给定的amr数据不合法时, decode行为返回的解码数据是否为nil

而decode行为是如何进行解码的, 这个是我们不需要关心的, 所以这里我们不需要对解码的过程进行测试, 我们要测试的是行为本身, 验证的是行为的结果

3. DSL(域特定语言)描述

DSL是BDD框架的语法规范, 这个需要我们在使用中学习, 我这里先简单介绍一下常用的语法, 先用起来, 在使用的过程中, 逐步的了解它的高级用法

(1). QuickSpecBegin和QuickSpecEnd

QuickSpecBegin(identifier)表示开始测试某个对象, identifier表示测试对象的标识; QuickSpecEnd 表示测试块的结束, 在QuickSpecBegin 和 QuickSpecEnd 中间编写实际的测试逻辑

(2). beforeEach和afterEach

分别在测试实例的之前和之后执行, 相当于XCTest中的setUp和tearDown

(3). describe

表示一个测试块, 一般会将一组相关的测试实例放到describe的block中

(4). it

表示一个测试实例, 我们的测试行为及对行为的验证代码会写在it的block中

(5). expect

是Nimble提供的断言

一个行为测试的一般结构如下:

QuickSpecBegin(identifier)

// declare test object
beforeEach(^{
    // create test object
});

describe(@"action identifer", ^{
    beforeEach(^{
        // Arrange: conditions and inputs
    });
    
    it(@"test case", ^{
        // Act: test logical
        // Assert: make an assertion about the outcome of a prediction
    });
    
    afterEach(^{
    });
});

afterEach(^{
});

QuickSpecEnd

注: describe块可以嵌套

OCMock

使用场景举例

//
//  ZXIMServiceTests.m
//  ZXIM_Tests
//
//  Created by mye on 2019/8/29.
//  Copyright © 2019 xiaozhongwen. All rights reserved.
//

#import <ZXIM/ZXIMService.h>
#import <OCMock/OCMock.h>
#import <OHHTTPStubs/OHHTTPStubs.h>
#import <OHHTTPStubsResponse+JSON.h>
#import <CTMediator+ZXBaseKit.h>

QuickSpecBegin(IMService)

describe(@"login", ^{
    beforeEach(^{
        CTMediator *mediator = [CTMediator sharedInstance];
        id mediatorMock = OCMPartialMock(mediator);
        OCMStub([mediatorMock ZXBaseApiService_useSdkUserInfo])._andReturn(@(YES));
        OCMVerify([mediatorMock ZXBaseApiService_useSdkUserInfo]);
    });
    
    context(@"when use sdk user system", ^{
        beforeEach(^{
            [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest * _Nonnull request) {
                return [request.URL.absoluteString containsString:@"/oauth2/login"];
            } withStubResponse:^OHHTTPStubsResponse * _Nonnull(NSURLRequest * _Nonnull request) {
                NSDictionary *obj = @{ @"username": @"13545118725" };
                return [OHHTTPStubsResponse responseWithJSONObject:obj statusCode:200 headers:nil];
            }];
        });
        
        it(@"should fetch user info before login", ^{
            
        });
    });
});

QuickSpecEnd

这里我实际要测试ZXIMService的loginWithUserName:password 登录行为, 在这个接口中, 用到了CTMediator对象的ZXBaseApiService_useSdkUserInfo方法来返回使用的账号体系, 这这个场景下, 测试登录行为前去设置ZXBaseApiService_useSdkUserInfo是不可取的, 有时甚至是不可能做到的, 所以这里就Mock了一个CTMediator对象, 并且设置当CTMediator的mock对象调用ZXBaseApiService_useSdkUserInfo时的返回值, 为测试登录行为安排好了条件.

这里是OCMock详细的使用案例

OHHTTPStubs

使用场景举例

[OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest * _Nonnull request) {
    return [request.URL.absoluteString containsString:@"/oauth2/login"];
} withStubResponse:^OHHTTPStubsResponse * _Nonnull(NSURLRequest * _Nonnull request) {
    NSDictionary *obj = @{ @"username": @"13545118725" };
    return [OHHTTPStubsResponse responseWithJSONObject:obj statusCode:200 headers:nil];
}];

这里是为调用获取用户信息接口返回指定的响应数据, 当我们调用获取用户信息接口时, 发送请求的url中会包含/oauth2/login, 这时OHHTTPStubs会拦截这个请求并返回我们给定的数据

这里是OHHTTPStubs详细的使用案例