Visual tests with YAML

YAML Parameters for Visual tests

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to VISUAL_TESTS.
browser_type
Required
StringDefines which browser will be used in tests. Can be one of CHROME or FIREFOX.
resolution_width
Required
IntegerResolution width.
resolution_height
Required
IntegerResolution height.
pixel_tolerance_level
Required
FloatThe acceptable level of pixel tolerance. Allowed number of decimal places is two.
images_history_limit
Required
IntegerThe 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.
headersHeader[]The headers that will be sent with the request.

YAML example for Visual tests

actions:
- action: "Visual Tests"
type: "VISUAL_TESTS"
headers:
- name: "header1"
value: "value1"
- name: "header2"
value: "value2"
trigger_condition: "ALWAYS"
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: 200

YAML parameters for screenshots

NameTypeDescription
url
Required
StringThe URL of the site that should be tested.
baselineStringThe baseline to which the site under the provided URL will be compared.
headersHeader[]The headers for the specific URL that will be sent with the request.
min_xIntegerRequired if you want to define excluded area.
min_yIntegerRequired if you want to define excluded area.
max_xIntegerRequired if you want to define excluded area.
max_yIntegerRequired if you want to define excluded area.