Skip to main content

Advanced configuration

Configure server URL​

By default, Eyes-Playwright communicates with the Applitools public Eyes cloud server, located at https://eyesapi.applitools.com.

If you have a dedicated cloud or an on-premise server, configure a different Eyes server URL as follows:

eyes.setServerUrl("asd");

Configure proxy​

If your company's network requires requests to go through the corporate proxy, you can configure it as follows:

eyes.setProxy(new ProxySettings("uri"));
eyes.setProxy(new ProxySettings(
    "uri",
    1234, // port
    "username",
    "password"
));

Make every visual test correspond to a functional test​

Every call to eyes.open and eyes.close defines a test in Applitools Eyes, and all the calls to eyes.check between them are called "steps". In order to get a test structure in Applitools that corresponds to the test structure in your functional test, you should open/close tests in every test call.

For example, when running with JUnit as a test runner:

@BeforeEach
public void beforeEach() {
    eyes.open(page, "applitools.com website", "My first Playwright Java test!");    
}

@AfterEach
public void afterEach() {
    eyes.close();
}

@Test
public void test() {
    // ...
}

Organize tests in batches​

You can manage how visual tests are aggregated into batches. Here are two methods for clustering tests into a single batch:

Method 1: environment variable​

Run all the processes that execute Playwright with the same value for APPLITOOLS_BATCH_ID. For example, run tests with Maven with the same randomly generated UUID:

#! Unix based machines:
APPLITOOLS_BATCH_ID=`uuidgen` mvn test

You can control the batch name that is displayed in the Test Manager. For example:

export APPLITOOLS_BATCH_ID=`uuidgen`
export APPLITOOLS_BATCH_NAME="Login tests"
mvn test

Method 2: eyes.setBatch​

Provide all Eyes instances with the same value for batch ID. For example:

BatchInfo batchInfo = new BatchInfo("name");
batchInfo.setId("id");
eyes.setBatch(batchInfo);

Stitch mode​

The default stitch mode is Scroll. In order to change it:

eyes.setStitchMode(StitchMode.CSS);
eyes.setStitchMode(StitchMode.SCROLL);

Background information​

Eyes-Playwright allows you to control if the checkpoint image should include only the viewport (what you see in the browser window when you first load a page), or if it should also include the full page (i.e. what you would see if you manually scrolled down, or across, a page that is larger than the viewport).

When Eyes-Playwright takes a full page screenshot, it does so by taking multiple screenshots of the viewport at different locations of the page (via Playwright's API), and then "stitching" them together. The output is one clear, potentially very large, screenshot of what can be revealed on the page when it is scrolled.

There are two methods for creating the stitched screenshot, and they are both related to the way the page is moved relative to the viewport.

1. Stitch mode: Scroll​

Using this method, the page is scrolled, just as a user would scroll. Eyes-Playwright takes the viewport screenshot, then scrolls the page to calculated locations. The issue with this method is that the page might respond to scroll events, and change the way it appears visually between the screenshots.

2. Stitch mode: CSS​

Using this method, the page is moved around by changing the CSS property transform on the HTML element with different values for translate(x,y). This method is not sensitive to scroll events, and is usually the recommended method for stitching.

Stitch overlap​

The stitch overlap is the length of the intersecting area between two screenshots that are stitched together. It's like placing two printed pictures one on top of the other with some overlapping area between them.

This is useful in cases of fixed elements, like a footer, that show up in each of the sub-screenshots. Using a stitch overlap bigger than the size of the footer would make it disappear from every image, and only show up at the bottom of the full page screenshot.

The default stitch overlap is 50 pixels. To change it:

eyes.setStitchOverlap(60);

Match level​

The match level determines the way by which Eyes compares the checkpoint image with the baseline image.

The default match level is Strict. To change it:

eyes.setMatchLevel(MatchLevel.LAYOUT);
eyes.check(Target.window().layout());
eyes.check(Target.window().strict());
eyes.check(Target.window().ignoreColors());
eyes.check(Target.window().exact());

For more information, see How to use Eyes match levels

Ignore displacements​

By using ignore displacements you can hide differences that arise from content whose position on the page has changed, and focus on mismatches caused by actual changes in the content.

The default is false. To change it:

// For the rest of the execution
eyes.setIgnoreDisplacements(true);

// For a single checkpoint
eyes.check(Target.window().ignoreDisplacements());

For more information, see Hide displacement diffs tool

Test properties​

You can provide additional information about each test in custom fields, which can then show up in Test Manager in their own column.

This is done by calling setProperties on the configuration, and providing it with an array of properties with the structure {name, value}. For example:

Configuration configuration = eyes.getConfiguration();
configuration.addProperty("my custom property", "some value");
eyes.setConfiguration(configuration);

Test results​

The results of the test can be consumed as the return value from eyes.close. Here's an example for creating a formatted output string out of the TestResults object:

public String formatTestResults(TestResults testResults) {
    return "\n" +
        "Test name: " + testResults.getName() + "\n" +
        "Test status: " + testResults.getStatus() + "\n" +
        "URL to results: " + testResults.getUrl() + "\n" +
        "Total number of steps: " + testResults.getSteps() + "\n" +
        "Number of matching steps: " + testResults.getMatches() + "\n" +
        "Number of visual diffs: " + testResults.getMismatches() + "\n" +
        "Number of missing steps: " + testResults.getMissing() + "\n" +
        "Display size: " + testResults.getHostDisplaySize().toString() + "\n" +
        "Steps: " + Arrays.stream(testResults.getStepsInfo()).map(
        stepInfo -> "" + stepInfo.getName() + " - " + getStepStatus(stepInfo)
    ).collect(Collectors.toList());
}

public String getStepStatus(StepInfo stepInfo) {
    if (stepInfo.getIsDifferent()) {
        return "Diff";
    } else if (!stepInfo.getHasBaselineImage()) {
        return "New";
    } else if (!stepInfo.getHasCurrentImage()) {
        return "Missing";
    } else {
        return "Passed";
    }
}

Running with a try-with-resources statement​

We recommend that you use a testing framework when running an Eyes test. Although it is possible to run a test using Java's main() method, this method does not automatically close all resources; a resource is an object that must be closed after the program is finished with it. When resources are still being used, and are not closed, it causes the main method to get stuck in an endless loop waiting for the resources to be closed.

To prevent this problem, we recommend that you use the try-with-resources statement. This statement is a try statement that declares one or more resources, but ensures that each resource is closed at the end of the statement. This prevents Eyes from getting stuck in an endless loop.

Example​

try(ClassicRunner runner = new ClassicRunner()) {
    Eyes eyes = new Eyes(runner);
    eyes.open(driver, "try-with-resources", "try-with-resources");
    eyes.check(Target.window().fully(true));
    eyes.close(false);
    TestResultsSummary results = runner.getAllTestResults(false);
    System.out.println(results);
}