mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
103 lines
2.9 KiB
Markdown
103 lines
2.9 KiB
Markdown
# API Testing CI Environment
|
|
|
|
This guide describes steps necessary for testing an API described in a swagger file with the [Dredd API Testing Framework](https://github.com/apiaryio/dredd) 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:
|
|
|
|
```text
|
|
$ node -v
|
|
v7.5.0
|
|
```
|
|
|
|
2. **Ruby** runtime MUST be available in the CI environment:
|
|
|
|
```text
|
|
$ ruby -v
|
|
ruby 2.4.0p0 (2016-12-24 revision 57164) [x86_64-darwin16]
|
|
```
|
|
|
|
3. [**Dredd**](https://github.com/apiaryio/dredd) MUST be installed globally in the CI environment:
|
|
|
|
```text
|
|
$ npm install -g dredd --no-optional
|
|
```
|
|
|
|
```text
|
|
$ dredd --version
|
|
dredd v2.2.5 (Darwin 16.4.0; x64)
|
|
```
|
|
|
|
4. [**Apiary CLI Tool**](https://help.apiary.io/tools/apiary-cli) MUST be installed globally in the CI environment:
|
|
|
|
```text
|
|
$ gem install apiaryio
|
|
```
|
|
|
|
```text
|
|
$ apiary version
|
|
0.8.0
|
|
```
|
|
|
|
5. **Apiary API Key** MUST be set in the CI Environment environment variables:
|
|
|
|
```text
|
|
$ export APIARY_API_KEY=xyz
|
|
```
|
|
|
|
To obtain an Apiary API key, head to [https://login.apiary.io/tokens](https://login.apiary.io/tokens) \(NOTE: You will need the "ALL" Scope\)
|
|
|
|
## 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. The name \(subdomain\) of API project at Apiary
|
|
|
|
```text
|
|
$ export APIARY_API_NAME=bomapi3
|
|
```
|
|
|
|
> See [How to find the Apiary API name](https://help.apiary.io/faq/find-api-name/) for more details.
|
|
|
|
2. A `swagger.yaml` file with the description of API being tested
|
|
|
|
To fetch the swagger.yaml file from Apiary run the following command before the test:
|
|
|
|
```text
|
|
$ apiary fetch --api-name=$APIARY_API_NAME --output="swagger.yaml"
|
|
```
|
|
|
|
The swagger document for Apiary project `bomapi3` was saved as local file `./swagger.yaml`.
|
|
|
|
> See [Fetching Published Documentation](https://help.apiary.io/tools/apiary-cli/#fetching-published-documentation).
|
|
|
|
3. The host \(address\) of the service being tested
|
|
|
|
```text
|
|
$ export API_HOST=http://deheremap7336.emea.adsint.biz:8004`
|
|
```
|
|
|
|
### Running the Test
|
|
|
|
With all of the above \(`APIARY_API_KEY`, `APIARY_API_NAME`, `API_HOST`, set up and `swagger.yaml` file present in the current directory\), run:
|
|
|
|
```text
|
|
$ dredd swagger.yaml $API_HOST -r apiary
|
|
```
|
|
|
|
> See [Dredd Command-line Interface](https://dredd.readthedocs.io/en/latest/usage-cli/).
|
|
|
|
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:
|
|
|
|
```text
|
|
$ echo $?
|
|
```
|
|
|
|
Everything else but `0` should break the build. The test results will be visible in the CLI \(log\) as well as in Apiary.
|
|
|