Sample XCode project demonstrating new UITesting features in XCode 8.3/9

The sample app is a very simple app that demonstrates some of the interesting new features of the XCode 8.3 (and onwards) UI testing API. The app screen loads a lable whose text changes asynchronously to simulate a delay. There are 2 text fields , one to enter a 3 letter country code and another that displays its name from the API. There is a text view to display informational message and finally a button. The API http://services.groupkt.com/country/get/iso3code is used to retrieve country code info.

Siri Service and Activities

The Siri service API now helps to integrate the AI features of iOS for use to UI testing. One of the immidiate uses of this API is to bring the App to the foreground from background without needing to relaunch the app. App features that rely on backgrounding and foregrounding can now easily be tested.

[Siri API] (https://developer.apple.com/reference/xctest/xcuisiriservice)

func testLaunchAndSendToBG()  {
    let element1 = XCUIApplication().staticTexts["Country Name from ISO3 code"]
    let element2 = XCUIApplication().textFields["Enter 3 letter Country Code"]

    Given("I wait for the screen header to Appear") { _ in
        let result1 = waitForElementToExist(element: element1)
        XCTAssertTrue(result1)
    }

    When("I press the home button") { _ in
        XCUIDevice.shared().press(XCUIDeviceButton.home)
    }

    And("I ask Siri to open my App") { _ in
        XCUIDevice.shared().siriService.activate(voiceRecognitionText: "open xcode832")
    }

    Then("I should see the text Enter 3 letter Country Code") { _ in
        let result2 = waitForElementToExist(element: element2)
        XCTAssertTrue(result2)
    }
}

// Gherkin style Wrapper around `XCTContext.runActivity`

import Foundation
import XCTest

extension XCTest {

    func Given(_ text: String, step: () -> Void ) {
        XCTContext.runActivity(named: #function + " " + text) { _ in
        step()
        }
    }

    func When(_ text: String, step: () -> Void ) {
        XCTContext.runActivity(named: #function + " " + text) { _ in
        step()
        }
    }

    func Then(_ text: String, step: () -> Void ) {
        XCTContext.runActivity(named: #function + " " + text) { _ in
        step()
        }
    }

    func And(_ text: String, step: () -> Void ) {
        XCTContext.runActivity(named: #function + " " + text) { _ in
        step()
        }
    }

    func But(_ text: String, step: () -> Void ) {
        XCTContext.runActivity(named: #function + " " + text) { _ in
        step()
        }
    }
}

The above code also demonstrates the use of Activities that allow us to group a group of statements in a named block of code. This causes the test result report to be formatted in a more conscise way so that its more readable.

Waiting APIs

The new version of XCode and XCTest has introduced new waiting API's that let us wait for an array of expectations. Its also possible to use this so that the order in which the expectations are satistfied is also checked.

[Waiting API] (https://developer.apple.com/reference/xctest/xctwaiter)

func waitFor(element e: XCUIElement) -> Bool {
  let p = NSPredicate(format: "exists == true")
  let e1 = XCTNSPredicateExpectation(predicate: p, object: e)
  let result = XCTWaiter.wait(for: [e1], timeout: 10)
  return (result == .completed)
}

Screenshots & Attachments

Screenshots can now be taken using the new APIs. Xcode deletes screenshots if the tests are success bu default, how ever this can be overridded through APIs. The API offers to capture screenshots of the whole screen or of an individual UI element.

[Screenshot API] (https://developer.apple.com/documentation/xctest/xcuiscreen)

func testGetAValidCountryCode() {
    let countryCodeTextInputElement = XCUIApplication().textFields.matching(identifier: "countryCodeField").element(boundBy: 0)
    let countryDescription = XCUIApplication().textFields["Australia"]
    let getInfoButton = XCUIApplication().buttons.matching(identifier: "getCountryInfo").element(boundBy: 0)
    let readyToInput = XCUIApplication().staticTexts["Enter 3 letter Country Code"]

    _ = waitForElementToExist(element: readyToInput)
    countryCodeTextInputElement.tap()
    countryCodeTextInputElement.typeText("AUS")
    getInfoButton.tap()
    XCTAssertTrue(waitForElementToExist(element: countryDescription))

    // Capture Screenshot
    XCTContext.runActivity(named: "Capture screenshot") { activity in
      let screen = XCUIScreen.main
      let screenShot = screen.screenshot()
      let attachment = XCTAttachment(screenshot: screenShot)
      attachment.lifetime = .keepAlways // Keep even if test fails, else xcode deletes it.
      activity.add(attachment)
    }
}