From f4ab6d8d52da2cc32e59f476b2f49ef6963c0436 Mon Sep 17 00:00:00 2001 From: Rossen Stoyanchev Date: Thu, 26 May 2016 09:48:16 -0400 Subject: [PATCH] MockRestServiceServerBuilder can be re-used Issue: SPR-14306 --- .../web/client/MockRestServiceServer.java | 50 +++++++++-------- .../client/MockRestServiceServerTests.java | 56 +++++++++++++++++++ .../test/web/client/samples/SampleTests.java | 9 +-- src/asciidoc/testing.adoc | 2 +- 4 files changed, 89 insertions(+), 28 deletions(-) create mode 100644 spring-test/src/test/java/org/springframework/test/web/client/MockRestServiceServerTests.java diff --git a/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java b/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java index bfc7032e85e..8c0d9e3e8c5 100644 --- a/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java +++ b/spring-test/src/main/java/org/springframework/test/web/client/MockRestServiceServer.java @@ -179,34 +179,35 @@ public class MockRestServiceServer { } - /** * Builder to create a {@code MockRestServiceServer}. */ public interface MockRestServiceServerBuilder { /** - * Allow expected requests to be executed in any order not necessarily - * matching the order of declaration. This is a shortcut for:
- * {@code builder.expectationManager(new UnorderedRequestExpectationManager)} - */ - MockRestServiceServerBuilder ignoreExpectOrder(); - - /** - * Configure a custom {@code RequestExpectationManager}. - *

By default {@link SimpleRequestExpectationManager} is used. It is - * also possible to switch to {@link UnorderedRequestExpectationManager} - * by setting {@link #ignoreExpectOrder()}. + * Whether to allow expected requests to be executed in any order not + * necessarily matching the order of declaration. + * + *

When set to "true" this is effectively a shortcut for:
+ * {@code builder.build(new UnorderedRequestExpectationManager)}. + * + * @param ignoreExpectOrder whether to ignore the order of expectations */ - MockRestServiceServerBuilder expectationManager(RequestExpectationManager manager); + MockRestServiceServerBuilder ignoreExpectOrder(boolean ignoreExpectOrder); /** - * Build the {@code MockRestServiceServer} and setting up the underlying + * Build the {@code MockRestServiceServer} and set up the underlying * {@code RestTemplate} or {@code AsyncRestTemplate} with a * {@link ClientHttpRequestFactory} that creates mock requests. */ MockRestServiceServer build(); + /** + * An overloaded build alternative that accepts a custom + * {@link RequestExpectationManager}. + */ + MockRestServiceServer build(RequestExpectationManager manager); + } private static class DefaultBuilder implements MockRestServiceServerBuilder { @@ -215,7 +216,7 @@ public class MockRestServiceServer { private final AsyncRestTemplate asyncRestTemplate; - private RequestExpectationManager expectationManager = new SimpleRequestExpectationManager(); + private boolean ignoreExpectOrder; public DefaultBuilder(RestTemplate restTemplate) { @@ -232,21 +233,24 @@ public class MockRestServiceServer { @Override - public MockRestServiceServerBuilder ignoreExpectOrder() { - expectationManager(new UnorderedRequestExpectationManager()); + public MockRestServiceServerBuilder ignoreExpectOrder(boolean ignoreExpectOrder) { + this.ignoreExpectOrder = true; return this; } @Override - public MockRestServiceServerBuilder expectationManager(RequestExpectationManager manager) { - Assert.notNull(manager, "'manager' is required."); - this.expectationManager = manager; - return this; + public MockRestServiceServer build() { + if (this.ignoreExpectOrder) { + return build(new UnorderedRequestExpectationManager()); + } + else { + return build(new SimpleRequestExpectationManager()); + } } @Override - public MockRestServiceServer build() { - MockRestServiceServer server = new MockRestServiceServer(this.expectationManager); + public MockRestServiceServer build(RequestExpectationManager manager) { + MockRestServiceServer server = new MockRestServiceServer(manager); MockClientHttpRequestFactory factory = server.new MockClientHttpRequestFactory(); if (this.restTemplate != null) { this.restTemplate.setRequestFactory(factory); diff --git a/spring-test/src/test/java/org/springframework/test/web/client/MockRestServiceServerTests.java b/spring-test/src/test/java/org/springframework/test/web/client/MockRestServiceServerTests.java new file mode 100644 index 00000000000..f714dea66d9 --- /dev/null +++ b/spring-test/src/test/java/org/springframework/test/web/client/MockRestServiceServerTests.java @@ -0,0 +1,56 @@ +/* + * Copyright 2002-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 org.springframework.test.web.client; + +import org.junit.Test; + +import org.springframework.test.web.client.MockRestServiceServer.MockRestServiceServerBuilder; +import org.springframework.web.client.RestTemplate; + +import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; +import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess; + +/** + * Unit tests for {@link MockRestServiceServer}. + * @author Rossen Stoyanchev + */ +public class MockRestServiceServerTests { + + @Test + public void buildMultipleTimes() throws Exception { + + RestTemplate restTemplate = new RestTemplate(); + MockRestServiceServerBuilder builder = MockRestServiceServer.bindTo(restTemplate); + + MockRestServiceServer server = builder.build(); + server.expect(requestTo("/foo")).andRespond(withSuccess()); + restTemplate.getForObject("/foo", Void.class); + server.verify(); + + server = builder.ignoreExpectOrder(true).build(); + server.expect(requestTo("/foo")).andRespond(withSuccess()); + server.expect(requestTo("/bar")).andRespond(withSuccess()); + restTemplate.getForObject("/bar", Void.class); + restTemplate.getForObject("/foo", Void.class); + server.verify(); + + server = builder.build(); + server.expect(requestTo("/bar")).andRespond(withSuccess()); + restTemplate.getForObject("/bar", Void.class); + server.verify(); + } + +} diff --git a/spring-test/src/test/java/org/springframework/test/web/client/samples/SampleTests.java b/spring-test/src/test/java/org/springframework/test/web/client/samples/SampleTests.java index 2bb264a8047..6d5c7452b6f 100644 --- a/spring-test/src/test/java/org/springframework/test/web/client/samples/SampleTests.java +++ b/spring-test/src/test/java/org/springframework/test/web/client/samples/SampleTests.java @@ -49,7 +49,7 @@ public class SampleTests { @Before public void setup() { this.restTemplate = new RestTemplate(); - this.mockServer = MockRestServiceServer.bindTo(this.restTemplate).ignoreExpectOrder().build(); + this.mockServer = MockRestServiceServer.bindTo(this.restTemplate).ignoreExpectOrder(true).build(); } @Test @@ -125,10 +125,11 @@ public class SampleTests { .andRespond(withSuccess("8", MediaType.TEXT_PLAIN)); @SuppressWarnings("unused") - String result = this.restTemplate.getForObject("/number", String.class); - // result == "1" + String result1 = this.restTemplate.getForObject("/number", String.class); + // result1 == "1" - result = this.restTemplate.getForObject("/number", String.class); + @SuppressWarnings("unused") + String result2 = this.restTemplate.getForObject("/number", String.class); // result == "2" try { diff --git a/src/asciidoc/testing.adoc b/src/asciidoc/testing.adoc index 3eaf2e4205b..6e83223758e 100644 --- a/src/asciidoc/testing.adoc +++ b/src/asciidoc/testing.adoc @@ -5095,7 +5095,7 @@ means requests are allowed to come in any order. Here is an example: [source,java,indent=0] [subs="verbatim,quotes"] ---- - server = MockRestServiceServer.bindTo(restTemplate).ignoreExpectOrder().build(); + server = MockRestServiceServer.bindTo(restTemplate).ignoreExpectOrder(true).build(); ---- Even with unordered requests by default each request is allowed to execute once only.