Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srinivasantarget/contracttestingboilerplate
Contract Testing Boilerplate for the microservices developed using Spring Boot and Kafka in a maven multi-module project.
https://github.com/srinivasantarget/contracttestingboilerplate
age-consumer-microservice cloud consumer-driven-contracts contract-testing kafka maven-multi microservices microservices-testing pact pact-broker pact-broker-postgres pact-jvm pactbroker provider-microservice spring spring-boot spring-cloud-contract swagger-validator testing-tools wiremock-pact-generator
Last synced: 2 months ago
JSON representation
Contract Testing Boilerplate for the microservices developed using Spring Boot and Kafka in a maven multi-module project.
- Host: GitHub
- URL: https://github.com/srinivasantarget/contracttestingboilerplate
- Owner: SrinivasanTarget
- Created: 2020-04-11T14:14:31.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-14T23:57:00.000Z (almost 2 years ago)
- Last Synced: 2024-11-02T03:22:48.864Z (3 months ago)
- Topics: age-consumer-microservice, cloud, consumer-driven-contracts, contract-testing, kafka, maven-multi, microservices, microservices-testing, pact, pact-broker, pact-broker-postgres, pact-jvm, pactbroker, provider-microservice, spring, spring-boot, spring-cloud-contract, swagger-validator, testing-tools, wiremock-pact-generator
- Language: Java
- Homepage:
- Size: 254 KB
- Stars: 37
- Watchers: 6
- Forks: 26
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contract Testing Boilerplate
Contract Testing Boilerplate has two microservices developed using Spring Boot in a maven multi-module project.
## What is Contract Testing?
An integration contract test is a test at the boundary of an external service verifying that it meets the contract expected by a consuming service.
- Date Provider MicroService - /provider/validDate - Validates whether given date is a valid date or not
- Age Consumer MicroService - /age-calculate - Returns age of a person based on given date
Start Date Provider MicroService by default runs in port 8080:
```shell script
mvn spring-boot:run -pl date-provider
```
Start Age Consumer MicroService by default runs in port 8081:
```shell script
mvn spring-boot:run -pl age-consumer
```
## Pact Tests
Click to expand!
Pact is a contract testing tool. Contract testing is a way to ensure that services (such as an API provider and a client) can communicate with each other. Without contract testing, the only way to know that services can communicate is by using expensive and brittle integration tests.
### Run Consumer contract Tests
```shell script
mvn clean test -pl age-consumer
```
Generated Pact file:
```json
{
"provider": {
"name": "dateProvider"
},
"consumer": {
"name": "ageConsumer"
},
"interactions": [
{
"description": "valid date from provider",
"request": {
"method": "GET",
"path": "/provider/validDate",
"query": {
"date": [
"2001-02-03"
]
},
"matchingRules": {
"query": {
"date": {
"matchers": [
{
"match": "date",
"date": "2001-02-03"
}
],
"combine": "AND"
}
}
},
"generators": {
"body": {
"date": {
"type": "Date",
"format": "2001-02-03"
}
}
}
},
"response": {
"status": 200,
"headers": {
"content-type": "application/json",
"Content-Type": "application/json; charset=UTF-8"
},
"body": {
"month": 8,
"year": 2000,
"isValidDate": true,
"day": 3
},
"matchingRules": {
"body": {
"$.year": {
"matchers": [
{
"match": "number"
}
],
"combine": "AND"
},
"$.month": {
"matchers": [
{
"match": "number"
}
],
"combine": "AND"
},
"$.day": {
"matchers": [
{
"match": "number"
}
],
"combine": "AND"
},
"$.isValidDate": {
"matchers": [
{
"match": "type"
}
],
"combine": "AND"
}
},
"header": {
"Content-Type": {
"matchers": [
{
"match": "regex",
"regex": "application/json(;\\s?charset=[\\w\\-]+)?"
}
],
"combine": "AND"
}
}
}
},
"providerStates": [
{
"name": ""
}
]
}
],
"metadata": {
"pactSpecification": {
"version": "3.0.0"
},
"pact-jvm": {
"version": "4.0.9"
}
}
}
```
### Start Pact Broker at default port `:8282`
```dockerfile
docker-compose up -d
```
### Publish Pact Files in Pact Broker
```shell script
$ cd age-consumer
$ mvn pact:publish
```
### Verify Pacts in Pact Broker at Provider side
```shell script
mvn clean -Dtest=PactAgeProviderTest test -pl date-provider
```
## Spring Cloud Contract Tests
Click to expand!
Spring Cloud Contract is an umbrella project holds solutions to help users implement contract tests. It has two main modules:
* Spring Cloud Contract Verifier, which is used mainly by the producer side.
* Spring Cloud Contract Stub Runner, which is used by the consumer side.
## Blogs
* [Consumer Driven Contract Testing [Webinar Recording]](https://blog.testproject.io/2020/06/15/consumer-driven-contract-testing-the-ultimate-guide-to-testing-microservices/)
* [Introduction to consumer-driven contracts](https://blog.testproject.io/2020/04/27/introduction-to-consumer-contract-testing/)
* [Consumer-Driven Contract Testing using Pact Java](https://blog.testproject.io/2020/05/27/consumer-driven-contract-testing-using-pact-java/)
* [Consumer-Driven Contract Testing using Spring Cloud Contracts](https://blog.testproject.io/2020/05/20/consumer-driven-contract-testing-using-spring-cloud-contract/)
* [Event-Driven Architecture: How to Perform Contract Testing in Kafka/pubSub](https://blog.testproject.io/2020/06/03/event-driven-architecture-how-to-perform-contract-testing-in-kafka-pubsub/)
* [Integrating Contract Testing in Build Pipelines](https://blog.testproject.io/2020/06/09/integrating-consumer-contract-testing-in-build-pipelines/)