https://github.com/applitools/testresultshandler-js
https://github.com/applitools/testresultshandler-js
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/applitools/testresultshandler-js
- Owner: applitools
- Created: 2020-01-19T13:45:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:30:07.000Z (over 3 years ago)
- Last Synced: 2025-03-06T19:44:17.018Z (over 1 year ago)
- Language: JavaScript
- Size: 428 KB
- Stars: 0
- Watchers: 3
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ApplitoolsTestResultsHandler - Javascript/TypeScript
### 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 retrieve 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 support@applitools.com 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:
#### To initialize the Handler:
###### Without Runner
```javascript
let results = await eyes.close(false);
const handler= new ApplitoolsTestResultHandler(results, applitoolsViewKey);
```
###### With Runner
```javascript
const allTestResults = await runner.getAllTestResults(false);
for (result of allTestResults) {
const handler = new ApplitoolsTestResultHandler(result.getTestResults(), applitoolsViewKey);
await handler.downloadImages(downloadDir, 'diff'); // Example
}
```
##### **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.
```javascript
handler.downloadImages(downloadDir, 'diff')
```
##### **downloadBaselineImages** - Downloading the test baseline images to a given directory
```javascript
handler.downloadImages(downloadDir, 'baseline');
```
##### **downloadCurrentImages** - Downloading the test current image to a given directory.
```javascript
handler.downloadImages(downloadDir, 'current');
```
# 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