Unresolved directive in <stdin> - include::{root_folder}/src/test/projects/complex-configuration/pom.xml[tags=plugin]
+
+
+
+
+
+
+
+
+
+
+ 
+
+ Sample more complex configuration for Java Project with JUnit tests.
+Unresolved directive in <stdin> - include::{root_folder}/src/test/projects/complex-configuration/pom.xml[tags=plugin]Unresolved directive in <stdin> - include::{root_folder}/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/BaseAccurest.java[]Unresolved directive in <stdin> - include::{root_folder}/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/matchers/CustomMatchers.java[]Unresolved directive in <stdin> - include::{root_folder}/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsNotFraud.groovy[]Sample more complex configuration for Java Project with JUnit tests.
+ <plugin>
+ <groupId>org.springframework.cloud</groupId>
+ <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+ <version>${spring-cloud-verifier-plugin.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>convert</goal>
+ <goal>generateStubs</goal>
+ <goal>generateTests</goal>
+ </goals>
+ <configuration>
+ <contractsDirectory>src/test/accurest</contractsDirectory>
+ <basePackageForTests>com.blogspot.toomuchcoding.frauddetection</basePackageForTests>
+ <testMode>MOCKMVC</testMode>
+ <testFramework>JUNIT</testFramework>
+ <classifier>stubs</classifier>
+ <nameSuffixForTests>Test</nameSuffixForTests>
+ <ruleClassForTests>org.junit.rules.ErrorCollector</ruleClassForTests>
+ <staticImports>
+ <staticImport>com.blogspot.toomuchcoding.frauddetection.matchers.CustomMatchers.*</staticImport>
+ </staticImports>
+ <imports>
+ <import>com.blogspot.toomuchcoding.frauddetection.matchers.CustomMatchers</import>
+ </imports>
+ <ignoredFiles>
+ <ignoredFile>broken**</ignoredFile>
+ </ignoredFiles>
+ <excludedFiles>
+ <param>shouldMarkClientAsFraud.groovy</param>
+ </excludedFiles>
+ </configuration>
+ </execution>
+ </executions>
+ <configuration>
+ <baseClassForTests>com.blogspot.toomuchcoding.frauddetection.BaseAccurest</baseClassForTests>
+ </configuration>
+ </plugin>/**
+ *
+ * Copyright 2013-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.blogspot.toomuchcoding.frauddetection;
+
+import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc;
+
+import org.junit.Before;
+
+public class BaseAccurest {
+
+ @Before
+ public void setup() {
+ RestAssuredMockMvc.standaloneSetup(new FraudDetectionController());
+ }
+
+}/**
+ *
+ * Copyright 2013-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.blogspot.toomuchcoding.frauddetection.matchers;
+
+import org.junit.Assert;
+
+public class CustomMatchers {
+
+ public static void assertThatRejectionReasonIsNull(String rejectionReason) {
+ Assert.assertNull(rejectionReason);
+ }
+
+}/**
+ *
+ * Copyright 2013-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+org.springframework.cloud.contract.spec.Contract.make {
+ request {
+ method 'PUT'
+ url '/fraudcheck'
+ body("""
+ {
+ "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}",
+ "loanAmount":123.123
+ }
+ """
+ )
+ headers {
+ header('Content-Type', 'application/vnd.fraud.v1+json')
+ }
+
+ }
+ response {
+ status 200
+ body(
+ fraudCheckStatus: "OK",
+ rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)')))
+ )
+ headers {
+ header('Content-Type': 'application/vnd.fraud.v1+json')
+ }
+ }
+
+}Full name:
+ +org.springframework.cloud:spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:convert
+ +Description:
+ +This goal allow to generate `stubs-jar` or execute +`spring-cloud-contract-verifier:run` with generated WireMock +mappings.
Attributes:
+ +| Name | + +Type | + +Since | + +Description | +
|---|---|---|---|
| contractsDirectory | + +File | + +- | + +Directory containing Spring Cloud Contract Verifier contracts
+written using the GroovyDSL Default value is: ${basedir}/src/test/resources/contracts. |
+
| destination | + +File | + +- | + +(no description) Default value is: ${basedir}. User property is: stubsDirectory. |
+
| outputDirectory | + +File | + +- | + +Directory where the generated WireMock stubs from Groovy DSL should
+be placed. You can then mention them in your packaging task to
+create jar with stubs Default value is: ${project.build.directory}/stubs. |
+
| skip | + +boolean | + +- | + +(no description) Default value is: false. User property is: spring.cloud.contract.verifier.skip. |
+
| source | + +File | + +- | + +Directory containing contracts written using the GroovyDSL
+
+ This parameter is only used when goal is executed outside of +maven project. Default value is: ${basedir}. User property is: contractsDirectory. |
+
skip:
+ +This parameter is only used when goal is executed outside of +maven project.
+
+
+
+
+
+
+
+
+
+
+
+ The following is a list of compile dependencies for this project. These dependencies are required to compile and run the application:
+| GroupId | +ArtifactId | +Version | +Type | +Licenses |
|---|---|---|---|---|
| ch.qos.logback | +logback-core | +1.1.3 | +jar | +Eclipse Public License - v 1.0-GNU Lesser General Public License |
| org.apache.maven | +maven-archiver | +3.0.0 | +jar | +Apache License, Version 2.0 |
| org.apache.maven.shared | +maven-filtering | +3.1.0 | +jar | +Apache License, Version 2.0 |
| org.codehaus.plexus | +plexus-archiver | +3.1 | +jar | +The Apache Software License, Version 2.0 |
| org.springframework.cloud | +spring-cloud-contract-stub-runner | +1.0.0.BUILD-SNAPSHOT | +jar | +Apache License, Version 2.0 |
| org.springframework.cloud | +spring-cloud-contract-verifier-converters | +1.0.0.BUILD-SNAPSHOT | +jar | +Apache License, Version 2.0 |
| org.springframework.cloud | +spring-cloud-contract-verifier-core | +1.0.0.BUILD-SNAPSHOT | +jar | +Apache License, Version 2.0 |
The following is a list of test dependencies for this project. These dependencies are only required to compile and run unit tests for the application:
+| GroupId | +ArtifactId | +Version | +Type | +Licenses |
|---|---|---|---|---|
| io.takari.maven.plugins | +takari-plugin-integration-testing | +2.9.0 | +pom | +The Eclipse Public License, Version 1.0 |
| io.takari.maven.plugins | +takari-plugin-testing | +2.9.0 | +jar | +The Eclipse Public License, Version 1.0 |
| junit | +junit | +4.12 | +jar | +Eclipse Public License 1.0 |
| org.apache.maven | +maven-compat | +3.2.5 | +jar | +Apache License, Version 2.0 |
| org.assertj | +assertj-core | +2.4.0 | +jar | +Apache License, Version 2.0 |
| org.slf4j | +slf4j-simple | +1.7.12 | +jar | +MIT License |
The following is a list of provided dependencies for this project. These dependencies are required to compile the application, but should be provided by default when using the library:
+| GroupId | +ArtifactId | +Version | +Type | +Licenses |
|---|---|---|---|---|
| javax.inject | +javax.inject | +1 | +jar | +The Apache Software License, Version 2.0 |
| org.apache.maven | +maven-core | +3.2.5 | +jar | +Apache License, Version 2.0 |
| org.apache.maven | +maven-plugin-api | +3.2.5 | +jar | +Apache License, Version 2.0 |
| org.apache.maven.plugin-tools | +maven-plugin-annotations | +3.4 | +jar | +Apache License, Version 2.0 |
| org.eclipse.aether | +aether-api | +1.1.0 | +jar | +Eclipse Public License, Version 1.0 |
The following is a list of transitive dependencies for this project. Transitive dependencies are the dependencies of the project dependencies.
+The following is a list of compile dependencies for this project. These dependencies are required to compile and run the application:
+The following is a list of test dependencies for this project. These dependencies are only required to compile and run unit tests for the application:
+| GroupId | +ArtifactId | +Version | +Type | +Licenses |
|---|---|---|---|---|
| io.takari.m2e.workspace | +org.eclipse.m2e.workspace.cli | +0.4.0 | +jar | +Eclipse Public License - v 1.0 |
| org.apache.commons | +commons-exec | +1.2 | +jar | +The Apache Software License, Version 2.0 |
| org.apache.maven.wagon | +wagon-provider-api | +2.8 | +jar | +Apache License, Version 2.0 |
| org.hamcrest | +hamcrest-core | +1.3 | +jar | +New BSD License |
The following is a list of provided dependencies for this project. These dependencies are required to compile the application, but should be provided by default when using the library:
+![[Information]](./images/icon_info_sml.gif){kind=icon}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Apache Public License 2.0: Plexus Cipher: encryption/decryption Component, Plexus Security Dispatcher Component, plexus-build-api
+The Apache License, Version 2.0: jsonassert
+Eclipse Public License 1.0: JUnit
+The Eclipse Public License, Version 1.0: takari-plugin-integration-testing, takari-plugin-testing
+MIT License: JCL 1.1.1 implemented over SLF4J, SLF4J API Module, SLF4J Simple Binding, args4j
+The JSON License: JSON in Java
+Public Domain: AOP alliance
+GNU Lesser General Public License: Logback Core Module
+New BSD License: Hamcrest Core
+Eclipse Public License, Version 1.0: Aether API, Aether Connector Basic, Aether Implementation, Aether SPI, Aether Transport File, Aether Transport HTTP, Aether Utilities, org.eclipse.sisu.inject, org.eclipse.sisu.plexus
+BSD: ASM Core, Automaton
+The BSD 3-Clause License: org.xmlunit:xmlunit-legacy
+Apache License 2.0: snappy
+Apache License, Version 2.0: Apache Commons Codec, Apache Commons Compress, Apache HttpClient, Apache HttpCore, Apache Maven Archiver, Apache Maven Filtering, Apache Maven Shared Utils, Apache Maven Wagon :: API, AssertJ fluent assertions, CDI APIs, Maven Aether Provider, Maven Artifact, Maven Compat, Maven Core, Maven Model, Maven Model Builder, Maven Plugin API, Maven Plugin Tools Java 5 Annotations, Maven Repository Metadata Model, Maven Settings, Maven Settings Builder, Spring Boot, Spring Boot AutoConfigure, Spring Boot Test, Spring Boot Test Auto-Configure, Spring Cloud Contract Spec, Spring Cloud Contract Stub Runner, Spring Cloud Contract Verifier Converters, Spring Cloud Contract Verifier Core, Spring Cloud Contract Verifier Maven Plugin, Spring Cloud Contract Verifier Messaging Core, Spring Cloud Contract Verifier Testing Utils
+COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0: JSR-250 Common Annotations for the JavaTM Platform
+The Apache Software License, Version 2.0: ASM based accessors helper used by json-smart, Apache Commons Collections, Apache Commons Exec, Apache Commons Lang, Apache Groovy, Commons IO, FindBugs-jsr305, Guava: Google Core Libraries for Java, JSON Small and Fast Parser, JSONassert, Jackson-annotations, Jackson-core, Json Path, Plexus :: Component Annotations, Plexus Archiver Component, Plexus Classworlds, Plexus Common Utilities, Plexus IO Components, Plexus Interpolation API, Sisu Guice - Core Library, Spring AOP, Spring Beans, Spring Context, Spring Core, Spring Expression Language (SpEL), WireMock, jackson-databind, javax.inject, org.xmlunit:xmlunit-core, zjsonpatch
+Eclipse Public License - v 1.0: Logback Core Module, m2e-workspace
| Filename | +Size | +Entries | +Classes | +Packages | +Java Version | +Debug Information |
|---|---|---|---|---|---|---|
| aopalliance-1.0.jar | +4.5 kB | +15 | +9 | +2 | +1.3 | +Yes |
| args4j-2.32.jar | +153.9 kB | +163 | +72 | +2 | +1.5 | +Yes |
| logback-core-1.1.3.jar | +455 kB | +410 | +365 | +35 | +1.6 | +Yes |
| jackson-annotations-2.8.0.jar | +55.8 kB | +74 | +62 | +1 | +1.6 | +Yes |
| jackson-core-2.8.0.jar | +280 kB | +117 | +94 | +9 | +1.6 | +Yes |
| jackson-databind-2.8.0.jar | +1.2 MB | +615 | +581 | +20 | +1.7 | +Yes |
| zjsonpatch-0.2.1.jar | +18.7 kB | +20 | +10 | +1 | +1.6 | +Yes |
| wiremock-2.1.7.jar | +323.6 kB | +292 | +271 | +15 | +1.7 | +Yes |
| jsr305-2.0.1.jar | +31.9 kB | +70 | +34 | +3 | +1.5 | +Yes |
| guava-18.0.jar | +2.3 MB | +1719 | +1690 | +17 | +1.6 | +Yes |
| json-path-2.2.0.jar | +207.1 kB | +176 | +160 | +11 | +1.6 | +Yes |
| jsonassert-0.4.7.jar | +13.2 kB | +17 | +12 | +1 | +1.7 | +Yes |
| commons-codec-1.10.jar | +284.2 kB | +238 | +92 | +6 | +1.6 | +Yes |
| commons-io-2.0.jar | +159.2 kB | +122 | +104 | +6 | +1.5 | +Yes |
| automaton-1.11-8.jar | +176.3 kB | +206 | +25 | +1 | +1.5 | +No |
| org.eclipse.m2e.workspace.cli-0.4.0.jar | +17.9 kB | +25 | +5 | +2 | +1.7 | +Yes |
| takari-plugin-integration-testing-2.9.0.pom | +1.6 kB | +- | +- | +- | +- | +- |
| takari-plugin-testing-2.9.0.jar | +80.8 kB | +55 | +41 | +3 | +1.7 | +Yes |
| jsr250-api-1.0.jar | +5.8 kB | +16 | +11 | +2 | +1.5 | +Yes |
| cdi-api-1.0.jar | +44.9 kB | +92 | +75 | +7 | +1.5 | +Yes |
| javax.inject-1.jar | +2.5 kB | +8 | +6 | +1 | +1.5 | +No |
| junit-4.12.jar | +314.9 kB | +323 | +286 | +30 | +1.5 | +Yes |
| accessors-smart-1.1.jar | +80.7 kB | +53 | +38 | +4 | +1.6 | +Yes |
| json-smart-2.2.1.jar | +120.5 kB | +107 | +93 | +5 | +1.6 | +Yes |
| commons-collections4-4.0.jar | +610.3 kB | +459 | +431 | +16 | +1.5 | +Yes |
| commons-compress-1.10.jar | +409.5 kB | +256 | +221 | +23 | +1.5 | +Yes |
| commons-exec-1.2.jar | +53.9 kB | +52 | +36 | +4 | +1.3 | +Yes |
| commons-lang3-3.3.jar | +412.6 kB | +241 | +217 | +12 | +1.6 | +Yes |
| httpclient-4.5.2.jar | +736.7 kB | +504 | +463 | +24 | +1.6 | +Yes |
| httpcore-4.4.5.jar | +327.4 kB | +283 | +253 | +17 | +1.6 | +Yes |
| maven-aether-provider-3.3.9.jar | +66.9 kB | +43 | +26 | +1 | +1.7 | +Yes |
| maven-archiver-3.0.0.jar | +22.5 kB | +19 | +5 | +1 | +1.6 | +Yes |
| maven-artifact-3.2.5.jar | +55.1 kB | +57 | +32 | +11 | +1.6 | +Yes |
| maven-compat-3.2.5.jar | +286.7 kB | +211 | +159 | +29 | +1.6 | +Yes |
| maven-core-3.2.5.jar | +608.2 kB | +463 | +372 | +51 | +1.6 | +Yes |
| maven-model-3.2.5.jar | +160.8 kB | +67 | +50 | +3 | +1.6 | +Yes |
| maven-model-builder-3.2.5.jar | +170.2 kB | +148 | +115 | +16 | +1.6 | +Yes |
| maven-plugin-api-3.2.5.jar | +46.1 kB | +46 | +25 | +6 | +1.6 | +Yes |
| maven-repository-metadata-3.2.5.jar | +26 kB | +25 | +7 | +2 | +1.6 | +Yes |
| maven-settings-3.2.5.jar | +43 kB | +33 | +17 | +2 | +1.6 | +Yes |
| maven-settings-builder-3.2.5.jar | +43.7 kB | +53 | +32 | +5 | +1.6 | +Yes |
| maven-plugin-annotations-3.4.jar | +14.2 kB | +22 | +7 | +1 | +1.5 | +Yes |
| maven-filtering-3.1.0.jar | +50.7 kB | +39 | +22 | +1 | +1.6 | +Yes |
| maven-shared-utils-3.0.0.jar | +154.7 kB | +101 | +77 | +9 | +1.6 | +Yes |
| wagon-provider-api-2.8.jar | +52.6 kB | +60 | +39 | +8 | +1.5 | +Yes |
| assertj-core-2.4.0.jar | +900.7 kB | +730 | +692 | +27 | +1.7 | +Yes |
| groovy-2.4.7.jar | +4.6 MB | +3257 | +3123 | +85 | +1.6 | +Yes |
| groovy-json-2.4.7.jar | +128 kB | +70 | +62 | +2 | +1.6 | +Yes |
| groovy-nio-2.4.7.jar | +19.3 kB | +13 | +2 | +1 | +1.7 | +Yes |
| groovy-xml-2.4.7.jar | +215.5 kB | +144 | +125 | +7 | +1.6 | +Yes |
| plexus-archiver-3.1.jar | +178.2 kB | +152 | +121 | +16 | +1.6 | +Yes |
| plexus-classworlds-2.5.2.jar | +52.7 kB | +52 | +37 | +5 | +1.6 | +Yes |
| plexus-component-annotations-1.5.5.jar | +4.2 kB | +15 | +3 | +1 | +1.5 | +No |
| plexus-interpolation-1.21.jar | +62.5 kB | +60 | +44 | +6 | +1.5 | +Yes |
| plexus-io-2.7.1.jar | +85.8 kB | +92 | +71 | +7 | +1.5 | +Yes |
| plexus-utils-3.0.22.jar | +244.9 kB | +129 | +104 | +9 | +1.5 | +Yes |
| aether-api-1.1.0.jar | +136.4 kB | +149 | +128 | +11 | +1.5 | +Yes |
| aether-connector-basic-1.1.0.jar | +36.7 kB | +34 | +19 | +1 | +1.5 | +Yes |
| aether-impl-1.1.0.jar | +172.8 kB | +114 | +96 | +4 | +1.5 | +Yes |
| aether-spi-1.1.0.jar | +30.7 kB | +54 | +34 | +8 | +1.5 | +Yes |
| aether-transport-file-1.1.0.jar | +8.9 kB | +19 | +4 | +1 | +1.5 | +Yes |
| aether-transport-http-1.1.0.jar | +36.7 kB | +35 | +20 | +1 | +1.5 | +Yes |
| aether-util-1.0.0.v20140518.jar | +145.8 kB | +125 | +100 | +13 | +1.5 | +Yes |
| org.eclipse.sisu.inject-0.3.0.M1.jar | +340.2 kB | +273 | +256 | +8 | +1.5 | +Yes |
| org.eclipse.sisu.plexus-0.3.0.M1.jar | +200.6 kB | +197 | +165 | +20 | +1.5 | +Yes |
| hamcrest-core-1.3.jar | +45 kB | +52 | +45 | +3 | +1.5 | +Yes |
| snappy-0.4.jar | +58 kB | +34 | +24 | +1 | +1.6 | +Yes |
| json-20140107.jar | +65 kB | +44 | +34 | +2 | +1.2 | +Yes |
| asm-5.0.3.jar | +53.2 kB | +30 | +25 | +2 | +1.2 | +No |
| jsonassert-1.2.3.jar | +27.7 kB | +30 | +19 | +2 | +1.6 | +Yes |
| jcl-over-slf4j-1.7.21.jar | +16.4 kB | +23 | +9 | +2 | +1.5 | +Yes |
| slf4j-api-1.7.21.jar | +41.1 kB | +46 | +34 | +4 | +1.5 | +Yes |
| slf4j-simple-1.7.12.jar | +10.7 kB | +16 | +6 | +1 | +1.5 | +Yes |
| plexus-build-api-0.0.7.jar | +8.5 kB | +19 | +4 | +1 | +1.4 | +Yes |
| plexus-cipher-1.4.jar | +13.5 kB | +20 | +6 | +1 | +1.4 | +Yes |
| plexus-sec-dispatcher-1.3.jar | +28.6 kB | +31 | +13 | +3 | +1.4 | +Yes |
| sisu-guice-3.2.3-no_aop.jar | +397.8 kB | +329 | +314 | +8 | +1.6 | +Yes |
| spring-aop-4.3.2.BUILD-SNAPSHOT.jar | +379.8 kB | +306 | +269 | +17 | +1.6 | +Yes |
| spring-beans-4.3.2.BUILD-SNAPSHOT.jar | +754.4 kB | +459 | +404 | +15 | +1.6 | +Yes |
| spring-context-4.3.2.BUILD-SNAPSHOT.jar | +1.1 MB | +889 | +767 | +66 | +1.6 | +Yes |
| spring-core-4.3.1.BUILD-SNAPSHOT.jar | +1.1 MB | +831 | +784 | +40 | +1.6 | +Yes |
| spring-expression-4.3.2.BUILD-SNAPSHOT.jar | +263.8 kB | +156 | +142 | +6 | +1.6 | +Yes |
| spring-boot-1.4.0.BUILD-SNAPSHOT.jar | +634.1 kB | +516 | +441 | +41 | +1.6 | +Yes |
| spring-boot-autoconfigure-1.4.0.BUILD-SNAPSHOT.jar | +928.6 kB | +846 | +757 | +73 | +1.6 | +Yes |
| spring-boot-test-1.4.0.BUILD-SNAPSHOT.jar | +140.2 kB | +126 | +102 | +11 | +1.6 | +Yes |
| spring-boot-test-autoconfigure-1.4.0.BUILD-SNAPSHOT.jar | +90.4 kB | +99 | +76 | +9 | +1.6 | +Yes |
| spring-cloud-contract-spec-1.0.0.BUILD-SNAPSHOT.jar | +113.5 kB | +71 | +53 | +4 | +1.7 | +Yes |
| spring-cloud-contract-stub-runner-1.0.0.BUILD-SNAPSHOT.jar | +128.9 kB | +83 | +70 | +2 | +1.7 | +Yes |
| spring-cloud-contract-verifier-converters-1.0.0.BUILD-SNAPSHOT.jar | +37.7 kB | +33 | +19 | +2 | +1.8 | +Yes |
| spring-cloud-contract-verifier-core-1.0.0.BUILD-SNAPSHOT.jar | +287.6 kB | +145 | +127 | +6 | +1.7 | +Yes |
| spring-cloud-contract-verifier-messaging-core-1.0.0.BUILD-SNAPSHOT.jar | +11.1 kB | +26 | +11 | +3 | +1.7 | +Yes |
| spring-cloud-contract-verifier-testing-utils-1.0.0.BUILD-SNAPSHOT.jar | +4.5 kB | +14 | +1 | +1 | +1.7 | +Yes |
| xmlunit-core-2.1.1.jar | +153.7 kB | +160 | +144 | +8 | +1.6 | +Yes |
| xmlunit-legacy-2.1.1.jar | +124.8 kB | +100 | +86 | +5 | +1.6 | +Yes |
| Total | +Size | +Entries | +Classes | +Packages | +Java Version | +Debug Information |
| 94 | +25.3 MB | +19363 | +16734 | +998 | +1.8 | +89 |
| compile: 68 | +compile: 21.5 MB | +compile: 16040 | +compile: 13952 | +compile: 758 | +- | +compile: 65 |
| test: 10 | +test: 1.8 MB | +test: 1524 | +test: 1309 | +test: 107 | +- | +test: 9 |
| provided: 16 | +provided: 2 MB | +provided: 1799 | +provided: 1473 | +provided: 133 | +- | +provided: 15 |
+
+
+
+
+
+
+
+
+
+
+
+ <dependency> + <groupId>org.springframework.cloud</groupId> + <artifactId>spring-cloud-contract-maven-plugin</artifactId> + <version>1.0.0.BUILD-SNAPSHOT</version> + <type>maven-plugin</type> +</dependency>
'org.springframework.cloud:spring-cloud-contract-maven-plugin:maven-plugin:1.0.0.BUILD-SNAPSHOT'
<dependency org="org.springframework.cloud" name="spring-cloud-contract-maven-plugin" rev="1.0.0.BUILD-SNAPSHOT"> + <artifact name="spring-cloud-contract-maven-plugin" type="maven-plugin" /> +</dependency>
@Grapes( +@Grab(group='org.springframework.cloud', module='spring-cloud-contract-maven-plugin', version='1.0.0.BUILD-SNAPSHOT') +)
compile 'org.springframework.cloud:spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT'
+
+
+
+
+
+
+
+
+
+
+
+ The following is a list of compile dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile and run the submodule:
+The following is a list of test dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile and run unit tests for the submodule:
+| GroupId | +ArtifactId | +Version | +Type | +License |
|---|---|---|---|---|
| org.apache.curator | +curator-test | +2.10.0 | +jar | +The Apache Software License, Version 2.0 |
| org.assertj | +assertj-core | +2.4.1 | +jar | +Apache License, Version 2.0 |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Full name:
+ +org.springframework.cloud:spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:generateStubs
+ +Description:
+ +Attributes:
+ +| Name | + +Type | + +Since | + +Description | +
|---|---|---|---|
| attachContracts | + +boolean | + +- | + +(no description) Default value is: true. |
+
| classifier | + +String | + +- | + +(no description) Default value is: stubs. |
+
| outputDirectory | + +File | + +- | + +(no description) Default value is: ${project.build.directory}/stubs. User property is: stubsDirectory. |
+
| skip | + +boolean | + +- | + +Set this to "true" to bypass Verifier execution.. Default value is: false. User property is: spring.cloud.contract.verifier.skip. |
+
skip:
+ +
+
+
+
+
+
+
+
+
+
+
+
+ Full name:
+ +org.springframework.cloud:spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:generateTests
+ +Description:
+ +Attributes:
+ +| Name | + +Type | + +Since | + +Description | +
|---|---|---|---|
| baseClassForTests | + +String | + +- | + +(no description) |
+
| basePackageForTests | + +String | + +- | + +(no description) Default value is: org.springframework.cloud.contract.verifier.tests. |
+
| contractsDirectory | + +File | + +- | + +(no description) Default value is: ${project.basedir}/src/test/resources/contracts. User property is: spring.cloud.contract.verifier.contractsDirectory. |
+
| excludedFiles | + +List | + +- | + +Patterns that should not be taken into account for processing |
+
| generatedTestSourcesDir | + +File | + +- | + +(no description) Default value is: ${project.build.directory}/generated-test-sources/contracts. |
+
| ignoredFiles | + +List | + +- | + +Patterns for which Spring Cloud Contract Verifier should generate
+@Ignored tests |
+
| imports | + +String[] | + +- | + +Imports that should be added to generated tests |
+
| nameSuffixForTests | + +String | + +- | + +(no description) |
+
| ruleClassForTests | + +String | + +- | + +(no description) |
+
| skip | + +boolean | + +- | + +(no description) Default value is: false. User property is: spring.cloud.contract.verifier.skip. |
+
| staticImports | + +String[] | + +- | + +Static imports that should be added to generated tests |
+
| testFramework | + +TestFramework | + +- | + +(no description) Default value is: JUNIT. |
+
| testMode | + +TestMode | + +- | + +(no description) Default value is: MOCKMVC. |
+
skip:
+ +
+
+
+
+
+
+
+
+
+
+
+
+ Full name:
+ +org.springframework.cloud:spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:help
+ +Description:
+ +Attributes:
+ +| Name | + +Type | + +Since | + +Description | +
|---|---|---|---|
| detail | + +boolean | + +- | + +If true, display all settable properties for each
+goal. Default value is: false. User property is: detail. |
+
| goal | + +String | + +- | + +The name of the goal for which to show help. If unspecified, all
+goals will be displayed. User property is: goal. |
+
| indentSize | + +int | + +- | + +The number of spaces per indentation level, should be positive. Default value is: 2. User property is: indentSize. |
+
| lineLength | + +int | + +- | + +The maximum length of a display line, should be positive. Default value is: 80. User property is: lineLength. |
+
goal:
+ +
+
+
+
+
+
+
+
+
+
+
+
+ Just to make long story short - Spring Cloud Contract Verifier is a tool that enables Consumer Driven Contract (CDC) development of JVM-based applications.
+Stubs mappings to be used by WireMock when doing integration testing on the client code (client tests).
+Acceptance tests used to verify if server-side implementation of the API is compliant with the contract (server tests).
+Spring Cloud Contract Verifier moves TDD to the level of software architecture.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ | t |
+
+
+
+
+
+
+
+
+
+ Sample minimal configuration for Java Project with JUnit tests.
+ <dependency>
+ <groupId>com.jayway.restassured</groupId>
+ <artifactId>rest-assured</artifactId>
+ <version>2.9.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.jayway.restassured</groupId>
+ <artifactId>spring-mock-mvc</artifactId>
+ <version>2.9.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.toomuchcoding.jsonassert</groupId>
+ <artifactId>jsonassert</artifactId>
+ <version>0.4.7</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.assertj</groupId>
+ <artifactId>assertj-core</artifactId>
+ <version>2.4.1</version>
+ <scope>test</scope>
+ </dependency> <plugin>
+ <groupId>org.springframework.cloud</groupId>
+ <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+ <version>${spring-cloud-verifier-plugin.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>convert</goal>
+ <goal>generateStubs</goal>
+ <goal>generateTests</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <baseClassForTests>hello.BaseAccurest</baseClassForTests>
+ </configuration>
+ </plugin>/**
+ *
+ * Copyright 2013-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package hello;
+
+import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc;
+
+import org.junit.Before;
+
+public class BaseAccurest {
+
+ @Before
+ public void setup() {
+ RestAssuredMockMvc.standaloneSetup(new GreetingController());
+ }
+
+}Typically the licenses listed for the project are that of the project itself, and not of dependencies.
Copyright 2014-2015 the original author or authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied. + +See the License for the specific language governing permissions and +limitations under the License.
[Original text] +Copy of the license follows:
+ +
+ Apache License
Version 2.0, January 2004
+http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ +"License" shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document.
+"Licensor" shall mean the copyright owner or entity authorized by the +copyright owner that is granting the License.
+"Legal Entity" shall mean the union of the acting entity and all other +entities that control, are controlled by, or are under common control with +that entity. For the purposes of this definition, "control" means (i) the +power, direct or indirect, to cause the direction or management of such +entity, whether by contract or otherwise, or (ii) ownership of fifty +percent (50%) or more of the outstanding shares, or (iii) beneficial +ownership of such entity.
+"You" (or "Your") shall mean an individual or Legal Entity exercising +permissions granted by this License.
+"Source" form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation source, +and configuration files.
+"Object" form shall mean any form resulting from mechanical transformation +or translation of a Source form, including but not limited to compiled +object code, generated documentation, and conversions to other media types.
+"Work" shall mean the work of authorship, whether in Source or Object form, +made available under the License, as indicated by a copyright notice that +is included in or attached to the work (an example is provided in the +Appendix below).
+"Derivative Works" shall mean any work, whether in Source or Object form, +that is based on (or derived from) the Work and for which the editorial +revisions, annotations, elaborations, or other modifications represent, as +a whole, an original work of authorship. For the purposes of this License, +Derivative Works shall not include works that remain separable from, or +merely link (or bind by name) to the interfaces of, the Work and Derivative +Works thereof.
+"Contribution" shall mean any work of authorship, including the original +version of the Work and any modifications or additions to that Work or +Derivative Works thereof, that is intentionally submitted to Licensor for +inclusion in the Work by the copyright owner or by an individual or Legal +Entity authorized to submit on behalf of the copyright owner. For the +purposes of this definition, "submitted" means any form of electronic, +verbal, or written communication sent to the Licensor or its +representatives, including but not limited to communication on electronic +mailing lists, source code control systems, and issue tracking systems that +are managed by, or on behalf of, the Licensor for the purpose of discussing +and improving the Work, but excluding communication that is conspicuously +marked or otherwise designated in writing by the copyright owner as "Not a +Contribution."
+"Contributor" shall mean Licensor and any individual or Legal Entity on +behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work.
+2. Grant of Copyright License. Subject to the +terms and conditions of this License, each Contributor hereby grants to You +a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable +copyright license to reproduce, prepare Derivative Works of, publicly +display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form.
+3. Grant of Patent License. Subject to the terms +and conditions of this License, each Contributor hereby grants to You a +perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable +(except as stated in this section) patent license to make, have made, use, +offer to sell, sell, import, and otherwise transfer the Work, where such +license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by +combination of their Contribution(s) with the Work to which such +Contribution(s) was submitted. If You institute patent litigation against +any entity (including a cross-claim or counterclaim in a lawsuit) alleging +that the Work or a Contribution incorporated within the Work constitutes +direct or contributory patent infringement, then any patent licenses +granted to You under this License for that Work shall terminate as of the +date such litigation is filed.
+4. Redistribution. You may reproduce and +distribute copies of the Work or Derivative Works thereof in any medium, +with or without modifications, and in Source or Object form, provided that +You meet the following conditions:
+5. Submission of Contributions. Unless You +explicitly state otherwise, any Contribution intentionally submitted for +inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the +terms of any separate license agreement you may have executed with Licensor +regarding such Contributions.
+6. Trademarks. This License does not grant +permission to use the trade names, trademarks, service marks, or product +names of the Licensor, except as required for reasonable and customary use +in describing the origin of the Work and reproducing the content of the +NOTICE file.
+7. Disclaimer of Warranty. Unless required by +applicable law or agreed to in writing, Licensor provides the Work (and +each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT +WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, +without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You +are solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise +of permissions under this License.
+8. Limitation of Liability. In no event and +under no legal theory, whether in tort (including negligence), contract, or +otherwise, unless required by applicable law (such as deliberate and +grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, +incidental, or consequential damages of any character arising as a result +of this License or out of the use or inability to use the Work (including +but not limited to damages for loss of goodwill, work stoppage, computer +failure or malfunction, or any and all other commercial damages or losses), +even if such Contributor has been advised of the possibility of such +damages.
+9. Accepting Warranty or Additional Liability. +While redistributing the Work or Derivative Works thereof, You may choose +to offer, and charge a fee for, acceptance of support, warranty, indemnity, +or other liability obligations and/or rights consistent with this License. +However, in accepting such obligations, You may act only on Your own behalf +and on Your sole responsibility, not on behalf of any other Contributor, +and only if You agree to indemnify, defend, and hold each Contributor +harmless for any liability incurred by, or claims asserted against, such +Contributor by reason of your accepting any such warranty or additional +liability.
+END OF TERMS AND CONDITIONS
+To apply the Apache License to your work, attach the following boilerplate +notice, with the fields enclosed by brackets "[]" replaced with your own +identifying information. (Don't include the brackets!) The text should be +enclosed in the appropriate comment syntax for the file format. We also +recommend that a file or class name and description of purpose be included +on the same "printed page" as the copyright notice for easier +identification within third-party archives.
+Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +
+
+
+
+
+
+
+
+
+
+
+
+ Goals available for this plugin:
+| Goal | +Description |
|---|---|
| spring-cloud-contract:convert | +Convert Spring Cloud Contract Verifier contracts into WireMock
+stubs mappings.
+ This goal allow to generate `stubs-jar` or execute +`spring-cloud-contract-verifier:run` with generated WireMock +mappings. |
| spring-cloud-contract:generateStubs | +No description. |
| spring-cloud-contract:generateTests | +No description. |
| spring-cloud-contract:help | +Display help information on
+spring-cloud-contract-maven-plugin. +Call mvn spring-cloud-contract:help -Ddetail=true
+-Dgoal=<goal-name> to display parameter details. |
| spring-cloud-contract:run | +No description. |
The following specifies the minimum requirements to run this Maven plugin:
+| Maven | +2.0 |
| JDK | +1.7 |
| Memory | +No minimum requirement. |
| Disk Space | +No minimum requirement. |
You should specify the version in your project's plugin configuration:
+<project> + ... + <build> + <!-- To define the plugin version in your parent POM --> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.springframework.cloud</groupId> + <artifactId>spring-cloud-contract-maven-plugin</artifactId> + <version>1.0.0.BUILD-SNAPSHOT</version> + </plugin> + ... + </plugins> + </pluginManagement> + <!-- To use the plugin goals in your POM or parent POM --> + <plugins> + <plugin> + <groupId>org.springframework.cloud</groupId> + <artifactId>spring-cloud-contract-maven-plugin</artifactId> + <version>1.0.0.BUILD-SNAPSHOT</version> + </plugin> + ... + </plugins> + </build> + ... +</project> +
For more information, see "Guide to Configuring Plug-ins"
+
+
+
+
+
+
+
+
+
+
+
+ | GroupId | +ArtifactId | +Version |
|---|---|---|
| io.takari.maven.plugins | +takari-lifecycle-plugin | +1.12.0 |
| org.apache.maven.plugins | +maven-antrun-plugin | +1.3 |
| org.apache.maven.plugins | +maven-assembly-plugin | +2.2-beta-5 |
| org.apache.maven.plugins | +maven-dependency-plugin | +2.8 |
| org.apache.maven.plugins | +maven-enforcer-plugin | +1.4.1 |
| org.apache.maven.plugins | +maven-failsafe-plugin | +2.19.1 |
| org.apache.maven.plugins | +maven-jar-plugin | +2.4 |
| org.apache.maven.plugins | +maven-plugin-plugin | +3.4 |
| org.apache.maven.plugins | +maven-release-plugin | +2.3.2 |
| org.apache.maven.plugins | +maven-resources-plugin | +2.6 |
| org.apache.maven.plugins | +maven-shade-plugin | +2.4.3 |
| org.apache.maven.plugins | +maven-surefire-plugin | +2.12.4 |
| org.apache.maven.plugins | +maven-war-plugin | +2.6 |
| org.codehaus.gmavenplus | +gmavenplus-plugin | +1.5 |
| org.codehaus.mojo | +exec-maven-plugin | +1.5.0 |
| org.codehaus.plexus | +plexus-component-metadata | +1.6 |
| org.eclipse.m2e | +lifecycle-mapping | +1.0.0 |
| org.eluder.coveralls | +coveralls-maven-plugin | +4.1.0 |
| org.springframework.boot | +spring-boot-maven-plugin | +1.4.0.RC1 |
| pl.project13.maven | +git-commit-id-plugin | +2.1.11 |
+
+
+
+
+
+
+
+
+
+
+
+ | GroupId | +ArtifactId | +Version |
|---|---|---|
| com.mycila | +license-maven-plugin | +3.0.rc1 |
| io.takari.maven.plugins | +takari-lifecycle-plugin | +1.12.0 |
| org.apache.maven.plugins | +maven-clean-plugin | +2.5 |
| org.apache.maven.plugins | +maven-compiler-plugin | +3.1 |
| org.apache.maven.plugins | +maven-deploy-plugin | +2.7 |
| org.apache.maven.plugins | +maven-failsafe-plugin | +2.19.1 |
| org.apache.maven.plugins | +maven-install-plugin | +2.4 |
| org.apache.maven.plugins | +maven-jar-plugin | +2.4 |
| org.apache.maven.plugins | +maven-javadoc-plugin | +2.10.4 |
| org.apache.maven.plugins | +maven-plugin-plugin | +3.4 |
| org.apache.maven.plugins | +maven-resources-plugin | +2.6 |
| org.apache.maven.plugins | +maven-scm-publish-plugin | +1.1 |
| org.apache.maven.plugins | +maven-site-plugin | +3.4 |
| org.apache.maven.plugins | +maven-source-plugin | +3.0.1 |
| org.apache.maven.plugins | +maven-surefire-plugin | +2.12.4 |
| org.codehaus.gmavenplus | +gmavenplus-plugin | +1.5 |
| org.codehaus.mojo | +animal-sniffer-maven-plugin | +1.14 |
| org.codehaus.plexus | +plexus-component-metadata | +1.6 |
| org.eluder.coveralls | +coveralls-maven-plugin | +4.1.0 |
| org.jacoco | +http://jacoco-maven-plugin | +0.7.7.201606060606 |
| GroupId | +ArtifactId | +Version |
|---|---|---|
| org.apache.maven.plugins | +maven-plugin-plugin | +3.4 |
+
+
+
+
+
+
+
+
+
+
+
+ This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.
+| Document | +Description |
|---|---|
| CI Management | +This is a link to the definitions of all continuous integration processes that builds and tests code on a frequent, regular basis. |
| Dependencies | +This document lists the project's dependencies and provides information on each dependency. |
| Dependency Information | +This document describes how to to include this project as a dependency using various dependency management tools. |
| Dependency Management | +This document lists the dependencies that are defined through dependencyManagement. |
| Distribution Management | +This document provides informations on the distribution management of this project. |
| About | +Spring Cloud Contract Verifier Maven Plugin |
| Issue Management | +This document provides information on the issue management system used in this project. |
| Licenses | +This document lists the project license(s). |
| Plugin Management | +This document lists the plugins that are defined through pluginManagement. |
| Plugins | +This document lists the build plugins and the report plugins used by this project. |
| Team | +This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another. |
| Source Code Management | +This document lists ways to access the online source repository. |
| Summary | +This document lists other related information of this project |
+
+
+
+
+
+
+
+
+
+
+
+ This document provides an overview of the various reports that are automatically generated by Maven . Each report is briefly described below.
+| Document | +Description |
|---|---|
| Plugin Documentation | +This report provides goals and parameters documentation of a plugin. |
+
+
+
+
+
+
+
+
+
+
+
+ | Field | +Value |
|---|---|
| Name | +Spring Cloud Contract Verifier Maven Plugin |
| Description | +Spring Cloud Contract Verifier Maven Plugin |
| Homepage | +https://github.com/spring-cloud/spring-cloud-contract |
+
+
+
+
+
+
+
+
+
+
+
+ Full name:
+ +org.springframework.cloud:spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:run
+ +Description:
+ +Attributes:
+ +| Name | + +Type | + +Since | + +Description | +
|---|---|---|---|
| destination | + +File | + +- | + +(no description) Default value is: ${basedir}. User property is: stubsDirectory. |
+
| httpPort | + +int | + +- | + +HTTP port for WireMock server Default value is: 8080. User property is: spring.cloud.contract.verifier.http.port. |
+
| maxPort | + +int | + +- | + +(no description) Default value is: 15000. User property is: spring.cloud.contract.verifier.http.maxPort. |
+
| minPort | + +int | + +- | + +(no description) Default value is: 10000. User property is: spring.cloud.contract.verifier.http.minPort. |
+
| skip | + +boolean | + +- | + +Set this to "true" to bypass verifier execution. Default value is: false. User property is: spring.cloud.contract.verifier.skip. |
+
| skipTestOnly | + +boolean | + +- | + +Set this to "true" to bypass verifier test generation. Default value is: false. User property is: spring.cloud.contract.verifier.skipTestOnly. |
+
| stubs | + +String | + +- | + +(no description) User property is: spring.cloud.contract.verifier.stubs. |
+
| stubsClassifier | + +String | + +- | + +Classifier used by stubs artifacts. Default value is: stubs. |
+
| stubsDirectory | + +File | + +- | + +(no description) Default value is: ${project.build.directory}/contracts/mappings. |
+
skip:
+ +
+
+
+
+
+
+
+
+
+
+
+
+ This page lists all entries of the navigation menu in expanded form.
+ +
+
+
+
+
+
+
+
+
+
+
+
+ This project uses Git to manage its source code. Instructions on Git use can be found at http://git-scm.com/documentation.
The source can be checked out anonymously from Git with this command (See http://git-scm.com/docs/git-clone):
+$ git clone https://github.com/spring-cloud/spring-cloud-contract.git
Only project developers can access the Git tree via this method (See http://git-scm.com/docs/git-clone).
+$ git clone git@github.com:spring-cloud/spring-cloud-contract.git
+
+
+
+
+
+
+
+
+
+
+
+ Sample minimal configuration for Groovy Project with Spock Specification
+ <dependency>
+ <groupId>org.spockframework</groupId>
+ <artifactId>spock-core</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.jayway.restassured</groupId>
+ <artifactId>rest-assured</artifactId>
+ <version>2.9.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.jayway.restassured</groupId>
+ <artifactId>spring-mock-mvc</artifactId>
+ <version>2.9.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.toomuchcoding.jsonassert</groupId>
+ <artifactId>jsonassert</artifactId>
+ <version>0.4.7</version>
+ <scope>test</scope>
+ </dependency> <plugin>
+ <groupId>org.springframework.cloud</groupId>
+ <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+ <version>${spring-cloud-verifier-plugin.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>convert</goal>
+ <goal>generateStubs</goal>
+ <goal>generateTests</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <baseClassForTests>hello.BaseAccurest</baseClassForTests>
+ <testFramework>SPOCK</testFramework>
+ </configuration>
+ </plugin>
+
+ <plugin>
+ <groupId>org.codehaus.gmavenplus</groupId>
+ <artifactId>gmavenplus-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>testCompile</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <testSources>
+ <testSource>
+ <directory>${project.basedir}/src/test/groovy</directory>
+ <includes>
+ <include>**/*.groovy</include>
+ </includes>
+ </testSource>
+ <testSource>
+ <directory>${project.build.directory}/generated-test-sources/contracts</directory>
+ <includes>
+ <include>**/*.groovy</include>
+ </includes>
+ </testSource>
+ </testSources>
+ </configuration>
+ </plugin>
+ <plugin>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <version>2.19</version>
+ <configuration>
+ <includes>
+ <include>**/*Spec.java</include>
+ </includes>
+ </configuration>
+ </plugin>/**
+ *
+ * Copyright 2013-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package hello
+
+import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc
+import spock.lang.Specification
+
+public class BaseAccurest extends Specification {
+
+ def setup() {
+ RestAssuredMockMvc.standaloneSetup(new GreetingController())
+ }
+
+}A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.
+The project team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.
+The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.
+| Image | +Id | +Name | +|
|---|---|---|---|
 |
+mariuszs | +Mariusz Smykula | +mariuszs@gmail.com |
 |
+marcingrzejszczak | +Marcin Grzejszczak | +marcin@grzejszczak.pl |
+
+
+
+
+
+
+
+
+
+
+
+ mvn org.springramework.cloud:spring-cloud-contract-maven-plugin:convert+
or shortly [1]
+mvn spring-cloud-contract-verifier:convert+
For more information please go to the Spring Cloud Contract Wiki or Plugin Documentation Site.
+Run stubs mappings from current directory:
+mvn org.springramework.cloud:spring-cloud-contract-maven-plugin:run+
or shortly [1]
+mvn spring-cloud-contract-verifier:run+
mvn spring-cloud-contract-verifier:run -Dstubs="org.springframework:gs-rest-service"+
where org.springframework:gs-rest-service is artifact with stubs classifier contains WireMock mappings.
<plugin>
+ <groupId>org.springframework.cloud</groupId>
+ <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+ <version>${spring-cloud-verifier-plugin.version}</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>convert</goal>
+ <goal>generateStubs</goal>
+ <goal>generateTests</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <baseClassForTests>hello.BaseAccurest</baseClassForTests>
+ </configuration>
+ </plugin>~/.m2/settings.xml is required: <pluginGroups><pluginGroup>io.codearte.Spring Cloud Contract</pluginGroup></pluginGroups>.
+Documentation Authors: Adam Dudczak, Marcin Grzejszczak, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła
Let’s take an example of Fraud Detection and Loan Issuance process. Let’s assume that the Loan Issuance is a client to the +Fraud Detection server. Let’s assume that we have to write a new feature (if a client wants too borrow too much money then +we mark him as fraud). The current implementation grants loan to everybody.
+Of course both client and server development teams need to communicate directly and discuss changes while +going through the process. CDC is all about communication.
+The code is available under the samples/samples-standalone/http-server and samples/samples-standalone/http-client folders.
As a developer of the Loan Issuance service (a consumer to the Fraud Detection server):
+start doing TDD by writing a test to your feature
+at some point in time you need to send a request to the Fraud Detection service
+you clone the Fraud Detection service repository locally
+you define the contract locally in the repo of Fraud Detection service
+provide the group id and artifact id for the Spring Cloud Contract Stub Runner to download stubs of your collaborators
+also provide the offline work switch since you don’t want to work offline
+when you need to install the stubs of the server side you execute e.g. ./mvnw clean install -DskipTests in their repo
when you’re happy with the contract and your test passes publish a PR to the server side
+As a developer of the Fraud Detection server (a server to the Loan Issuance service):
+take over the PR (if you try to build it your app will break cause you have a missing implementation)
+write the missing implementation
+deploy your app with the stubs e.g. ./mvnw clean deploy you’ll publish both the application fat jar and the stub jar
As a developer of the Loan Issuance service (a consumer to the Fraud Detection server):
+since the server side work was done you can merge the branch to master
+disable the offline work for Spring Cloud Contract Stub Runner
+at this moment the stubs of the server side will be automatically downloaded from Nexus / Artifactory
+Code examples:
+CLIENT
+start doing TDD
+def 'should be rejected due to abnormal loan amount'() {
+ given:
+ LoanApplication application =
+ new LoanApplication(client: new Client(pesel: '1234567890'), amount: 99_999)
+ when:
+ LoanApplicationResult loanApplication = sut.loanApplication(application)
+ then:
+ loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLICATION_REJECTED
+ loanApplication.rejectionReason == 'Amount too high'
+}at some point in time you need to send a request to the Fraud Detection service
+ResponseEntity<FraudServiceResponse> response =
+ restTemplate.exchange("http://localhost:" + port + "/fraudcheck", HttpMethod.PUT,
+ new HttpEntity<>(request, httpHeaders),
+ FraudServiceResponse.class);you define the contract locally in the repo of Fraud Detection service
+package contracts
+
+org.springframework.cloud.contract.spec.Contract.make {
+ request {
+ method 'PUT'
+ url '/fraudcheck'
+ body("""
+ {
+ "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}",
+ "loanAmount":99999}
+ """
+ )
+ headers {
+ header('Content-Type', 'application/vnd.fraud.v1+json')
+ }
+
+ }
+ response {
+ status 200
+ body( """{
+ "fraudCheckStatus": "${value(client('FRAUD'), server(regex('[A-Z]{5}')))}",
+ "rejectionReason": "Amount too high"
+}""")
+ headers {
+ header('Content-Type': value(server(regex('application/vnd.fraud.v1.json.*')), client('application/vnd.fraud.v1+json')))
+ }
+ }
+
+}provide the group id and artifact id for the Spring Cloud Contract Stub Runner to download stubs of your collaborators +also provide the offline work switch since you don’t want to work offline
+stubrunner:
+ work-offline: true
+ stubs.ids: 'com.example:http-server:+:stubs:8080'SERVER
+take over the PR (if you try to build it your app will break cause you have a missing implementation)
+the API
+@RequestMapping(
+ value = "/fraudcheck",
+ method = PUT,
+ consumes = FRAUD_SERVICE_JSON_VERSION_1,
+ produces = FRAUD_SERVICE_JSON_VERSION_1)
+public FraudCheckResult fraudCheck(@RequestBody FraudCheck fraudCheck) {
+}the initial impl
+@RequestMapping(
+ value = "/fraudcheck",
+ method = PUT,
+ consumes = FRAUD_SERVICE_JSON_VERSION_1,
+ produces = FRAUD_SERVICE_JSON_VERSION_1)
+public FraudCheckResult fraudCheck(@RequestBody FraudCheck fraudCheck) {
+return new FraudCheckResult(FraudCheckStatus.OK, NO_REASON);
+}write the missing implementation
+@RequestMapping(
+ value = "/fraudcheck",
+ method = PUT,
+ consumes = FRAUD_SERVICE_JSON_VERSION_1,
+ produces = FRAUD_SERVICE_JSON_VERSION_1)
+public FraudCheckResult fraudCheck(@RequestBody FraudCheck fraudCheck) {
+if (amountGreaterThanThreshold(fraudCheck)) {
+ return new FraudCheckResult(FraudCheckStatus.FRAUD, AMOUNT_TOO_HIGH);
+}
+return new FraudCheckResult(FraudCheckStatus.OK, NO_REASON);
+}-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.
You can also provide only one side of the communication using a regular expression. If you do that then automatically we’ll +provide the generated string that matches the provided regular expression. For example:
+org.springframework.cloud.contract.spec.Contract.make {
+ request {
+ method 'PUT'
+ url '/foo'
+ body([
+ requestElement: value(client(regex('[0-9]{5}')))
+ ])
+ }
+ response {
+ status 200
+ body([
+ responseElement: value(server(regex('[0-9]{7}')))
+ ])
+ }
+}In this example for request and response the opposite side of the communication will have the respective data generated.
+$ or value
In order to use Spring Cloud Contract Verifier with Wiremock you have to use gradle or maven plugin.
+In order to use Spring Cloud Contract Verifier with WireMock you have to use gradle or maven plugin.
$ or value
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}'
}
}
@@ -1574,7 +1753,7 @@ dependencies {
<plugin>
<groupId>org.springframework.cloud</groupId>
- <artifactId>spring-cloud-contract-verifier-maven-plugin</artifactId>
+ <artifactId>spring-cloud-contract-maven-plugin</artifactId>
<executions>
<execution>
<goals>
@@ -1588,7 +1767,7 @@ dependencies {
Read more: spring-cloud-contract-verifier-maven-plugin
+Read more: spring-cloud-contract-maven-plugin
<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>
@@ -1836,7 +2015,7 @@ class LoanApplicationServiceSpec extends Specification {
Read more: spring-cloud-contract-verifier-maven-plugin
+Read more: spring-cloud-contract-maven-plugin
<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>
@@ -1916,7 +2095,7 @@ src/test/resources/contracts/myservice/shouldReturnUser.groovyFor complete information take a look at Plugin Documentation
+For complete information take a look at Plugin Documentation
<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>
@@ -2067,7 +2246,7 @@ class LoanApplicationServiceSpec extends Specification {
- login marked as Started pointing to:
- showCart marked as Step1 pointing to:
- logout marked as Step2 which will close the scenario.
-More details about Wiremock scenarios can be found under [http://wiremock.org/stateful-behaviour.html](http://wiremock.org/stateful-behaviour.html)
+More details about Wiremock scenarios can be found under http://wiremock.org/stateful-behaviour.html
Spring Cloud Contract Verifier will also generate tests with guaranteed order of execution.
@@ -2550,44 +2729,6 @@ For messaging, special stub routes are defined.Just call the following command:
-./gradlew spring-cloud-contract-stub-runner-root:spring-cloud-contract-stub-runner:shadowJar -PfatJarand inside the build/lib there will be a Fat Jar with classifier fatJar waiting for you to execute. E.g.
java -jar spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/build/libs/spring-cloud-contract-stub-runner-1.0.0-SNAPSHOT-fatJar.jar -sr http://a.b.com -s a:b:c,d:e,f:g:h:iYou can configure the stub runner by either passing the full arguments list with the -Pargs like this:
./gradlew spring-cloud-contract-stub-runner-root:spring-cloud-contract-stub-runner:run -Pargs="-c pl -minp 10000 -maxp 10005 -s a:b:c,d:e,f:g:h"or each parameter separately with a -P prefix and without the hyphen - in the name of the param
./gradlew spring-cloud-contract-stub-runner-root:spring-cloud-contract-stub-runner:run -Pc=pl -Pminp=10000 -Pmaxp=10005 -Ps=a:b:c,d:e,f:g:hStubs are defined in JSON documents, whose syntax is defined in WireMock documentation
@@ -2796,6 +2937,12 @@ class StubRunnerBootSpec extends Specification {Convenience module that pulls together the dependencies needed to run the Stub Runner with WireMock, but without Spring Boot.
+Stub Runner comes with a JUnit rule thanks to which you can very easily download and run stubs for given group and artifact id:
@@ -2988,7 +3135,8 @@ its methods as presented below:@ContextConfiguration(classes = Config, loader = SpringApplicationContextLoader)
+@ContextConfiguration(classes = Config, loader = SpringBootContextLoader)
+@AutoConfigureStubRunner
class StubRunnerConfigurationSpec extends Specification {
@Autowired StubFinder stubFinder
@@ -3915,10 +4063,22 @@ receivedMessage.headers.get('BOOK-NAME') == 'foo'