Visual tests

POST Parameters

NameTypeDescription
name
Required
StringThe name 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.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "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
}
]
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id": 2,
"name": "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
}
],
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "test server",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}

Defining excluded areas

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.