Example of usage in Spock tests:
@ClassRule @Shared StubRunnerRule rule = new StubRunnerRule() .stubsMode(StubRunnerProperties.StubsMode.REMOTE) .repoRoot(StubRunnerRuleSpec.getResource("/m2repo/repository").toURI().toString()) diff --git a/multi/multi__spring_cloud_contract_wiremock.html b/multi/multi__spring_cloud_contract_wiremock.html index ab7fe3047c..5ba211e421 100644 --- a/multi/multi__spring_cloud_contract_wiremock.html +++ b/multi/multi__spring_cloud_contract_wiremock.html @@ -12,21 +12,23 @@ your test. The following code shows an example:< @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureWireMock(port = 0) public class WiremockForDocsTests { + // A service that calls out over HTTP - @Autowired private Service service; + @Autowired + private Service service; // Using the WireMock APIs in the normal way: @Test public void contextLoads() throws Exception { // Stubbing WireMock - stubFor(get(urlEqualTo("/resource")) - .willReturn(aResponse().withHeader("Content-Type", "text/plain").withBody("Hello World!"))); + stubFor(get(urlEqualTo("/resource")).willReturn(aResponse() + .withHeader("Content-Type", "text/plain").withBody("Hello World!"))); // We're asserting if WireMock responded properly assertThat(this.service.go()).isEqualTo("Hello World!"); } } -//end::wiremock_test2[]To start the stub server on a different port use (for example), +// end::wiremock_test2[]
To start the stub server on a different port use (for example),
@AutoConfigureWireMock(port=9999). For a random port, use a value of 0. The stub
server port can be bound in the test application context with the "wiremock.server.port"
property. Using @AutoConfigureWireMock adds a bean of type WiremockConfiguration to
@@ -72,6 +74,7 @@ instance, as shown in the following example:
@ClassRule public static WireMockClassRule wiremock = new WireMockClassRule( WireMockSpring.options().dynamicPort()); + // A service that calls out over HTTP to localhost:${wiremock.port} @Autowired private Service service; @@ -80,14 +83,14 @@ instance, as shown in the following example:@Test public void contextLoads() throws Exception { // Stubbing WireMock - wiremock.stubFor(get(urlEqualTo("/resource")) - .willReturn(aResponse().withHeader("Content-Type", "text/plain").withBody("Hello World!"))); + wiremock.stubFor(get(urlEqualTo("/resource")).willReturn(aResponse() + .withHeader("Content-Type", "text/plain").withBody("Hello World!"))); // We're asserting if WireMock responded properly assertThat(this.service.go()).isEqualTo("Hello World!"); } } -//end::wiremock_test2[]The
@ClassRulemeans that the server shuts down after all the methods in this class +// end::wiremock_test2[]
The @ClassRule means that the server shuts down after all the methods in this class
have been run.
WireMock lets you stub a "secure" server with an "https" URL protocol. If your
application wants to contact that stub server in an integration test, it will find that
the SSL certificates are not valid (the usual problem with self-installed certificates).
@@ -136,6 +139,7 @@ a Spring MockRestServiceServer. The following code
assertThat(this.service.go()).isEqualTo("Hello World");
server.verify();
}
+
}
The baseUrl value is prepended to all mock calls, and the stubs() method takes a stub
path resource pattern as an argument. In the preceding example, the stub defined at
/stubs/resource.json is loaded into the mock server. If the RestTemplate is asked to
@@ -148,9 +152,11 @@ Spring Boot embedded servers, and Wiremock itself has "native" support for a par
version of Jetty (currently 9.2). To use the native Jetty, you need to add the native
Wiremock dependencies and exclude the Spring Boot container (if there is one).
You can register a bean of org.springframework.cloud.contract.wiremock.WireMockConfigurationCustomizer type
in order to customize the WireMock configuration (e.g. add custom transformers).
-Example:
@Bean WireMockConfigurationCustomizer optionsCustomizer() { +Example:@Bean + WireMockConfigurationCustomizer optionsCustomizer() { return new WireMockConfigurationCustomizer() { - @Override public void customize(WireMockConfiguration options) { + @Override + public void customize(WireMockConfiguration options) { // perform your customization here } }; @@ -264,16 +270,14 @@ about a situation in which they would like to move to DSL-based contract definit but they already have a lot of Spring MVC tests. Using this feature lets you generate the contract files that you can later modify and move to folders (defined in your configuration) so that the plugin finds them.
Tip You might wonder why this functionality is in the WireMock module. The functionality -is there because it makes sense to generate both the contracts and the stubs.
Consider the following test:
this.mockMvc.perform(post("/foo") - .accept(MediaType.APPLICATION_PDF) - .accept(MediaType.APPLICATION_JSON) - .contentType(MediaType.APPLICATION_JSON) - .content("{\"foo\": 23, \"bar\" : \"baz\" }")) - .andExpect(status().isOk()) - .andExpect(content().string("bar")) +is there because it makes sense to generate both the contracts and the stubs.
![[Tip]](images/tip.png)
Consider the following test:
this.mockMvc + .perform(post("/foo").accept(MediaType.APPLICATION_PDF) + .accept(MediaType.APPLICATION_JSON) + .contentType(MediaType.APPLICATION_JSON) + .content("{\"foo\": 23, \"bar\" : \"baz\" }")) + .andExpect(status().isOk()).andExpect(content().string("bar")) // first WireMock - .andDo(WireMockRestDocs.verify() - .jsonPath("$[?(@.foo >= 20)]") + .andDo(WireMockRestDocs.verify().jsonPath("$[?(@.foo >= 20)]") .jsonPath("$[?(@.bar in ['baz','bazz','bazzz'])]") .contentType(MediaType.valueOf("application/json")) .stub("shouldGrantABeerIfOldEnough")) diff --git a/multi/multi_stub-runner-for-messaging.html b/multi/multi_stub-runner-for-messaging.html index edf0586ed6..2dd19c55af 100644 --- a/multi/multi_stub-runner-for-messaging.html +++ b/multi/multi_stub-runner-for-messaging.html @@ -12,10 +12,10 @@ That way the only remaining framework is Spring AMQP.public interface StubTrigger { /** - * Triggers an event by a given label for a given {@code groupid:artifactid} notation. You can use only {@code artifactId} too. + * Triggers an event by a given label for a given {@code groupid:artifactid} notation. + * You can use only {@code artifactId} too. * * Feature related to messaging. - * * @return true - if managed to run a trigger */ boolean trigger(String ivyNotation, String labelName); @@ -24,7 +24,6 @@ That way the only remaining framework is Spring AMQP. boolean trigger(String labelName); @@ -33,7 +32,6 @@ That way the only remaining framework is Spring AMQP. boolean trigger(); @@ -44,6 +42,7 @@ That way the only remaining framework is Spring AMQP. Map<String, Collection<String>> labels(); + }
For convenience, the StubFinder interface extends StubTrigger, so you only need one
or the other in your tests.
StubTrigger gives you the following options to trigger a message:
stubFinder.trigger('org.springframework.cloud.contract.verifier.stubs:streamService', 'return_book_1')
Spring Cloud Contract Verifier Stub Runner’s messaging module gives you an easy way to
integrate with Spring Integration. For the provided artifacts, it automatically downloads
@@ -270,20 +269,20 @@ to disable them explicitly by setting the stubrunner.stre
follows:
stubTrigger.trigger("contract-test.person.created.event")The message has a destination of contract-test.exchange, so the Spring AMQP stub runner
integration looks for bindings related to this exchange.
@Bean public Binding binding() { - return BindingBuilder.bind(new Queue("test.queue")).to(new DirectExchange("contract-test.exchange")).with("#"); + return BindingBuilder.bind(new Queue("test.queue")) + .to(new DirectExchange("contract-test.exchange")).with("#"); }
The binding definition binds the queue test.queue. As a result, the following listener
definition is matched and invoked with the contract message.
@Bean -public SimpleMessageListenerContainer simpleMessageListenerContainer(ConnectionFactory connectionFactory, - MessageListenerAdapter listenerAdapter) { +public SimpleMessageListenerContainer simpleMessageListenerContainer( + ConnectionFactory connectionFactory, + MessageListenerAdapter listenerAdapter) { SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(); container.setConnectionFactory(connectionFactory); container.setQueueNames("test.queue"); container.setMessageListener(listenerAdapter); return container; -}
Also, the following annotated listener matches and is invoked:
@RabbitListener(bindings = @QueueBinding(
- value = @Queue(value = "test.queue"),
- exchange = @Exchange(value = "contract-test.exchange", ignoreDeclarationExceptions = "true")))
+}Also, the following annotated listener matches and is invoked:
@RabbitListener(bindings = @QueueBinding(value = @Queue(value = "test.queue"), exchange = @Exchange(value = "contract-test.exchange", ignoreDeclarationExceptions = "true"))) public void handlePerson(Person person) { this.person = person; }
For convenience, the StubFinder interface extends StubTrigger, so you only need one
or the other in your tests.
StubTrigger gives you the following options to trigger a message:
stubFinder.trigger('org.springframework.cloud.contract.verifier.stubs:streamService', 'return_book_1')
Spring Cloud Contract Verifier Stub Runner’s messaging module gives you an easy way to
integrate with Spring Integration. For the provided artifacts, it automatically downloads
@@ -3329,20 +3330,20 @@ to disable them explicitly by setting the stubrunner.stre
follows:
stubTrigger.trigger("contract-test.person.created.event")The message has a destination of contract-test.exchange, so the Spring AMQP stub runner
integration looks for bindings related to this exchange.
@Bean public Binding binding() { - return BindingBuilder.bind(new Queue("test.queue")).to(new DirectExchange("contract-test.exchange")).with("#"); + return BindingBuilder.bind(new Queue("test.queue")) + .to(new DirectExchange("contract-test.exchange")).with("#"); }
The binding definition binds the queue test.queue. As a result, the following listener
definition is matched and invoked with the contract message.
@Bean -public SimpleMessageListenerContainer simpleMessageListenerContainer(ConnectionFactory connectionFactory, - MessageListenerAdapter listenerAdapter) { +public SimpleMessageListenerContainer simpleMessageListenerContainer( + ConnectionFactory connectionFactory, + MessageListenerAdapter listenerAdapter) { SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(); container.setConnectionFactory(connectionFactory); container.setQueueNames("test.queue"); container.setMessageListener(listenerAdapter); return container; -}
Also, the following annotated listener matches and is invoked:
@RabbitListener(bindings = @QueueBinding(
- value = @Queue(value = "test.queue"),
- exchange = @Exchange(value = "contract-test.exchange", ignoreDeclarationExceptions = "true")))
+}Also, the following annotated listener matches and is invoked:
@RabbitListener(bindings = @QueueBinding(value = @Queue(value = "test.queue"), exchange = @Exchange(value = "contract-test.exchange", ignoreDeclarationExceptions = "true"))) public void handlePerson(Person person) { this.person = person; }
![[Note]](images/note.png) | Note | ||
|---|---|---|---|
The message is directly handed over to the < @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureWireMock(port = 0) public class WiremockForDocsTests { + // A service that calls out over HTTP - @Autowired private Service service; + @Autowired + private Service service; // Using the WireMock APIs in the normal way: @Test public void contextLoads() throws Exception { // Stubbing WireMock - stubFor(get(urlEqualTo("/resource")) - .willReturn(aResponse().withHeader("Content-Type", "text/plain").withBody("Hello World!"))); + stubFor(get(urlEqualTo("/resource")).willReturn(aResponse() + .withHeader("Content-Type", "text/plain").withBody("Hello World!"))); // We're asserting if WireMock responded properly assertThat(this.service.go()).isEqualTo("Hello World!"); } } -//end::wiremock_test2[] To start the stub server on a different port use (for example), +// end::wiremock_test2[] To start the stub server on a different port use (for example),
@ClassRule public static WireMockClassRule wiremock = new WireMockClassRule( WireMockSpring.options().dynamicPort()); + // A service that calls out over HTTP to localhost:${wiremock.port} @Autowired private Service service; @@ -6059,14 +6063,14 @@ instance, as shown in the following example:@Test public void contextLoads() throws Exception { // Stubbing WireMock - wiremock.stubFor(get(urlEqualTo("/resource")) - .willReturn(aResponse().withHeader("Content-Type", "text/plain").withBody("Hello World!"))); + wiremock.stubFor(get(urlEqualTo("/resource")).willReturn(aResponse() + .withHeader("Content-Type", "text/plain").withBody("Hello World!"))); // We're asserting if WireMock responded properly assertThat(this.service.go()).isEqualTo("Hello World!"); } } -//end::wiremock_test2[] The WireMock lets you stub a "secure" server with an "https" URL protocol. If your
application wants to contact that stub server in an integration test, it will find that
the SSL certificates are not valid (the usual problem with self-installed certificates).
@@ -6115,6 +6119,7 @@ a Spring The You can register a bean of @Bean WireMockConfigurationCustomizer optionsCustomizer() { +Example:@Bean + WireMockConfigurationCustomizer optionsCustomizer() { return new WireMockConfigurationCustomizer() { - @Override public void customize(WireMockConfiguration options) { + @Override + public void customize(WireMockConfiguration options) { // perform your customization here } }; @@ -6243,16 +6250,14 @@ about a situation in which they would like to move to DSL-based contract definit but they already have a lot of Spring MVC tests. Using this feature lets you generate the contract files that you can later modify and move to folders (defined in your configuration) so that the plugin finds them. |
Consider the following test:
this.mockMvc + .perform(post("/foo").accept(MediaType.APPLICATION_PDF) + .accept(MediaType.APPLICATION_JSON) + .contentType(MediaType.APPLICATION_JSON) + .content("{\"foo\": 23, \"bar\" : \"baz\" }")) + .andExpect(status().isOk()).andExpect(content().string("bar")) // first WireMock - .andDo(WireMockRestDocs.verify() - .jsonPath("$[?(@.foo >= 20)]") + .andDo(WireMockRestDocs.verify().jsonPath("$[?(@.foo >= 20)]") .jsonPath("$[?(@.bar in ['baz','bazz','bazzz'])]") .contentType(MediaType.valueOf("application/json")) .stub("shouldGrantABeerIfOldEnough")) diff --git a/spring-cloud-contract-maven-plugin/checkstyle.html b/spring-cloud-contract-maven-plugin/checkstyle.html index 31b6f60d58..88ed24d9e3 100644 --- a/spring-cloud-contract-maven-plugin/checkstyle.html +++ b/spring-cloud-contract-maven-plugin/checkstyle.html @@ -285,7 +285,7 @@12 0 0 -545
Error