REST API end-point to trigger test execution externally – ACCELQ

You can execute a test job on accelQ from external entry points, such as your custom CI workflow or any other build orchestration flow. Here is the relevant API.

Executing a job using REST API

PUT Trigger a Job
End Point URL	https://{accelQ server}/awb/api/{tenant code}/{project code}/v1/api_access/jobs/trigger-job tenant code and project code can be retrieved from "AUTH PROPERTIES" section in User's Profile card on accelQ.
Request Headers	user_id // a valid user id on accelQ subscription api_key // from the user's profile, corresponding to the user_id Content-Type: application/json
Request Payload	{ "jobPid": "{CI Template Job ID from accelQ}", "runProperties": // optional, only if relevant for the Job { "prop1": "val1", "prop2": "val2" } }
Info from Response Payload	Array of Runtime Job PIDs that got kicked off.

Splitting a job execution against multiple agent machines

If you need to split a given Job on multiple agents, specify the list of agents in the Request payload. Example below:

{
    "jobPid": "{job ID from accelQ}",
    "runProperties":     // optional, only if relevant for the Job
    {
        "prop1": "val1",
        "prop2": "val2"
    }

    "agentNameList": ["agent1", "agent2"]    
       // only if you need to split the job against multiple agents
}

Note: In this case, multiple jobs are spawned, one each on every agent. Response for this API will include a list of Job PIDs that got created.

Running tests from command line

You can execute this same API from command line using CURL. An example below:

Command Template

curl -d @<payload file> -H "Content-Type: application/json" -H "api_key: {api key}" -H "user_id: {user id}" -X PUT {base url}/awb/api/{tenant}/{project}/v1/api_access/jobs/trigger-job

Note: Payload and header values as described in the API description section. Request payload should be stored in a file. Pass the file name as command line argument.

Example

curl -d @request.json -H "Content-Type: application/json" -H "api_key: c7eed27p6d3x52d67c9a791289d98563" -H "user_id: user@company.com" -X PUT https://company.accelq.io/awb/api/companytenant/TestProject/v1/api_access/jobs/trigger-job

Once the job is kicked off, you can monitor progress and run summary via external API. More details here.

Comments

1 comment

Syamkishore Rapaka

May 03, 2021 09:40
We wish to have selection of Values like: App Env, Browser, Execution Parameters to be included in the ReST end point while giving a CI job

For example:

{
"jobPid": "{job ID from accelQ}",
"runProperties": // optional, only if relevant for the Job
{
"prop1": "val1",
"prop2": "val2"
}
"execution Parameters" :
{
"Release Version": "3.4",
"Sprint": "2"
}

"App env": "QA"

}

Basically the values from the ReST end point should override the values given in the CI Job in accelq.
0

Please sign in to leave a comment.

Executing a job using REST API

Splitting a job execution against multiple agent machines

Running tests from command line

Related articles