Cloud Runner Test Generation REST API

Manages test job generation to be executed in a cloud runner for Automated Test Framework (ATF).

The Cloud Runner Test Generation API requires the ATF Test Generator and Cloud Runner (sn_atf_tg) plugin. The methods available with this API run in the now namespace and can be called using API Name, One-click regression testing for ATF, in the REST API Explorer. The admin role is required to access this API.

You can use this API for the following tasks:

• Start the test generation job.
• Check the progress of the test generation job.
• Cancel the test generation job.

The Cloud Runner Test Generation API may be used in tandem with the Cloud Runner Test Runner REST API and Cloud Runner Test User REST API. For instance, you can call the Test Generation API to run a test and then get the progress of the test in the browser orchestration queue (Cloud Runner TEST Generation API) and then check the number of tests that passed or failed.

To view the Server API reference documentation of this API, see Cloud Runner TestGenerationApi – Scoped, Global.

Parent Topic:REST API reference

Cloud Runner Test Generation - GET /now/sn_atf_tg/test_generation_progress

Provides the status of each generated test for a provided Browser Orchestration Queue (BOQ) record.

URL format

Default URL: GET /api/now/sn_atf_tg/test_generation_progress

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

"result": { 
    "testsSucceeded": Number, 
    "testsFailed": Number, 
    "testsPending": Number, 
    "testsInProgress": Number, 
    "testsSkipped": Number 
  } 
}

{
  "result": { 
    "message": "String" 
  } 
}

cURL request

The following GET call returns progress information about generated tests associated with the snboqId 1234.

curl "https://instance.service-now.com/api/now/sn_atf_tg/test_generation_progress?snboqId=1234" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username":"password"

Output:

{ 
  "result": { 
    "testsSucceeded": 0, 
    "testsFailed": 0, 
    "testsPending": 0, 
    "testsInProgress": 0, 
    "testsSkipped": 161 
  } 
}

The following example returns a 400 error message when no BOQ ID is passed.

curl "http://instance.service-now.com/api/now/sn_atf_tg/test_generation_progress" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Response:

{
  "result": {
    "message": "No SNBOQ ID passed in, add snboqId to request body"
  }
}

The following example returns a 400 error message when an invalid BOQ ID is passed.

curl "http://instance.service-now.com/api/now/sn_atf_tg/test_generation_progress?snboqId=invalid_sys_id" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Response:

{
  "result": {
    "message": "Invalid SNBOQ sys_id passed in"
  }
}

Cloud Runner Test Generation - POST /now/sn_atf_tg/cancel_test_generation

Sets the test generation job and its associated update set record to complete status. If any test jobs are in progress on cancellation, this method sets any of the in-progress test records generated to skipped.

Tests can fail or cancel automatically due to business rules or access control rule (ACL) issues. View the generated test table for more details about failed or canceled tests.

URL format

Default URL: POST /api/now/sn_atf_tg/cancel_test_generation

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

"result": { 
    "message": "String"
}

cURL request

The following request cancels the test generation job of a specified BOQ record.

curl "http://instance.service-now.com/api/now/sn_atf_tg/cancel_test_generation" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"snboqId\":\"<sys_id of BOQ record>\"}" \ 
--user "username":"password"

The response body returns a success message of the cancellation.

{ 
  "result": { 
    "message": "success" 
  } 
}

The following example returns a 400 error message when no BOQ ID is passed.

curl "http://instance.service-now.com/api/now/sn_atf_tg/cancel_test_generation" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

Response:

{
  "result": {
    "message": "No SNBOQ ID passed in, add snboqId to request body"
  }
}

The following example returns a 400 error message when an invalid BOQ ID is passed.

curl "http://instance.service-now.com/api/now/sn_atf_tg/cancel_test_generation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"snboqId\":\"invalid_sys_id\"}" \
--user "username":"password"

Response:

{
  "result": {
    "message": "No SNBOQ ID passed in, add snboqId to request body"
  }
}

Cloud Runner Test Generation - POST /now/sn_atf_tg/test_generation

Inserts a record into the Browser Orchestration Queue (BOQ) [sn_atf_tg_sn_boq] table to start a test job.

URL format

Default URL: POST /api/now/sn_atf_tg/test_generation

Supported request parameters

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters (JSON or XML)

  "result": { 
    "snboqId": String
  }

cURL request

The following request example starts a new test job in the instance without any request parameters and inserts the job in the BOQ table.

curl "http://instance.service-now.com/api/now/sn_atf_tg/test_generation" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user "username":"password"

Response body:

{ 
  "result": { 
    "snboqId": <sys_id of newly inserted BOQ record> 
  } 
}

The following request example starts a new test job with a maximum test count of 2 and filters the tests to the Incident table, and then inserts the job in the BOQ table.

curl "http://instance.service-now.com/api/now/sn_atf_tg/test_generation" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"maxTestCount\":\"2\",\"tableEncodedQuery\":\"name=incident\",\"testSuite\":\"Suite123\"}" \ 
--user "username":"password"

Response body:

{ 
  "result": { 
    "snboqId": <sys_id of newly inserted BOQ record> 
  } 
}