Welcome to Applitools Eyes!

You are just 4 steps away from adding automated visual validation to your tests

Step 2

Install the SDK

The Applitools Eyes XCUI SDK allows you to easily add visual checkpoints to your XCUI tests. It takes care of getting screenshots of your application via XCUI, sending them to the Eyes server for validation and failing the test in case differences are found.

Add 'EyesXCUI' to your podfile
target ‘YOUR_APPLICATION_TARGET_NAME’ do
	target ‘YOUR_UI_TESTING_TARGET_NAME’ do
		pod 'EyesXCUI'
	end
end

Step 3

Run your first test

Applitools Eyes reports differences by comparing screenshots of your application with baseline images that define the expected appearance of the application at each step of the test. By default, the Eyes SDK detects the environment in which the application is running (namely, the operating system and its viewport size) and compares the screenshots against baseline images that are specific to that environment. The first time you run a test in a given environment, its screenshots will be automatically saved as its baseline. Starting from the second run onward, you always have a baseline to compare against.

The test below is a taken from a demo project, which you can download from: https://github.com/applitools/eyes-ios-hello-world. It consists of two visual checkpoints, each validating the entire application window. The first time you run this test a new baseline will be created, and subsequent test runs will be compared to this baseline. If any screenshot mismatch its baseline image in a perceptible way, eyes.close() will throw a DiffsFoundException which includes a URL that points to a detailed report where you can see the detected differences and take appropriate actions such as reporting bugs, updating the baseline and more.

Before running the test, make sure to set the API key that identifies your account by directly assigning it using the eyes.apiKey method. You can find your API key under the user menu located at the right hand side of the test manager toolbar. If you don't yet have an account create it now to obtain your key.

func testExample() {
        // Initialize the eyes SDK and set your private API key.
        let eyes = Eyes()

        eyes.apiKey = "YOUR_API_KEY"

        // Start the test.
        eyes.open(withApplicationName: "Hello World!", testName: "My first test using EyesXCUI SDK!")

        // Visual checkpoint #1.
        eyes.check(withTag: "Hello", andSettings: Target.window().timeout(inSeconds: 5))

        // Click the "Click me!" button.
        XCUIApplication().buttons["Click me!"].tap()

        // Visual checkpoint #2.
        eyes.checkWindow(withTag: "Click!")

        // End the test.
        do {
            try eyes.close()
        } catch {
            eyes.abortIfNotClosed()
        }
    }

Step 4

Analyze your test results

Congratulations! You've successfully run your first visual UI test with Applitools Eyes! A detailed report is ready for your inspection at the Applitools Eyes test manager. Watch this 5 minute video to get acquainted with the test manager and to learn the basics of baseline maintenance.

Open Test Manager

Step 5

Learn more

Applitools Eyes is powerful platform for automated visual UI testing that supports full page screenshots, page layout matching, cross device and browser testing, test batching, baseline branching and merging, automated baseline maintenance, collaboration features, and much more. You can learn all about these features at the Applitools Eyes documentation and the resources page.