(no description) User property is: contractDependency.
+
(no description) User property is: contractDependency.
@@ -316,7 +316,7 @@ stubs mappings.
-
Directory containing Spring Cloud Contract Verifier contracts
-written using the GroovyDSL Default value is: ${project.basedir}/src/test/resources/contracts. User property is: spring.cloud.contract.verifier.contractsDirectory.
+written using the GroovyDSL Default value is: ${project.basedir}/src/test/resources/contracts. User property is: spring.cloud.contract.verifier.contractsDirectory.
@@ -333,7 +333,7 @@ particular service lay. If not provided will be resolved to
If groupid is com.example and
artifactid is service then the resolved
-path will be /com/example/artifactid User property is: contractsPath.
+path will be /com/example/artifactid User property is: contractsPath.
@@ -347,7 +347,7 @@ path will be /com/example/artifactid User property is:
The URL from which a JAR containing the contracts should get
downloaded. If not provided but artifactid / coordinates notation
was provided then the current Maven's build repositories will be
-taken into consideration User property is: contractsRepositoryUrl.
+taken into consideration User property is: contractsRepositoryUrl.
@@ -359,7 +359,7 @@ taken into consideration User property is: contractsRepositoryUr
-
If true then JAR with contracts will be taken from
-local maven repository Default value is: false. User property is: contractsWorkOffline.
+local maven repository Default value is: false. User property is: contractsWorkOffline.
@@ -370,7 +370,7 @@ local maven repository Default value is: false. Use
-
-
(no description) Default value is: ${basedir}. User property is: stubsDirectory.
+
(no description) Default value is: ${basedir}. User property is: stubsDirectory.
@@ -383,7 +383,7 @@ local maven repository Default value is: false. Use
If true then any file laying in a path that contains
build or target will get excluded in
-further processing. Default value is: false. User property is: excludeBuildFolders.
+further processing. Default value is: false. User property is: excludeBuildFolders.
@@ -394,7 +394,7 @@ further processing. Default value is: false. User p
-
-
(no description) Default value is: false. User property is: spring.cloud.contract.verifier.skip.
+
(no description) Default value is: false. User property is: spring.cloud.contract.verifier.skip.
@@ -408,7 +408,7 @@ further processing. Default value is: false. User p
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.
+maven project. Default value is: ${basedir}. User property is: contractsDirectory.
Incubating feature. You can check the size of JSON arrays. If not
-turned on explicitly will be disabled. Default value is: false. User property is: spring.cloud.contract.verifier.assert.size.
+turned on explicitly will be disabled. Default value is: false. User property is: spring.cloud.contract.verifier.assert.size.
@@ -339,7 +339,7 @@ to a base class for that given expression.
When a contract's package matches the provided regular expression
then extending class will be the one provided in the map - in this
-case com.example.SomeBaseClass User property is: baseClassMappings.
+case com.example.SomeBaseClass User property is: baseClassMappings.
@@ -361,7 +361,7 @@ case com.example.SomeBaseClass User property is: baseCl
-
-
(no description) User property is: contractDependency.
+
(no description) User property is: contractDependency.
@@ -372,7 +372,7 @@ case com.example.SomeBaseClass User property is: baseCl
-
-
(no description) Default value is: ${project.basedir}/src/test/resources/contracts. User property is: spring.cloud.contract.verifier.contractsDirectory.
+
(no description) Default value is: ${project.basedir}/src/test/resources/contracts. User property is: spring.cloud.contract.verifier.contractsDirectory.
@@ -389,7 +389,7 @@ particular service lay. If not provided will be resolved to
If groupid is com.example and
artifactid is service then the resolved
-path will be /com/example/artifactid User property is: contractsPath.
+path will be /com/example/artifactid User property is: contractsPath.
@@ -403,7 +403,7 @@ path will be /com/example/artifactid User property is:
The URL from which a JAR containing the contracts should get
downloaded. If not provided but artifactid / coordinates notation
was provided then the current Maven's build repositories will be
-taken into consideration User property is: contractsRepositoryUrl.
+taken into consideration User property is: contractsRepositoryUrl.
@@ -415,7 +415,7 @@ taken into consideration User property is: contractsRepositoryUr
-
If true then JAR with contracts will be taken from
-local maven repository Default value is: false. User property is: contractsWorkOffline.
+local maven repository Default value is: false. User property is: contractsWorkOffline.
@@ -471,7 +471,7 @@ local maven repository Default value is: false. Use
-
-
(no description) Default value is: false. User property is: maven.test.skip.
+
(no description) Default value is: false. User property is: maven.test.skip.
@@ -501,7 +501,7 @@ provide the packageWithBaseClasses value to
test source file that will have the package
com.example.contracts.base and name
ExampleV1Base. As you can see it will take the two
-last folders to and attach Base to its name. User property is: packageWithBaseClasses.
+last folders to and attach Base to its name. User property is: packageWithBaseClasses.
@@ -523,7 +523,7 @@ last folders to and attach Base to its name. User property is-
-
(no description) Default value is: false. User property is: spring.cloud.contract.verifier.skip.
+
(no description) Default value is: false. User property is: spring.cloud.contract.verifier.skip.
@@ -534,7 +534,7 @@ last folders to and attach Base to its name. User property is-
-
(no description) Default value is: false. User property is: skipTests.
+
(no description) Default value is: false. User property is: skipTests.
@@ -860,7 +875,7 @@ $(addBlockSwitches);
Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer
-
1.2.0.BUILD-SNAPSHOT
+
2.0.0.BUILD-SNAPSHOT
@@ -2586,6 +2601,14 @@ of either Gradle or Maven plugins.
+
How can I see what got registered in the HTTP server stub?
+
+
You can use the mappingsOutputFolder property on @AutoConfigureStubRunner or StubRunnerRule
+to dump all mappings per artifact id. Also the port at which the given stub server was
+started will be attached.
+
+
+
Can I reference the request from the response?
Yes! With version 1.1.0 we’ve added such a possibility. On the HTTP stub server side we’re providing support
@@ -4045,7 +4068,7 @@ and proper stubbed routes are created.
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
- <version>Edgware.BUILD-SNAPSHOT</version>
+ <version>Finchley.BUILD-SNAPSHOT</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -4566,6 +4589,61 @@ There might be a problem with StubRunner shutting down ports between tests. You
Every stubbed collaborator exposes list of defined mappings under __/admin/ endpoint.
+
+
You can also use the mappingsOutputFolder property to dump the mappings to files.
+ For annotation based approach it would look like this
That means that there were two stubs registered. fraudDetectionServer was registered at port 13705
+and loanIssuance at port 12255. If we take a look at one of the files we would see (for WireMock)
+mappings available for the given server:
@@ -4783,7 +4870,7 @@ its methods as presented below:
@SpringBootTest(properties = [" stubrunner.cloud.enabled=false",
"stubrunner.camel.enabled=false",
'foo=${stubrunner.runningstubs.fraudDetectionServer.port}'])
-@AutoConfigureStubRunner
+@AutoConfigureStubRunner(mappingsOutputFolder = "target/outputmappings/")
@DirtiesContext
@ActiveProfiles("test")
class StubRunnerConfigurationSpec extends Specification {
@@ -4845,6 +4932,13 @@ class StubRunnerConfigurationSpec extends Specification {
foo == fraudPort
}
+ def 'should dump all mappings to a file'() {
+ when:
+ def url = stubFinder.findStubUrl("fraudDetectionServer")
+ then:
+ new File("target/outputmappings/", "fraudDetectionServer_${url.port}").exists()
+ }
+
@Configuration
@EnableAutoConfiguration
static class Config {}
@@ -8043,7 +8137,7 @@ real requests and you need to setup your generated test’s base class to wo
In the following document we will write about necessary migration steps between versions.
+
+
+
1.0.x → 1.1.x
+
+
New structure of generated stubs
+
+
In 1.1.x we have introduced a changed structure of generated stubs. So if you’ve
+been using the following @AutoConfigureWireMock notation to use the stubs from classpath
+
+
+
+
@AutoConfigureWireMock(stubs = "classpath:/customer-stubs/mappings", port = 8084)
+
+
+
+
It will no longer work with the new stubs. You have to either change the location of stubs
+to : classpath:…/META-INF/groupId/artifactId/version/mappings as follows
+
+
+
+
@AutoConfigureWireMock(stubs = "classpath:customer-stubs/META-INF/travel.components/customer-contract/1.0.2-SNAPSHOT/mappings/", port = 8084)
+
+
+
+
Or migrate to the new classpath based @AutoConfigureStubRunner.
+
+
+
If however you don’t want to do that and you want to remain with the old structure
+just set your plugin tasks accordingly. Example for the structure presented in the
+snippet above.
+
+
+
Maven
+
+
<!-- start of pom.xml -->
+
+<properties>
+ <!-- we don't want the verifier to do a jar for us -->
+ <spring.cloud.contract.verifier.skip>true</spring.cloud.contract.verifier.skip>
+</properties>
+
+<!-- ... -->
+
+<!-- You need to set up the assembly plugin -->
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>stub</id>
+ <phase>prepare-package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ <inherited>false</inherited>
+ <configuration>
+ <attach>true</attach>
+ <descriptor>${basedir}/src/assembly/stub.xml</descriptor>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build>
+<!-- end of pom.xml -->
+
+<!-- start of stub.xml-->
+
+<assembly
+ xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
+ <id>stubs</id>
+ <formats>
+ <format>jar</format>
+ </formats>
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>${project.build.directory}/snippets/stubs</directory>
+ <outputDirectory>customer-stubs/mappings</outputDirectory>
+ <includes>
+ <include>**/*</include>
+ </includes>
+ </fileSet>
+ <fileSet>
+ <directory>${basedir}/src/test/resources/contracts</directory>
+ <outputDirectory>customer-stubs/contracts</outputDirectory>
+ <includes>
+ <include>**/*.groovy</include>
+ </includes>
+ </fileSet>
+ </fileSets>
+</assembly>
+
+<!-- end of stub.xml-->
+
+
+
+
Gradle
+
+
task copyStubs(type: Copy, dependsOn: 'generateWireMockClientStubs') {
+// Preserve directory structure from 1.0.X of spring-cloud-contract
+ from "${project.buildDir}/resources/main/customer-stubs/META-INF/${project.group}/${project.name}/${project.version}"
+ into "${project.buildDir}/resources/main/customer-stubs"
+}
+
+
+
+
+
+
1.1.x → 1.2.x
+
+
Custom HttpServerStub
+
+
By introducing a method String registeredMappings() in the public interface
+HttpServerStub, if you wrote a custom HttpServerStub implementation, you’ll
+have to implement that method too. It should return a String representing
+all mappings available in a single HttpServerStub. Related to
+issue 355.