CI/CD API

With the CI/CD API you can easily integrate ATS into your automated deployment workflow. You can run a test according to predefined templates or you can retrieve the status of already finished tests. To use the CI/CD API you will need a special webservice user, which will be used for authentication. For more informations on how to integrate ATS into your CI/CD workflow read the How-To ATS CI/CD.

CI/CD Templates

CI/CDTemplates are predefined configurations for a remote job run, which can be triggered via the run job webservice. Every CI/CD Template consists of the job configuration, an associated Testcase or Testsuite and a generated unique ID. This ID identifies the CI/CD template. An overview of all existing CI/CD Templates can be found on the CI/CD Templates tab on the Test Runs page.

New CI/CD Templates can be added by clicking Add Testcase or Add Testsuite. A dialog will open, where the Testcase or Testsuite for the CI/CD Template can be selected. After that, the Edit CI/CD Template dialog will open.

Following options can be configured on the Edit CI/CD Template dialog:

For supported selenium hubs, like Browserstack, further options are available. More informations on supported selenium hub provider can be found here.

API

The ATS CI/CD API is based on the SOAP webservice protocol. Currently there are two services available, Run Job and Get Job Status. The following sections shows the structures of the request and response messages of these services.

Run Job

URL

https://ats100.mendixcloud.com/ws/RunJob

Request

Following informations have to be included into the request.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:men="http://www.mendix.com/">
  <soap:Header>
    <tns:authentication>
      <username>exampleUser</username>
      <password>examplePassword</password>
    </tns:authentication>
  </soap:Header>
  <soap:Body>
    <tns:RunJob>
      <TestRun>
        <AppAPIToken>exampleString</AppAPIToken>
        <AppID>exampleString</AppID>
        <JobTemplateID>exampleString</JobTemplateID>
      </TestRun>
    </tns:RunJob>
  </soap:Body>
</soapenv:Envelope>

Response

The following table shows the data contained in the response of the Run Job service:

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:men="http://www.mendix.com/">
  <soap:Body>
    <tns:RunJobResponse>
      <RunJob>
        <Started>false</Started>
        <ErrorMessage>exampleString</ErrorMessage>
        <JobID>exampleString</JobID>
      </RunJob>
    </tns:RunJobResponse>
  </soap:Body>
</soapenv:Envelope>

Get Job Status

URL

https://ats100-test.mendixcloud.com/ws/GetJobStatus

Request

Following informations have to be included into the request.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:men="http://www.mendix.com/">
  <soap:Header>
    <tns:authentication>
      <username>exampleUser</username>
      <password>examplePassword</password>
    </tns:authentication>
  </soap:Header>
  <soap:Body>
    <tns:GetTestRun>
      <TestRun>
        <AppAPIToken>exampleString</AppAPIToken>
        <JobID>exampleString</JobID>
        <AppID>exampleString</AppID>
      </TestRun>
    </tns:GetTestRun>
  </soap:Body>
</soapenv:Envelope>

Response

The following table shows the data contained in the response of the Get Job Status service:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:men="http://www.mendix.com/">
  <soap:Body>
    <tns:GetTestRunResponse>
      <TestRun>
        <ExecutionStatus>[key]</ExecutionStatus>
        <ExecutionResult>[key]</ExecutionResult>
        <ErrorMessage>exampleString</ErrorMessage>
      </TestRun>
    </tns:GetTestRunResponse>
  </soap:Body>
</soapenv:Envelope>