Challenge Overview
For this challenge, we'd like to create a general and flexible API Testing Framework For Challenge Service, which can be used to do regression testing before each release.
Basically, the API Testing Framework will do the similar things as postman script, but in an automatical way.
General Requirements
- This is a separate project, should be a Maven Project.
- You are suggested to use rest-assured, but if you prefer other choices, please raise in the forum for confirmation.
- It will send out the API requests similar as postman scripts, and verify the response and possibly check against the database.
- For each testing, it should probably setup and teardown the environment properly.
- The environment specific configuration should be configurable and override through environment variables, for example, base API path, like http://localhost:8080/, authentication tokens, and database settings etc
- For this challenge, you are expected to take the responsibility to convert create-draft-challenge.postman_collection to API Tests for proving purpose.
- The API Testing Framework should be able to add new tests easily, and easily run different sets of tests (different APIs) without the need to run all, this will be useful for future development.
- Please create README.md for general usage of the API Testing Framework and How to add new tests for new APIs.
About Local Setup
1. Please following https://github.com/appirio-tech/tc-common-tutorials/tree/master/docker/direct-app to setup the local environment, run `docker-compose up tc-direct-with-volume run-online-review all-challenges-es-feeder`
2. Update the local/run.sh to run the challenge service
- README.md file to setup and verification
Basically, the API Testing Framework will do the similar things as postman script, but in an automatical way.
General Requirements
- This is a separate project, should be a Maven Project.
- You are suggested to use rest-assured, but if you prefer other choices, please raise in the forum for confirmation.
- It will send out the API requests similar as postman scripts, and verify the response and possibly check against the database.
- For each testing, it should probably setup and teardown the environment properly.
- The environment specific configuration should be configurable and override through environment variables, for example, base API path, like http://localhost:8080/, authentication tokens, and database settings etc
- For this challenge, you are expected to take the responsibility to convert create-draft-challenge.postman_collection to API Tests for proving purpose.
- The API Testing Framework should be able to add new tests easily, and easily run different sets of tests (different APIs) without the need to run all, this will be useful for future development.
- Please create README.md for general usage of the API Testing Framework and How to add new tests for new APIs.
About Local Setup
1. Please following https://github.com/appirio-tech/tc-common-tutorials/tree/master/docker/direct-app to setup the local environment, run `docker-compose up tc-direct-with-volume run-online-review all-challenges-es-feeder`
2. Update the local/run.sh to run the challenge service
Final Submission Guidelines
- The new API Testing Framework- README.md file to setup and verification