Visual tests
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name 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. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{"name": "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}]}]}
Sample Response
HTTP
Status: 201 CreatedX-Rate-Limit-Limit: 1X-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","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}]}],"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","on": "CLICK","refs": ["refs/heads/master"],"last_execution_status": "SUCCESSFUL","last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"}}
Defining screenshots
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. |