Add @RestClientTest support
Add @RestClientTest annotation that can be used when testing REST clients. Provides auto-configuration for a MockRestServiceServer which can be used when the bean under test builds a single RestTemplate via the auto-configured RestTemplateBuilder. Closes gh-6030
This commit is contained in:
Phillip Webb
@@ -0,0 +1,176 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.test.web.client;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.ExpectedException;
|
||||
|
||||
import org.springframework.boot.web.client.RestTemplateBuilder;
|
||||
import org.springframework.test.web.client.RequestExpectationManager;
|
||||
import org.springframework.test.web.client.SimpleRequestExpectationManager;
|
||||
import org.springframework.test.web.client.UnorderedRequestExpectationManager;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
|
||||
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
|
||||
|
||||
/**
|
||||
* Tests for {@link MockServerRestTemplateCustomizer}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class MockServerRestTemplateCustomizerTests {
|
||||
|
||||
private MockServerRestTemplateCustomizer customizer;
|
||||
|
||||
@Rule
|
||||
public ExpectedException thrown = ExpectedException.none();
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
this.customizer = new MockServerRestTemplateCustomizer();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createShouldUseSimpleRequestExpectationManager() throws Exception {
|
||||
MockServerRestTemplateCustomizer customizer = new MockServerRestTemplateCustomizer();
|
||||
customizer.customize(new RestTemplate());
|
||||
assertThat(customizer.getServer()).extracting("expectationManager")
|
||||
.hasAtLeastOneElementOfType(SimpleRequestExpectationManager.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenExpectationManagerClassIsNullShouldThrowException()
|
||||
throws Exception {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("ExpectationManager must not be null");
|
||||
new MockServerRestTemplateCustomizer(null);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createShouldUseExpectationMangerClass() throws Exception {
|
||||
MockServerRestTemplateCustomizer customizer = new MockServerRestTemplateCustomizer(
|
||||
UnorderedRequestExpectationManager.class);
|
||||
customizer.customize(new RestTemplate());
|
||||
assertThat(customizer.getServer()).extracting("expectationManager")
|
||||
.hasAtLeastOneElementOfType(UnorderedRequestExpectationManager.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void detectRootUriShouldDefaultToTrue() throws Exception {
|
||||
MockServerRestTemplateCustomizer customizer = new MockServerRestTemplateCustomizer(
|
||||
UnorderedRequestExpectationManager.class);
|
||||
customizer.customize(
|
||||
new RestTemplateBuilder().rootUri("http://example.com").build());
|
||||
assertThat(customizer.getServer()).extracting("expectationManager")
|
||||
.hasAtLeastOneElementOfType(RootUriRequestExpectationManager.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void setDetectRootUriShouldDisableRootUriDetection() throws Exception {
|
||||
this.customizer.setDetectRootUri(false);
|
||||
this.customizer.customize(
|
||||
new RestTemplateBuilder().rootUri("http://example.com").build());
|
||||
assertThat(this.customizer.getServer()).extracting("expectationManager")
|
||||
.hasAtLeastOneElementOfType(SimpleRequestExpectationManager.class);
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void customizeShouldBindServer() throws Exception {
|
||||
RestTemplate template = new RestTemplateBuilder(this.customizer).build();
|
||||
this.customizer.getServer().expect(requestTo("/test")).andRespond(withSuccess());
|
||||
template.getForEntity("/test", String.class);
|
||||
this.customizer.getServer().verify();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getServerWhenNoServersAreBoundShouldThrowException() throws Exception {
|
||||
this.thrown.expect(IllegalStateException.class);
|
||||
this.thrown.expectMessage("Unable to return a single MockRestServiceServer since "
|
||||
+ "MockServerRestTemplateCustomizer has not been bound to a RestTemplate");
|
||||
this.customizer.getServer();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getServerWhenMultipleServersAreBoundShouldThrowException()
|
||||
throws Exception {
|
||||
this.customizer.customize(new RestTemplate());
|
||||
this.customizer.customize(new RestTemplate());
|
||||
this.thrown.expect(IllegalStateException.class);
|
||||
this.thrown.expectMessage("Unable to return a single MockRestServiceServer since "
|
||||
+ "MockServerRestTemplateCustomizer has been bound to more than one RestTemplate");
|
||||
this.customizer.getServer();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getServerWhenSingleServerIsBoundShouldReturnServer() throws Exception {
|
||||
RestTemplate template = new RestTemplate();
|
||||
this.customizer.customize(template);
|
||||
assertThat(this.customizer.getServer())
|
||||
.isEqualTo(this.customizer.getServer(template));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getServerWhenRestTemplateIsFoundShouldReturnServer() throws Exception {
|
||||
RestTemplate template1 = new RestTemplate();
|
||||
RestTemplate template2 = new RestTemplate();
|
||||
this.customizer.customize(template1);
|
||||
this.customizer.customize(template2);
|
||||
assertThat(this.customizer.getServer(template1)).isNotNull();
|
||||
assertThat(this.customizer.getServer(template2)).isNotNull()
|
||||
.isNotSameAs(this.customizer.getServer(template1));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getServerWhenRestTemplateIsNotFoundShouldReturnNull() throws Exception {
|
||||
RestTemplate template1 = new RestTemplate();
|
||||
RestTemplate template2 = new RestTemplate();
|
||||
this.customizer.customize(template1);
|
||||
assertThat(this.customizer.getServer(template1)).isNotNull();
|
||||
assertThat(this.customizer.getServer(template2)).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getServersShouldReturnServers() throws Exception {
|
||||
RestTemplate template1 = new RestTemplate();
|
||||
RestTemplate template2 = new RestTemplate();
|
||||
this.customizer.customize(template1);
|
||||
this.customizer.customize(template2);
|
||||
assertThat(this.customizer.getServers()).containsOnlyKeys(template1, template2);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getExpectationManagersShouldReturnExpectationManagers() throws Exception {
|
||||
RestTemplate template1 = new RestTemplate();
|
||||
RestTemplate template2 = new RestTemplate();
|
||||
this.customizer.customize(template1);
|
||||
this.customizer.customize(template2);
|
||||
RequestExpectationManager manager1 = this.customizer.getExpectationManagers()
|
||||
.get(template1);
|
||||
RequestExpectationManager manager2 = this.customizer.getExpectationManagers()
|
||||
.get(template2);
|
||||
assertThat(this.customizer.getServer(template1)).extracting("expectationManager")
|
||||
.containsOnly(manager1);
|
||||
assertThat(this.customizer.getServer(template2)).extracting("expectationManager")
|
||||
.containsOnly(manager2);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,195 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.test.web.client;
|
||||
|
||||
import java.net.URI;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.ExpectedException;
|
||||
import org.mockito.ArgumentCaptor;
|
||||
import org.mockito.Captor;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.MockitoAnnotations;
|
||||
|
||||
import org.springframework.boot.web.client.RestTemplateBuilder;
|
||||
import org.springframework.http.client.ClientHttpRequest;
|
||||
import org.springframework.http.client.support.HttpRequestWrapper;
|
||||
import org.springframework.test.web.client.ExpectedCount;
|
||||
import org.springframework.test.web.client.MockRestServiceServer;
|
||||
import org.springframework.test.web.client.RequestExpectationManager;
|
||||
import org.springframework.test.web.client.RequestMatcher;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Matchers.any;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
|
||||
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
|
||||
|
||||
/**
|
||||
* Tests for {@link RootUriRequestExpectationManager}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class RootUriRequestExpectationManagerTests {
|
||||
|
||||
@Rule
|
||||
public ExpectedException thrown = ExpectedException.none();
|
||||
|
||||
private String uri = "http://example.com";
|
||||
|
||||
@Mock
|
||||
private RequestExpectationManager delegate;
|
||||
|
||||
private RootUriRequestExpectationManager manager;
|
||||
|
||||
@Captor
|
||||
private ArgumentCaptor<ClientHttpRequest> requestCaptor;
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
MockitoAnnotations.initMocks(this);
|
||||
this.manager = new RootUriRequestExpectationManager(this.uri, this.delegate);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenRootUriIsNullShouldThrowException() throws Exception {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("RootUri must not be null");
|
||||
new RootUriRequestExpectationManager(null, this.delegate);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenExpectationManagerIsNullShouldThrowException()
|
||||
throws Exception {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("ExpectationManager must not be null");
|
||||
new RootUriRequestExpectationManager(this.uri, null);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void expectRequestShouldDelegateToExpecationManager() throws Exception {
|
||||
ExpectedCount count = mock(ExpectedCount.class);
|
||||
RequestMatcher requestMatcher = mock(RequestMatcher.class);
|
||||
this.manager.expectRequest(count, requestMatcher);
|
||||
verify(this.delegate).expectRequest(count, requestMatcher);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void validateRequestWhenUriDoesNotStartWithRootUriShouldDelegateToExpectationManager()
|
||||
throws Exception {
|
||||
ClientHttpRequest request = mock(ClientHttpRequest.class);
|
||||
given(request.getURI()).willReturn(new URI("http://spring.io/test"));
|
||||
this.manager.validateRequest(request);
|
||||
verify(this.delegate).validateRequest(request);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void validateRequestWhenUriStartsWithRootUriShouldReplaceUri()
|
||||
throws Exception {
|
||||
ClientHttpRequest request = mock(ClientHttpRequest.class);
|
||||
given(request.getURI()).willReturn(new URI(this.uri + "/hello"));
|
||||
this.manager.validateRequest(request);
|
||||
verify(this.delegate).validateRequest(this.requestCaptor.capture());
|
||||
HttpRequestWrapper actual = (HttpRequestWrapper) this.requestCaptor.getValue();
|
||||
assertThat(actual.getRequest()).isSameAs(request);
|
||||
assertThat(actual.getURI()).isEqualTo(new URI("/hello"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void validateRequestWhenRequestUriAssertionIsThrownShouldReplaceUriInMessage()
|
||||
throws Exception {
|
||||
ClientHttpRequest request = mock(ClientHttpRequest.class);
|
||||
given(request.getURI()).willReturn(new URI(this.uri + "/hello"));
|
||||
given(this.delegate.validateRequest((ClientHttpRequest) any()))
|
||||
.willThrow(new AssertionError(
|
||||
"Request URI expected:</hello> was:<http://example.com/bad>"));
|
||||
this.thrown.expect(AssertionError.class);
|
||||
this.thrown.expectMessage("Request URI expected:<http://example.com/hello>");
|
||||
this.manager.validateRequest(request);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void resetRequestShouldDelegateToExpecationManager() throws Exception {
|
||||
this.manager.reset();
|
||||
verify(this.delegate).reset();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void bindToShouldReturnMockResetServiceServer() throws Exception {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().build();
|
||||
MockRestServiceServer bound = RootUriRequestExpectationManager
|
||||
.bindTo(restTemplate);
|
||||
assertThat(bound).isNotNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void bindToWithExpectationManagerShouldReturnMockResetServiceServer()
|
||||
throws Exception {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().build();
|
||||
MockRestServiceServer bound = RootUriRequestExpectationManager
|
||||
.bindTo(restTemplate, this.delegate);
|
||||
assertThat(bound).isNotNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void forRestTemplateWhenUsingRootUriTemplateHandlerShouldReturnRootUriRequestExpectationManager()
|
||||
throws Exception {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().rootUri(this.uri).build();
|
||||
RequestExpectationManager actual = RootUriRequestExpectationManager
|
||||
.forRestTemplate(restTemplate, this.delegate);
|
||||
assertThat(actual).isInstanceOf(RootUriRequestExpectationManager.class);
|
||||
assertThat(actual).extracting("rootUri").containsExactly(this.uri);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void forRestTemplateWhenNotUsingRootUriTemplateHandlerShouldReturnOriginalUriRequestExpectationManager()
|
||||
throws Exception {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().build();
|
||||
RequestExpectationManager actual = RootUriRequestExpectationManager
|
||||
.forRestTemplate(restTemplate, this.delegate);
|
||||
assertThat(actual).isSameAs(this.delegate);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void boundRestTemplateShouldPrefixRootUri() {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder()
|
||||
.rootUri("http://example.com").build();
|
||||
MockRestServiceServer server = RootUriRequestExpectationManager
|
||||
.bindTo(restTemplate);
|
||||
server.expect(requestTo("/hello")).andRespond(withSuccess());
|
||||
restTemplate.getForEntity("/hello", String.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void boundRestTemplateWhenUrlIncludesDomainShouldNotPrefixRootUri() {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder()
|
||||
.rootUri("http://example.com").build();
|
||||
MockRestServiceServer server = RootUriRequestExpectationManager
|
||||
.bindTo(restTemplate);
|
||||
server.expect(requestTo("/hello")).andRespond(withSuccess());
|
||||
this.thrown.expect(AssertionError.class);
|
||||
this.thrown.expectMessage(
|
||||
"expected:<http://example.com/hello> but was:<http://spring.io/hello>");
|
||||
restTemplate.getForEntity("http://spring.io/hello", String.class);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user