Description of the project.
All notable changes to this project are documented in CHANGELOG.md. The format is based on Keep a Changelog and adheres to Semantic Versioning.
π Documentation π Getting started π Contributions β¨ Changelog π License
- TODO
- TODO
gauge-requests/
βββ .cirlceci/ # CI Build scripts for project.
βββ build/
β βββ update_versions.sh # Updates project/dependency versions.
β βββ set_stub_mappings.sh
β βββ local.yml # docker-compose file for build full project.
β βββ stub.yml # docker-compose file for stub api.
βββ docs/
βββ quickstart/ # A maven archetype project.
βββ reference/ # An examples project using requests module.
βββ requests/ # Main gauge-requests module.
βββ stub/ # A wiremock stubbed api for testing.
β βββ mappings/ # contains all the stubbed mappings.
βββ checkstyle.xml
βββ pom.xml # parent pom to build the modules.
The project uses a stub api for testing the specifications. Bring up the container using docker-compose
:
docker-compose -f build/stub.yml up -d
The stub api will then be accessible at http://127.0.0.1:8080
The project can be built using any of the standard Maven life-cycles. Jar files can be found in the target
directory of the module.
mvn clean # cleans your current environment.
mvn compile # compiles all modules.
mvn test # compiles all source, runs unit tests for all modules.
mvn verify # same as `mvn test` but will also run integration tests from quickstart module.
To test a specific module of the project:
cd requests # change into the module's directory
mvn clean test
The recommended option to build the complete project is using docker containers:
docker-compose -f build/local.yml up # brings up the stub and gauge containers to build the project.
The docs are written using Hugo and deployed to Github pages from the docs
directory. Run the following to bring up the docs server using docker:
docker-compose -f build/docs.yml up -d
The docs should then be available at http://127.0.0.1:1313
.
Please open an issue here on GitHub if you have a problem, suggestion, or other comments.
Pull requests are welcome and encouraged! Any contributions should include new or updated unit/integration tests as necessary to maintain thorough test coverage.
Read CONTRIBUTING.md for contribution guidelines.
This project follows the Contributor Covenant Code of Conduct.
This work is licensed under a MIT License.