Visual tests with YAML
YAML Parameters for Visual tests
| Name | Type | Description |
|---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to VISUAL_TESTS. |
browser_type Required | String | Defines which browser will be used in tests. Can be one of CHROME or FIREFOX. |
resolution_width Required | Integer | Resolution width. |
resolution_height Required | Integer | Resolution height. |
pixel_tolerance_level Required | Float | The acceptable level of pixel tolerance. Allowed number of decimal places is two. |
images_history_limit Required | Integer | The number of items that should be kept in history. |
screenshots Required | Screenshot[] | Defines the URLs of the sites that will be tested. Contains information about baseline, headers and excluded areas. |
| headers | Header[] | The headers that will be sent with the request. |
| permissions | PipelinePermissions | Define to set permissions for the action. |
YAML example for Visual tests
actions:
- action: "Visual Tests"
type: "VISUAL_TESTS"
headers:
- name: "header1"
value: "value1"
- name: "header2"
value: "value2"
browser_type: "CHROME"
resolution_width: 1920
resolution_height: 1080
pixel_tolerance_level: 1.23
images_history_limit: 30
screenshots:
- url: "https://buddy.works/"
baseline: "https://buddy.works/"
headers:
- name: "header1"
value: "value1"
- name: "header2"
value: "value2"
excluded_areas:
- min_x: 200
min_y: 100
max_x: 500
max_y: 200YAML parameters for screenshots
| Name | Type | Description |
|---|---|---|
url Required | String | The URL of the site that should be tested. |
| baseline | String | The baseline to which the site under the provided URL will be compared. |
| headers | Header[] | The headers for the specific URL that will be sent with the request. |
| min_x | Integer | Required if you want to define excluded area. |
| min_y | Integer | Required if you want to define excluded area. |
| max_x | Integer | Required if you want to define excluded area. |
| max_y | Integer | Required if you want to define excluded area. |
PipelinePermissions schema
| Name | Type | Description |
|---|---|---|
| others | String | AccessLevel for the group Others. Can be one of DENIED, ALLOWED. Default setting is ALLOWED. |
| users | UserPermission[] | The list of users who will be granted a permission other than the Others group. |
| groups | GroupPermission[] | The group who will be granted a permission other than the Others group. |
permissions:
others: "DENIED"
users:
alex@buddy.works: "DENIED"
mike@buddy.works: "ALLOWED"
groups:
frontend: "DENIED"
backend: "ALLOWED"Last modified on July 5, 2023