iOS基于KIF测试UI

简介

常见的基于UI的测试框架有KIF, EarlGrey, WebDriverAgent, Frank, Calabash, Appium, UIAutomation（已被官方放弃）, UITesting

其中一类是通过Apple私有API操作UI，例如tap, doubleTap, swipe等模拟用户操作，好处是可以访问到原项目中的所有代码，可以做相关的验证操作，比起完全独立的UITest方便很多，常见的有KIF, EarlGrey
另一类框架是在App中注入一个Server（通常通过单元测试的项目注入）, 通过Server对外通信完成 UI 操作指令的执行。常见的框架有WebDriveAgent, Appium, Calabash, Frank
系统自带的UITesting在试用之后发现诸多不稳定的情况，例如，控件状态更新不及时，甚至不更新，导致测试结果很不稳定，故放弃

KIF框架基于UnitTest项目，UI操作覆盖较为全面，并且使用的就是xcode自带的单元测试，使用起来较为方便，支持OC和Swift，作者维护较为频繁，支持swift，能覆盖到大部分的测试用例，稳定性相对于UITesting较为良好，故采用该方案

基本使用

1. 创建一个UnitTest项目，可以通过Pod导入KIF库

pod 'KIF', '~> 3.5.1'

2. 使用`KIFTestCase`作为用例类

import KIF

class KIFDemoTests: KIFTestCase {
    override func beforeAll() {

    }

    override func beforeEach() {

    }

    override func afterAll() {

    }

    override func afterEach() {

    }

    func testExample() {

    }
}

从字面上很好理解，上面重载的四个方法就是用例执行前后执行的，类似于XCTestCase的tearDown和setUp，而用例的编写与UnitTest一样，使用test开头，无返回值无参数

3. 说明

使用KIF测试的所有元素必须设置accessibilityIdentifier或accessibilityLabel才能被KIF框架访问到

accessibilityIdentifier: 可以没有意义，需要保证唯一
accessibilityLabel：需要有意义，可以被VoiceOver访问，故通常使用Identifier标识控件，而accessibilityLabel的值通常是控件上的文本

如果是swift项目，需要添加一个方法获取KIFUITestActor对象，通常叫tester()

import KIF

extension XCTestCase {
    func tester(file : String = #file, _ line : Int = #line) -> KIFUITestActor {
        return KIFUITestActor(inFile: file, atLine: line, delegate: self)
    }

    func system(file : String = #file, _ line : Int = #line) -> KIFSystemTestActor {
        return KIFSystemTestActor(inFile: file, atLine: line, delegate: self)
    }
}

extension KIFTestActor {
    func tester(file : String = #file, _ line : Int = #line) -> KIFUITestActor {
        return KIFUITestActor(inFile: file, atLine: line, delegate: self)
    }

    func system(file : String = #file, _ line : Int = #line) -> KIFSystemTestActor {
        return KIFSystemTestActor(inFile: file, atLine: line, delegate: self)
    }
}

KIF库默认只支持accessibilityLabel，如果需要使用accessibilityIdentifier需要添加扩展，扩展可以在这里找到

https://github.com/kif-framework/KIF/tree/bcb58d0419cfaefe286f3df1c8618bac43b45921/IdentifierTests

由于waitForView方法每次获取到的都需要装换，这里封装一个泛型方法

extension KIFUITestActor {
    func waitFor(identifier: String) -> T {
        return self.waitForView(withAccessibilityIdentifier: identifier) as! T
    }
}

4. API

等待一个元素

let loginBtn = tester().waitForView(withAccessibilityIdentifier: "loginvc.loginbtn");
let loginBtn2 = tester().waitForView(withAccessibilityLabel: "Login")

设置超时

tester().usingTimeout(1).waitForView(withAccessibilityIdentifier: "loginvc.loginbtn")

等待元素消失

tester().usingTimeout(30).waitForAbsenceOfView(withAccessibilityIdentifier: "hud")

输入文本

//默认enterText方法在输完之后会进行验证，只输入不删除会验证不通过，故最好使用clearText方法
tester().enterText("hehe哈哈\n", intoViewWithAccessibilityIdentifier: "textField")
tester().clearText(fromAndThenEnterText: "hehe哈哈\n", intoViewWithAccessibilityIdentifier: "textField")

设置Slider

let slider = tester().waitForView(withAccessibilityIdentifier: "slider") as! UISlider
tester().setValue(0.5, for: slider)

tester().setValue(0.8, forSliderWithAccessibilityIdentifier: "slider")

设置Switch

tester().setOn(false, forSwitchWithAccessibilityIdentifier: "switch")

设置DatePicker

tester().tapView(withAccessibilityIdentifier: "datePicker")
let data = ["Sat Mar 4", "3", "32", "AM"]
tester().selectDatePickerValue(data)
tester().tapView(withAccessibilityIdentifier: "accessoryView.done")

设置Picker

tester().tapView(withAccessibilityIdentifier: "picker")
tester().selectPickerViewRow(withTitle: "c", inComponent: 0)
tester().selectPickerViewRow(withTitle: "2", inComponent: 1)
tester().tapView(withAccessibilityIdentifier: "accessoryView.done")

点击状态栏

tester().tapStatusBar()

swipe滑动

tester().swipeView(withAccessibilityIdentifier: "tableView", in: .up)
tester().swipeView(withAccessibilityIdentifier: "tableView", in: .down)

拖动交换cell

tester().moveRow(at: IndexPath(row: 0, section: 0) , to: IndexPath(row: 3, section: 0), inTableViewWithAccessibilityIdentifier: "tableView")

点击任意位置

tester().tapScreen(at: CGPoint(x: 200, y: 100))

监听系统弹框

tester().acknowledgeSystemAlert()

由于自带的acknowledgeSystemAlert只能处理一个，如果同时弹出多个系统框会无法处理，故封装一个方法可以处理多个

extension KIFUITestActor {
    /// handle multi system alerts
    func handleSystemAlert() -> Bool {
        var count = 0
        while acknowledgeSystemAlert() {
            count += 1
        }
        return count > 0
    }   
}

对于系统框或者框默认框可以使用accessibilityLabel处理，如alertView

tester().tapView(withAccessibilityIdentifier: "alertView")
//按钮没有设置identifier，可以直接使用按钮的文本
tester().tapView(withAccessibilityLabel: "好的")

获取tableviewcell的个数，随机点击
KIF不像UITesting一样可以直接获取到tableview的cell的个数，我们可以通过获取到控件，根据控件获取到cell的个数，然后随机点击

let tableView = tester().waitForView(withAccessibilityIdentifier: "tableView") as! UITableView
let rowCount = tableView.numberOfRows(inSection: 0);
let rowIndex = Int(arc4random_uniform(UInt32(rowCount)))
tester().tapRow(at: IndexPath(row: rowIndex, section: 0), in: tableView)

关于API，官方的Demo中有大量的例子，这里只是举出常用的，更多文档参见官方文档

例子

下面是我写的一个登陆的用例

func testLogin() {
     //进入登录页面
     if tester().tryFindingView(withAccessibilityIdentifier: "guideview.logBtn") {
         tester().tapView(withAccessibilityIdentifier: "guideview.logBtn")
     }

     //判断是否是注册页面
     if tester().tryFindingView(withAccessibilityIdentifier: "registevc.registebtn") {
         tester().tapView(withAccessibilityIdentifier: "registevc.loginbtn")
     }

     //切换到手机号登录
     if !tester().tryFindingView(withAccessibilityIdentifier: "loginvc.phonearea") {
         tester().tapView(withAccessibilityIdentifier: "loginvc.changemode")
     }

     //修改手机号的区号
     let areaLabel: UILabel = tester().waitFor(identifier: "loginvc.phonearea")
     if !areaLabel.text!.contains("86") {
         tester().tapView(withAccessibilityIdentifier: "loginvc.phonearea")
         tester().tapView(withAccessibilityIdentifier: "86")
     }

     //输入账号密码
     tester().clearText(fromAndThenEnterText: "18600**0785", intoViewWithAccessibilityIdentifier: "loginvc.phonetf")

     tester().clearText(fromAndThenEnterText: "123456", intoViewWithAccessibilityIdentifier: "loginvc.phonepwdtf")

     //登陆
     tester().tapView(withAccessibilityIdentifier: "loginvc.loginbtn")

     //等待登录完成(TODO:重试)
     tester().usingTimeout(30).waitForAbsenceOfView(withAccessibilityIdentifier: "loginvc.loginbtn")

     //TODO：验证进入主页面
}

demo：https://github.com/zhengbomo/KIFDemo

参考

https://zhuanlan.zhihu.com/p/22283843
https://github.com/kif-framework/KIF

最后安利一下自己的博客：https://zhengbomo.github.io