api-guidelines/rest-api-guidelines/guides/api-testing-ci-environment.md

API Testing CI Environment

This guide describes steps necessary for testing an API described in a swagger file with the Dredd API Testing Framework in a CI Environment (Jenkins, TeamCity).

Environment Prerequisites

The following must be available in the CI environment before testing:

1. Node.js runtime MUST be available in the CI environment:

    $ node -v
    v7.5.0
   

2. Dredd MUST be installed globally in the CI environment:

    $ npm install -g dredd --no-optional
   

    $ dredd --version
    dredd v2.2.5 (Darwin 16.4.0; x64)
   

Testing an API

Test Run Prerequisites

To test an API within the CI environment provisioned as mentioned in the environment prerequisites, you will need the following:

1. A swagger.yaml file with the description of API being tested

   The file should be fetched from API Design Platform

2. The host (address) of the service being tested

     $ export API_HOST=http://deheremap7336.emea.adsint.biz:8004`
   

Running the Test

Run:

$ dredd swagger.yaml $API_HOST

See Dredd Command-line Interface.

The Dredd will perform the tests and exits usually if the tests have passed. You can check the test result as with any other Unix tools with:

$ echo $?

Everything else but 0 should break the build. The test results will be visible in the CLI (log)