Espresso Tutorial

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

Install the SDK

We now support both Androidx and Android Support Libraries (in SDK versions 4+). Add the following dependencies to your build.gradle file based on which one you are using:

// If using the Support Android Libraries, add the following dependences
androidTestImplementation 'com.applitools:eyes-android-espresso:4.+@aar'
androidTestImplementation 'com.applitools:eyes-android-common:4.+'
androidTestImplementation 'com.applitools:eyes-android-core:4.+'
androidTestImplementation 'com.applitools:eyes-android-components:4.+@aar'
androidTestImplementation 'com.applitools:eyes-android-components-support:4.+@aar'

1
2
3
4
5
6

// If using the Androidx Libraries, add the following dependencies
androidTestImplementation 'com.applitools:eyes-android-espresso:4.+@aar'
androidTestImplementation 'com.applitools:eyes-android-common:4.+'
androidTestImplementation 'com.applitools:eyes-android-core:4.+'
androidTestImplementation 'com.applitools:eyes-android-components:4.+@aar'
androidTestImplementation 'com.applitools:eyes-android-components-androidx:4.+@aar'

1
2
3
4
5
6

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, the type of browser 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: eyes-android-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 in the environment variable APPLITOOLS_API_KEY or directly assign it to the eyes.api_key property. 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.

package helloworld.applitools.com.applitoolshelloworld;

import android.support.test.rule.ActivityTestRule;

import com.applitools.eyes.android.espresso.Eyes;

import org.junit.Rule;
import org.junit.Test;

import static android.support.test.espresso.Espresso.onView;
import static android.support.test.espresso.action.ViewActions.click;
import static android.support.test.espresso.matcher.ViewMatchers.withId;

/**
 * Instrumented test, which will execute on an Android device.
 *
 * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
 */
public class ExampleInstrumentedTest {

    @Rule
    public ActivityTestRule<MainActivity> mActivityRule = new ActivityTestRule(MainActivity.class);

    @Test
    public void simpleTest() {

        // Initialize the eyes SDK and set your private API key.
        Eyes eyes = new Eyes();

        /*
            **** If using Androidx, uncomment the following line of code: ****
        */
        //eyes.setComponentsProvider(new AndroidXComponentsProvider());

        eyes.setApiKey("YOUR_API_KEY");

        try {
            // Start the test
            eyes.open("Hello World!", "My first Espresso Android test!");

            // Visual checkpoint #1.
            eyes.checkWindow("Hello!");

            onView(withId(R.id.click_me_btn)).perform(click());

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

            // End the test.
            eyes.close();
        } finally {
            // If the test was aborted before eyes.close was called, ends the test as aborted.
            eyes.abortIfNotClosed();
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

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.

Learn more

Applitools Eyes is a 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. Applitools has over 40 SDKs supporting a broad range of testing environments.

Reference documentation

To learn more, check out the Applitools Eyes documentation and tutorials for other testing environments.

Request a demo

If you want to see a demo of all our other features, you do request a demo

# Espresso Tutorial

# Install the SDK

# Run your first test

# Analyze your test results

# Learn more

# Reference documentation

# Request a demo

# Knowledge base and Support