Tracking deployments

The ideal time to automatically run API and web app tests is immediately after a deployment. Using the Assertible deployments API, you can run tests for a web service as part of your continuous-integration or delivery pipeline and track deployments to specific versions of your application.

If the code for your web service is hosted on GitHub, you can also create status checks and deployment events for commits and pull requests.

Check out our GitHub integration

The easiest way to create a deployment is to run a simple curl command from your continuous integration pipeline or deployment process:

curl -u $ASSERTIBLE_API_TOKEN: -XPOST https://assertible.com/deployments -d'{
    "service" : "'"${ASSERTIBLE_SERVICE_ID}"'",
    "environment" : "production",
    "version" : "v1"
}'

See the examples for more examples.

GitHub

When you post a deployment to Assertible, it's possible to propogate the test statuses and deployment details to GitHub pull requests (and other refs & branches like master).

For example, in the picture above, a deployment is created on assertible-staging with a direct link to the staging environment URL using the View deployment button, as well as the status of tests directly in the pull request checks under CircleCI.

Connect your web service to GitHub:

All you need to do to start creating GitHub deployments and status checks is to connect your web service to GitHub and use the github: true parameter in the call to POST /deployments.

When the github: true parameter is used, Assertible posts deployment statuses and test results to the GitHub API for the ref you provide in the deployment script after executing your tests. The ref must be the full SHA1 hash of the commit (don't use the short hash).

Continuous integration services usually populate the environment with a variable containing the commit. For example, CircleCI uses CIRCLE_SHA1. We recommend using the equivalent of $ git rev-parse HEAD.

• Deployments API parameters
• GitHub integration documentation

External GitHub deployment integrations

If you are deploying code using a continuous delivery service like Heroku Pipelines or Heroku Review Apps, deployment events are already posted to the repository for you automatically. See our blog Automate smoke tests for a Go API on Heroku for a more detailed example.

Deployments API examples

Successful request

If the request succeeds, it will respond with the unique id of the deployment:

curl -XPOST -u $ASSERTIBLE_API_TOKEN: https://assertible.com/deployments -d'{
    "service" : "123e4567-e89b-12d3-a456-426655440000",
    "environment" : "production",
    "version" : "v1.2"
}'

{
    "id":"caacafdc-8ddc-4245-a0f4-f6715c5d9478",
    "runId": "abcd1234",
    "testRun": {
      "status": "TestRunPending"
    }
}

Failed request

If creating the deployment fails, an error will be returned:

curl -XPOST -u $ASSERTIBLE_API_TOKEN: https://assertible.com/deployments -d'{
    "service" : "123e4567-e89b-12d3-a456-426655440000",
    "environment" : "staging",
    "version" : "v1.2"
}'

{"code":"InvalidRequestError","message":"Cannot parse request body\n\"Error in $: key \\\"service\\\" not present\"\n"}

GitHub deployment

If the request succeeds, it will respond with an empty JSON object:

SHA=$(git rev-parse HEAD)
curl -XPOST -u $ASSERTIBLE_API_TOKEN: https://assertible.com/deployments -d'{
    "service" : "123e4567-e89b-12d3-a456-426655440000",
    "environment" : "production",
    "version" : "v1",
    "ref" : "'"${SHA}"'",
    "github" : true
}'

{
    "id": ...,
    "runId": null,
    "testRun": null
}

Parameters

These parameters can be used in a request to POST /deployments: