Behave is a lightweight, flexible Swift library designed to help iOS developers write simple BDD (UI Tests) that execute quickly.
Note: Included in the ExampleApp is a side by side comparison of a test written in XCTestUI vs. Behave
Behave Test:
XCUI Test:
CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Behave into your Xcode project using CocoaPods, specify it in your Podfile:
pod 'Behave'
Declare an instance of Behaviour in your XCTestCase file
let api = Behaviour()Wrap your test in an Expectation. Use the testTimeInterval value for your timeout value
func testMyBehavior() {
let expectations = expectation(description: "Fulfill")
let api = Behaviour()
// TEST CODE WILL LIVE HERE
waitForExpectations(timeout: api.testTimeInterval){ error in }
}The listen method adds an event to your test queue and then listens for it to be triggered.
api.listen(for: "my-view") {
// In this example the completion handler will be called when the view controller below is loaded
}override func viewDidLoad() {
super.viewDidLoad()
view.accessibilityIdentifier = "my-view"
}- Behave, like XCUITest, relies on accessibility identifiers. You will need to add them in order to access elements in your code. They can be added in code directly or via Interface Builder.
- Behave listens for events to complete. When an event completes you can either trigger an action or verify some state change.
- When the event is triggered the completion handler will be called. Each event added to the test gets tested in the order it was added, FIFO. The events are triggered synchronously.
To make your test run use the run method. Behave tests will not run without explicitly calling run. Run has: success, fail and warn completion handlers.
- success This will get triggered upon completion of a successful run.
- fail This will get triggered if any of your events are not triggered. Behave will pass back the identifier in question so you can identify the issue.
- warn If you are running performance tests ( testPerformance property set to true ) and any frames get rendered at less than 60fps Behave will return a list of events tied to the slow frame rendering to make it easier for a developer to investigate UI issues.
api.run(success: {
// RESET CUSTOM UI?
}, fail: {error in
XCTFail(error)
expectations.fullfill()
}, warn: { warnings in
print(warnings)
})Note: Behave attempts to reset the UI between tests in order to ensure smooth testing. There are probably cases where this might not work. So you may need to do this manually in the completion handler of the run() method.
api.run(success: {
// RESET CUSTOM UI?
}, fail: {error in
XCTFail(error)
expectations.fullfill()
}, warn: { warnings in
print(warnings)
})The test below is included in our sample app. It tests a simple login flow:
func testGivenTheUserEntersCredsWhenTheUserTapsSubmitAndTheRequestSucceedsThenDisplayTheHomeScreen() {
let expectations = expectation(description: "\(#function)")
let api = Behaviour()
api.listen(for: "login-view") {
api.stubNetworkRequest(stub: Stub(httpResponse: 200, jsonReturn: "{\"success\":\"true\"}", urlString: "https://somedomain.io"))
api.typeIntoTextField(identifier: "email", text: "email")
api.typeIntoTextField(identifier: "password", text: "password")
api.tapButton(identifier: "submit")
}
api.listen(for: "home-view") {
expectations.fulfill()
}
api.run(fail: { error in
XCTFail(error)
expectations.fulfill()
})
waitForExpectations(timeout: api.testTimeInterval)
}Behave is setup to do Integration Tests. There will most likely be cases where you will want to stub(fake) network requests. This can be done by passing a Stub into the stubNetworkRequest method in your test.
Stub Type:
public struct Stub {
public let httpResponse: Int32
public let jsonReturn: String
public let urlString: String
public init(httpResponse: Int32, jsonReturn: String, urlString:String) {
self.httpResponse = httpResponse
self.jsonReturn = jsonReturn
self.urlString = urlString
}
}Example Network Stub:
let api = Behaviour()
api.listen(for: "login-view") {
api.stubNetworkRequest(stub: Stub(httpResponse: 200, jsonReturn: "{\"success\":\"true\"}", urlString: "https://somedomain.io"))
api.tapButton(identifier: "CTA")
}This is an experimental feature. The intention is to warn the developer about possible screen rendering issues. This feature is set by the testPerformance property. By default it is set to true. Behave will emit warnings when it detects frames being rendered under the 60fps threshold.
let api = Behaviour()
api.run( warn: { warnings in
// A list of events tied to slow frame renders.
/*
Example output:
Performing under 60fps:
[["performance-view": 0.04127258330117911], ["row-15": 0.07719787495443597]]
*/
})If you wish to turn off performance testing simply set the testPerformance property to false.
listen(for identifier: String, completion: @escaping () -> Void)run(success: (() -> Void)? = nil, fail: ((_ error: String) -> Void)? = nil)typeIntoTextField(identifier: String, text: String)typeIntoSecureTextField(identifier: String, text: String)tapRightNavigationItem(with object: Any? = nil, with additionalObject: Any? = nil)tapBackButton()tapButton(identifier: String)selectTabOnTabBar(index: Int)selectTableRow(identfier: String, indexPath: IndexPath)scrollTableTo(indexPath: IndexPath, identfier: String)selectCollectionItem(identfier: String, indexPath: IndexPath)stubNetworkRequest(stub: Stub, httpResponse: Int32, jsonReturn: String, urlString: String)query(identifier: String) -> UIView?findTable() -> UITableView?findButton(identifier: String) -> UIButton?wait(for identifier: String, parent: UIView, complete: @escaping () -> Void)wait(for identifier: String, complete: @escaping () -> Void, fail: @escaping (_ errorString: String) -> Void)wait(for cell: IndexPath, parent: UITableView, complete: @escaping (UITableViewCell?) -> Void)waitForAlert(complete: @escaping () -> Void)