Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add example documentation #9

Merged
merged 1 commit into from
Feb 9, 2023
Merged

docs: add example documentation #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ therefore the architectural concepts are not consistently followed.
##### REST Clients

* [Feign - Declarative REST Client](https://cloud.spring.io/spring-cloud-netflix/multi/multi_spring-cloud-feign.html)
* used to implement a REST client
* [Example](https://github.com/step-beyond/spring-boot-examples/blob/main/infrastructure-petstore-rest-client/src/main/java/today/stepbeyond/examples/springbootexamples/infrastructure/gateways/api/PetStoreApi.java)

### Testing Tools

Expand All @@ -27,15 +29,22 @@ Unit Tests follow the naming pattern "<TestName>Test".
* [JUnit5](https://junit.org/junit5/docs/current/user-guide/)
* [AssertJ](https://assertj.github.io/doc/)
* used to write fluent assertions
* [Example](https://github.com/step-beyond/spring-boot-examples/blob/main/domain/src/test/java/today/stepbeyond/examples/springbootexamples/usecases/DogUseCasesTest.java#L53-L55)
* [Mockito](https://site.mockito.org/)
* used to mock dependencies to other services
* used to mock dependencies to other services
* [Example](https://github.com/step-beyond/spring-boot-examples/blob/main/domain/src/test/java/today/stepbeyond/examples/springbootexamples/usecases/DogUseCasesTest.java)

#### Integration Tests

Integration Tests follow the naming pattern "<TestName>IT". An integration test scenario is created with tools, which
can be easily integrated into JUnit & SpringBoot.

* [WireMock](https://wiremock.org/)
* used to test outgoing http requests
* used to test outgoing http requests
* [Example](https://github.com/step-beyond/spring-boot-examples/blob/main/infrastructure-petstore-rest-client/src/test/java/today/stepbeyond/examples/springbootexamples/infrastructure/gateways/PetStoreRestClientIT.java)
* [Testcontainers](https://www.testcontainers.org/)
* used to start any type of external services, i.e. databases or message queues.
* used to start any type of external services, i.e. databases or message queues.

#### Conventions

This repository follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)