SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move plugins in to tools folder

Browse Source 
Also rename plugins removing 'verifer'.
This commit is contained in:
Dave Syer
2016-07-14 21:55:02 +01:00
parent 66bc04a6da
commit 15dc75dece
204 changed files with 103 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/main/asciidoc/building.adoc
View File

@@ -10,8 +10,8 @@ Here you can find the Spring Cloud Contract folder structure
├── 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-gradle-plugin
├── spring-cloud-contract-maven-plugin
└── spring-cloud-contract-verifier-standalone-test-samples
```
@@ -20,8 +20,8 @@ Here you can find the Spring Cloud Contract folder structure
- `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-gradle-plugin` - Gradle plugin for `Spring Cloud Contract Verifier`
- `spring-cloud-contract-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
@@ -35,7 +35,7 @@ To build the core functionality together with Maven Plugin you can run
To build the Gradle Plugin
```
cd spring-cloud-contract-verifier-gradle-plugin
cd spring-cloud-contract-gradle-plugin
./gradlew clean build
```

4
docs/src/main/asciidoc/contract.adoc
View File

@@ -24,7 +24,7 @@ include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract
Not all features of the DSL are used in example above. If you didn't find what you are looking for, please check next paragraphs on this page.
> You can easily compile Contracts to WireMock stubs mapping using standalone maven command: `mvn org.springframework.cloud:spring-cloud-contract-verifier-maven-plugin:convert`.
> You can easily compile Contracts to WireMock stubs mapping using standalone maven command: `mvn org.springframework.cloud:spring-cloud-contract-maven-plugin:convert`.
=== Limitations
@@ -158,7 +158,7 @@ include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract
[source,groovy,indent=0]
----
include::{core_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0]
include::{core_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0]
----
=== JAX-RS support

2
docs/src/main/asciidoc/messaging.adoc
View File

@@ -142,7 +142,7 @@ Example of Spring Cloud Contract Verifier Gradle setup:
[source,groovy,indent=0]
----
include::{core_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0]
include::{core_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0]
----
==== Maven Setup

18
docs/src/main/asciidoc/rest.adoc
View File

@@ -19,7 +19,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath 'org.springframework.cloud:spring-cloud-contract-verifier-gradle-plugin:${verifier_version}'
classpath 'org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifier_version}'
}
}
@@ -52,7 +52,7 @@ repositories {
----
<plugin>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-contract-verifier-maven-plugin</artifactId>
<artifactId>spring-cloud-contract-maven-plugin</artifactId>
<executions>
<execution>
<goals>
@@ -66,7 +66,7 @@ repositories {
----
Read more: https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-verifier-maven-plugin/[spring-cloud-contract-verifier-maven-plugin]
Read more: https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-maven-plugin/[spring-cloud-contract-maven-plugin]
===== Add stubs
@@ -166,7 +166,7 @@ When using Spring Cloud Contract Verifier in default MockMvc you need to create
[source,groovy,indent=0]
----
include::{core_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0]
include::{core_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0]
----
In case of using `Explicit` mode, you can use base class to initialize the whole tested app similarly as in regular integration tests. In case of `JAXRSCLIENT` mode this base class
@@ -230,7 +230,7 @@ Underneath LoanApplication makes a call to FraudDetection service. This request
----
<plugin>
<groupId>org.springframework.cloud.verifier</groupId>
<artifactId>spring-cloud-contract-verifier-maven-plugin</artifactId>
<artifactId>spring-cloud-contract-maven-plugin</artifactId>
<executions>
<execution>
<goals>
@@ -243,7 +243,7 @@ Underneath LoanApplication makes a call to FraudDetection service. This request
</plugin>
----
Read more: https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-verifier-maven-plugin/[spring-cloud-contract-verifier-maven-plugin]
Read more: https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-maven-plugin/[spring-cloud-contract-maven-plugin]
==== Add stubs
@@ -274,7 +274,7 @@ To change default configuration just add `configuration` section to plugin defin
----
<plugin>
<groupId>org.springframework.cloud.verifier</groupId>
<artifactId>spring-cloud-contract-verifier-maven-plugin</artifactId>
<artifactId>spring-cloud-contract-maven-plugin</artifactId>
<executions>
<execution>
<goals>
@@ -300,7 +300,7 @@ To change default configuration just add `configuration` section to plugin defin
- **contractsDir** - directory containing contracts written using the GroovyDSL. By default `/src/test/resources/contracts`.
- **testFramework** - the target test framework to be used; currently Spock and JUnit are supported with Spock being the default framework
For complete information take a look at https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-verifier-maven-plugin/plugin-info.html[Plugin Documentation]
For complete information take a look at https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-maven-plugin/plugin-info.html[Plugin Documentation]
===== Base class for tests
@@ -373,7 +373,7 @@ Sample configuration:
----
<plugin>
<groupId>org.springframework.cloud.verifier</groupId>
<artifactId>spring-cloud-contract-verifier-maven-plugin</artifactId>
<artifactId>spring-cloud-contract-maven-plugin</artifactId>
<version>${verifier-plugin.version}</version>
<executions>
<execution>

2
docs/src/main/asciidoc/stubrunner.adoc
View File

@@ -32,7 +32,7 @@ Example of Spring Cloud Contract Verifier Gradle setup:
[source,groovy,indent=0]
----
include::{core_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0]
include::{core_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0]
----
==== Maven