https://github.com/pactflow/example-provider-springboot
Spring boot example provider
https://github.com/pactflow/example-provider-springboot
example
Last synced: 9 months ago
JSON representation
Spring boot example provider
- Host: GitHub
- URL: https://github.com/pactflow/example-provider-springboot
- Owner: pactflow
- License: mit
- Created: 2020-06-03T07:24:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-09T05:08:17.000Z (10 months ago)
- Last Synced: 2025-04-15T06:48:20.287Z (9 months ago)
- Topics: example
- Language: Java
- Size: 271 KB
- Stars: 7
- Watchers: 10
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Example Java Spring Boot Provider
[](https://github.com/pactflow/example-provider-springboot/actions/workflows/build.yml)
This is an example of a Java Spring Boot provider that uses Pact, [PactFlow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it.
The project uses a Makefile to simulate a very simple build pipeline with two stages - test and deploy.
It is using a public tenant on PactFlow, which you can access [here](https://testdemo.pactflow.io) using the credentials `dXfltyFMgNOFZAxr8io9wJ37iUpY42M`/`O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1`.
## Project Phases
The project uses a Makefile to simulate a very simple build pipeline with two stages - test and deploy.
- Test
- Run tests (including the pact tests that generate the contract)
- Publish pacts, tagging the consumer version with the name of the current branch
- Check if we are safe to deploy to prod (ie. has the pact content been successfully verified)
- Deploy (only from master)
- Deploy app (just pretend for the purposes of this example!)
- Tag the deployed consumer version as 'prod'
## Dependencies
- Docker
- A [PactFlow](https://pactflow.io) account
- A [read/write API Token](https://docs.pactflow.io/#configuring-your-api-token) from your PactFlow account
- Java 8+ installed
## Usage
See the [PactFlow CI/CD Workshop](https://github.com/pactflow/ci-cd-workshop).
>_Note:_ This repository is designed, out the box to work with the [`example-consumer-java-junit`](https://github.com/pactflow/example-consumer-java-junit) project, which specifies the provider it depends on, as the one named in this repository (`pactflow-example-provider-springboot`). If you are using another consumer example such as the [`pactflow-example-consumer`](https://github.com/pactflow/example-consumer) repo, you should do one of the following in your consumer project, either override the environment variable `PACT_PROVIDER=pactflow-example-provider-springboot` or update [the test](https://github.com/pactflow/example-consumer/blob/master/src/api.pact.spec.js#L9) to specify the correct provider name.
The below commands are designed for a Linux/OSX environment, please translate for use on Windows/PowerShell as necessary:
Please ensure the following environment variables have been exported in the process that you run the tests (generally a terminal):
```
export PACT_BROKER_TOKEN=
export PACT_BROKER_BASE_URL=https://.pactflow.io
export PACT_BROKER_HOST=.pactflow.io
```
You can run the tests locally with:
```
make test
```
### Simulating CI
Usually, you would integrate this into a real CI system (such as Buildkite/Jenkins/CircleCI etc., or GitHub Actions as this repository is built against).
You can simulate a CI process with the following command:
```
make fake_ci
```