Visual tests with YAML

List of YAML parameters and examples for the "Visual tests" action

YAML Parameters for Visual tests

信息

Buddy操作通用参数列表

名称	类型	描述
action 必填	String	The ID of the action.
type 必填	String	The type of the action. Should be set to VISUAL_TESTS.
browser_type 必填	String	Defines which browser will be used in tests. Can be one of CHROME or FIREFOX.
resolution_width 必填	Integer	Resolution width.
resolution_height 必填	Integer	Resolution height.
pixel_tolerance_level 必填	Float	The acceptable level of pixel tolerance. Allowed number of decimal places is two.
images_history_limit 必填	Integer	The number of items that should be kept in history.
screenshots 必填	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.

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: 200

YAML parameters for screenshots

信息

Buddy操作通用参数列表

名称	类型	描述
url 必填	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.