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.
urls
Required
String[]URLs of the sites that should be tested.
excluded_areasExcludedArea[]Defines the area to be excluded during the tests.

YAML example for Visual tests

actions:
- action: "Visual Tests"
type: "VISUAL_TESTS"
browser_type: "CHROME"
resolution_width: 1920
resolution_height: 1080
pixel_tolerance_level: 1.23
images_history_limit: 30
urls:
- "https://buddy.works/"
excluded_areas:
- url: "https://buddy.works/"
min_x: 100
min_y: 50
max_x: 500
max_y: 200

YAML parameters for excluded areas

NameTypeDescription
urlStringRequired if you want to define excluded area. The URL of the site on which you want to exclude the area.
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.