@applitools/eyes-puppeteer 1.12.0 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +56 -38
- package/package.json +6 -6
- package/types/index.d.ts +3 -0
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -7,52 +7,55 @@
|
|
|
7
7
|
</div>
|
|
8
8
|
<br/>
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
### Table of contents
|
|
11
11
|
|
|
12
12
|
- [Installation](#installation)
|
|
13
13
|
- [Applitools API key](#applitools-api-key)
|
|
14
14
|
- [Usage](#usage)
|
|
15
15
|
- [Getting started with the API](#getting-started-with-the-api)
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
16
|
+
- [Eyes constructor](#eyes-constructor)
|
|
17
|
+
- [open](#open)
|
|
18
|
+
- [Visual tests and baselines](#visual-tests-and-baselines)
|
|
19
|
+
- [Batches](#batches)
|
|
20
|
+
- [check](#check)
|
|
21
|
+
- [`checkSettings`](#checksettings)
|
|
22
|
+
- [Page screenshot](#page-screenshot)
|
|
23
|
+
- [Region screenshot](#region-screenshot)
|
|
24
|
+
- [Working with frames](#working-with-frames)
|
|
25
|
+
- [Ignore Regions](#ignore-regions)
|
|
26
|
+
- [Floating Regions](#floating-regions)
|
|
27
|
+
- [Content/Strict/Layout Regions](#contentstrictlayout-regions)
|
|
28
|
+
- [Accessiblity Regions](#accessiblity-regions)
|
|
29
|
+
- [Scroll root element](#scroll-root-element)
|
|
30
|
+
- [Tag (`withName`)](#tag-withname)
|
|
31
|
+
- [Lazy loading (`lazyLoad`)](#lazy-loading-lazyload)
|
|
32
|
+
- [Other checkSettings configuration](#other-checksettings-configuration)
|
|
33
|
+
- [close](#close)
|
|
34
34
|
- [Runners](#runners)
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
35
|
+
- [Purpose of runners](#purpose-of-runners)
|
|
36
|
+
- [1. Use the Ultrafast grid](#1-use-the-ultrafast-grid)
|
|
37
|
+
- [2. Manage tests across multiple `Eyes` instances](#2-manage-tests-across-multiple-eyes-instances)
|
|
38
38
|
- [Recipes for common tasks](#recipes-for-common-tasks)
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
39
|
+
- [Configure Server URL](#configure-server-url)
|
|
40
|
+
- [Configure Proxy](#configure-proxy)
|
|
41
|
+
- [Make every visual test correspond to a functional test](#make-every-visual-test-correspond-to-a-functional-test)
|
|
42
|
+
- [Organize tests in batches](#organize-tests-in-batches)
|
|
43
|
+
- [Method 1: environment variable](#method-1-environment-variable)
|
|
44
|
+
- [Method 2: `eyes.setBatch`](#method-2-eyessetbatch)
|
|
45
|
+
- [Stitch mode](#stitch-mode)
|
|
46
|
+
- [Background information](#background-information)
|
|
47
47
|
- [1. Stitch mode: Scroll](#1-stitch-mode-scroll)
|
|
48
48
|
- [2. Stitch mode: CSS](#2-stitch-mode-css)
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
49
|
+
- [Stitch overlap](#stitch-overlap)
|
|
50
|
+
- [Match level](#match-level)
|
|
51
|
+
- [Ignore displacements](#ignore-displacements)
|
|
52
|
+
- [Test properties](#test-properties)
|
|
53
|
+
- [Test results](#test-results)
|
|
54
|
+
- [Logging](#logging)
|
|
55
|
+
- [Configuring browsers for the Ultrafast grid](#configuring-browsers-for-the-ultrafast-grid)
|
|
56
|
+
- [Desktop browsers](#desktop-browsers)
|
|
57
|
+
- [Chrome device emulation](#chrome-device-emulation)
|
|
58
|
+
- [iOS device](#ios-device)
|
|
56
59
|
|
|
57
60
|
|
|
58
61
|
## Installation
|
|
@@ -716,7 +719,7 @@ It's possible to provide additional information about each test in custom fields
|
|
|
716
719
|
This is done by calling `setProperties` on the configuration, and providing it with an array of properties with the structure `{name, value}`. For example:
|
|
717
720
|
|
|
718
721
|
```js
|
|
719
|
-
const {Eyes
|
|
722
|
+
const {Eyes} = require('@applitools/eyes-puppeteer')
|
|
720
723
|
|
|
721
724
|
const eyes = new Eyes()
|
|
722
725
|
|
|
@@ -725,6 +728,21 @@ configuration.setProperties([{name: 'my custom property', value: 'some value'}])
|
|
|
725
728
|
eyes.setConfiguration(configuration)
|
|
726
729
|
```
|
|
727
730
|
|
|
731
|
+
The test properties could also be specified per batch by calling `setProperties` on the batch info, and providing it with an array of properties with the structure `{name, value}`. For example:
|
|
732
|
+
|
|
733
|
+
```js
|
|
734
|
+
const {Eyes, BatchInfo} = require('@applitools/eyes-puppeteer')
|
|
735
|
+
|
|
736
|
+
const eyes = new Eyes()
|
|
737
|
+
|
|
738
|
+
const batch = new BatchInfo()
|
|
739
|
+
batch.setProperties([{name: 'my custom batch property', value: 'some value'}])
|
|
740
|
+
|
|
741
|
+
const configuration = eyes.getConfiguration()
|
|
742
|
+
configuration.setBatch(batch)
|
|
743
|
+
eyes.setConfiguration(configuration)
|
|
744
|
+
```
|
|
745
|
+
|
|
728
746
|
### Test results
|
|
729
747
|
|
|
730
748
|
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:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@applitools/eyes-puppeteer",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.13.0",
|
|
4
4
|
"description": "Applitools Eyes SDK for Puppeteer",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"eyes-puppeteer",
|
|
@@ -62,17 +62,17 @@
|
|
|
62
62
|
}
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
|
-
"@applitools/core": "1.
|
|
66
|
-
"@applitools/eyes-api": "1.
|
|
67
|
-
"@applitools/spec-driver-puppeteer": "1.1.
|
|
65
|
+
"@applitools/core": "1.3.3",
|
|
66
|
+
"@applitools/eyes-api": "1.11.2",
|
|
67
|
+
"@applitools/spec-driver-puppeteer": "1.1.28"
|
|
68
68
|
},
|
|
69
69
|
"devDependencies": {
|
|
70
70
|
"@applitools/api-extractor": "1.2.11",
|
|
71
71
|
"@applitools/bongo": "^2.2.0",
|
|
72
72
|
"@applitools/scripts": "1.2.0",
|
|
73
|
-
"@applitools/sdk-coverage-tests": "2.7.
|
|
73
|
+
"@applitools/sdk-coverage-tests": "2.7.10",
|
|
74
74
|
"@applitools/sdk-shared": "0.9.15",
|
|
75
|
-
"@applitools/test-utils": "1.5.
|
|
75
|
+
"@applitools/test-utils": "1.5.4",
|
|
76
76
|
"@types/mocha": "^9.1.1",
|
|
77
77
|
"@types/node": "12",
|
|
78
78
|
"@typescript-eslint/eslint-plugin": "^5.27.0",
|
package/types/index.d.ts
CHANGED
|
@@ -410,6 +410,7 @@ export type CheckSettingsAutomationPlain = CheckSettingsImagePlain & {
|
|
|
410
410
|
disableBrowserFetching?: boolean;
|
|
411
411
|
layoutBreakpoints?: boolean | Array<number>;
|
|
412
412
|
visualGridOptions?: { [key: string]: any; };
|
|
413
|
+
nmgOptions?: { [key: string]: any; };
|
|
413
414
|
hooks?: { beforeCaptureScreenshot: string; };
|
|
414
415
|
renderId?: string;
|
|
415
416
|
timeout?: number;
|
|
@@ -431,6 +432,8 @@ export class CheckSettingsAutomation {
|
|
|
431
432
|
beforeRenderScreenshotHook(script: string): CheckSettingsAutomation;
|
|
432
433
|
ufgOption(key: string, value: any): CheckSettingsAutomation;
|
|
433
434
|
ufgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
435
|
+
nmgOption(key: string, value: any): CheckSettingsAutomation;
|
|
436
|
+
nmgOptions(options: { [key: string]: any; }): CheckSettingsAutomation;
|
|
434
437
|
renderId(renderId: string): CheckSettingsAutomation;
|
|
435
438
|
timeout(timeout: number): CheckSettingsAutomation;
|
|
436
439
|
waitBeforeCapture(waitBeforeCapture: number): CheckSettingsAutomation;
|