asiminaath/testresultshandler-java

ApplitoolsTestResultsHandler - Java

v2.0.3

The Applitools Test Results Handler extends the capabilities of TestResults with additional API calls. With these additional API calls you will be able to retrive additional details at the end of the test.

Note: The Test Results Handler requires your account View Key - which can be found in the admin panel. Contact Applitools support at [email protected] if you need further assistance retrieving it.

The images that can be downloaded are:

• The test baseline image - Unless specified, the images will be downloaded to the working directory.

• The actual images - Unless specified, the images will be downloaded to the working directory.

• The images with the differences highlighted - Unless specified, the images will be downloaded to the working directory.

• Get the status of each step [Missing, Unresolved, Passed, New]

How to use the tool:

Note: The following dependency needs to be added to your pom.xml file:

<dependency>
 <groupId>org.json</groupId>
 <artifactId>org.json</artifactId>
 <version>RELEASE</version>
</dependency> 

To initialize the Handler:

TestResults testResult= eyes.close(false);
ApplitoolsTestResultsHandler testResultHandler= new ApplitoolsTestResultsHandler(testResult,viewKey);

//Proxy Configuration
TestResults testResult= eyes.close(false);
ApplitoolsTestResultsHandler testResultHandler= new ApplitoolsTestResultsHandler(testResult, viewKey, proxyServer, proxyPort);

//Proxy Configuration with Username and Password
TestResults testResult= eyes.close(false);
ApplitoolsTestResultsHandler testResultHandler= new ApplitoolsTestResultsHandler(testResult, viewKey, proxyServer, proxyPort, proxyUser, proxyPassword);

downloadDiffs - Downloading the test images with the highlighted detected differences to a given directory. In case of New, Missing or passed step no image will be downloaded.

testResultHandler.downloadDiffs(Path_to_directory);

downloadBaselineImages - Downloading the test baseline images to a given directory

testResultHandler.downloadBaselineImages(Path_to_directory);

downloadCurrentImages - Downloading the test current image to a given directory.

testResultHandler.downloadCurrentImages(Path_to_directory);

downloadImages - Downloading the test baseline image and current image to a given directory.

testResultHandler.downloadImages(String Path_to_directory);

downloadAnimatedGif - Downloads a Gif of the Baseline Images, Current, and Diff images.

testResultHandler.downloadAnimatedGif(String Path_to_directory);

setPathPrefix - Setting this path prefix will determine the structure of the repository for the download images

testResultHandler.setPathPrefixStructure("TestName/AppName/Viewport/hostingOS/hostingApp");

In addition to downloading the images of the test, TestResultHandler also gives access through code to the visually comparison result per step. It returns an array of elements called RESULT_STATUS which can be one of the following four options: PASS, UNRESOLVED, NEW or MISSING

RESULT_STATUS[] stepsResultsArray = testResultHandler.calculateStepResults();

Further regarding:

Getting Diff Images Manually - http://support.applitools.com/customer/portal/articles/2457891 Getting Current/Baseline Images Manually - http://support.applitools.com/customer/portal/articles/2917372 Extend API features with EyesUtilities - http://support.applitools.com/customer/portal/articles/2913152