Bumping WireMock to 2.1.7 (#27)
* Bumping WireMock to 2.1.7 * Added samples to the project * Updated docs fixes #26, #7
This commit is contained in:
committed by
GitHub
parent
1bed00ccf9
commit
ebf8dd4b67
@@ -24,3 +24,5 @@ You can read more about Spring Cloud Contract Verifier by reading the {documenta
|
||||
== Contributing
|
||||
|
||||
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]
|
||||
|
||||
include::building.adoc[]
|
||||
62
docs/src/main/asciidoc/building.adoc
Normal file
62
docs/src/main/asciidoc/building.adoc
Normal file
@@ -0,0 +1,62 @@
|
||||
== How to build it
|
||||
|
||||
=== Project structure
|
||||
|
||||
Here you can find the Spring Cloud Contract folder structure
|
||||
|
||||
```
|
||||
├── samples
|
||||
├── scripts
|
||||
├── spring-cloud-contract-spec
|
||||
├── spring-cloud-contract-stub-runner
|
||||
├── spring-cloud-contract-verifier
|
||||
├── spring-cloud-contract-verifier-gradle-plugin
|
||||
├── spring-cloud-contract-verifier-maven-plugin
|
||||
└── spring-cloud-contract-verifier-standalone-test-samples
|
||||
```
|
||||
|
||||
- `samples` - folder contains integration test samples used also to build documentation
|
||||
- `scripts` - contains scripts to build and test `Spring Cloud Contract` with Maven, Gradle and standalone projects
|
||||
- `spring-cloud-contract-spec` - contains specification modules (contains concept of a Contract)
|
||||
- `spring-cloud-contract-stub-runner` - contains Stub Runner related modules
|
||||
- `spring-cloud-contract-verifier` - core of the `Spring Cloud Contract Verifier` functionality
|
||||
- `spring-cloud-contract-verifier-gradle-plugin` - Gradle plugin for `Spring Cloud Contract Verifier`
|
||||
- `spring-cloud-contract-verifier-maven-plugin` - Maven plugin for `Spring Cloud Contract Verifier`
|
||||
- `spring-cloud-contract-verifier-standalone-test-samples` - standalone test sample that use `Spring Cloud Contract Verifier`
|
||||
|
||||
=== Commands
|
||||
|
||||
To build the core functionality together with Maven Plugin you can run
|
||||
|
||||
```
|
||||
./mvnw clean install
|
||||
```
|
||||
|
||||
To build the Gradle Plugin
|
||||
|
||||
```
|
||||
cd spring-cloud-contract-verifier-gradle-plugin
|
||||
./gradlew clean build
|
||||
```
|
||||
|
||||
=== Scripts
|
||||
|
||||
For your convenience we have created a bunch of scripts to build and test the whole functionality.
|
||||
|
||||
Build both Maven and Gradle project
|
||||
|
||||
```
|
||||
./scripts/build.sh
|
||||
```
|
||||
|
||||
Run tests on the standalone projects
|
||||
|
||||
```
|
||||
./scripts/runTests.sh
|
||||
```
|
||||
|
||||
Build both Maven and Gradle projects and run tests on standalone projects
|
||||
|
||||
```
|
||||
./scripts/buildAndTest.sh
|
||||
```
|
||||
@@ -190,7 +190,7 @@ The output message can be triggered by calling a method (e.g. a Scheduler was st
|
||||
|
||||
[source,groovy]
|
||||
----
|
||||
include::../../../../samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy[tags=method_trigger,indent=0]
|
||||
include::../../../../samples/samples-messaging-integration/src/test/groovy/com/example/IntegrationMessagingApplicationSpec.groovy[tags=method_trigger,indent=0]
|
||||
----
|
||||
|
||||
In this case the output message will be sent to `output` if a method called `bookReturnedTriggered` will be executed. In the message *publisher's* side
|
||||
@@ -202,7 +202,7 @@ The output message can be triggered by receiving a message.
|
||||
|
||||
[source,groovy]
|
||||
----
|
||||
include::../../../../samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy[tags=message_trigger,indent=0]
|
||||
include::../../../../samples/samples-messaging-integration/src/test/groovy/com/example/IntegrationMessagingApplicationSpec.groovy[tags=message_trigger,indent=0]
|
||||
----
|
||||
|
||||
In this case the output message will be sent to `output` if a proper message will be received on the `input` destination. In the message *publisher's* side
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
:images_url: https://raw.githubusercontent.com/Codearte/accurest/master/docs/src/main/asciidoc/images
|
||||
:images_url: https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/master/docs/src/main/asciidoc/images
|
||||
|
||||
== Introduction
|
||||
|
||||
@@ -132,7 +132,8 @@ video::130779882[vimeo]
|
||||
|
||||
=== Samples
|
||||
|
||||
Here you can find some https://github.com/Codearte/accurest-samples[working samples]. Check the readme of each project for more information.
|
||||
Here you can find some https://github.com/spring-cloud/spring-cloud-contract[working samples]. Check the `spring-cloud-contract-verifier-standalone-test-samples` folder
|
||||
and read readme of each project for more information.
|
||||
|
||||
=== Why use Spring Cloud Contract Verifier and not X ?
|
||||
|
||||
|
||||
Reference in New Issue
Block a user