Configure a RestClient.Builder with RestClientTest
This commit adds support for configuring a `RestClient.Builder` and `MockRestServiceServer` support for the `RestClient` when using `@RestClientTest` sliced tests. Closes gh-37033
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2012-2019 the original author or authors.
|
||||
* Copyright 2012-2023 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.
|
||||
@@ -25,20 +25,26 @@ import java.lang.annotation.Target;
|
||||
|
||||
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
|
||||
import org.springframework.boot.test.autoconfigure.properties.PropertyMapping;
|
||||
import org.springframework.boot.test.web.client.MockServerRestClientCustomizer;
|
||||
import org.springframework.boot.test.web.client.MockServerRestTemplateCustomizer;
|
||||
import org.springframework.boot.web.client.RestTemplateBuilder;
|
||||
import org.springframework.test.web.client.MockRestServiceServer;
|
||||
import org.springframework.web.client.RestClient;
|
||||
|
||||
/**
|
||||
* Annotation that can be applied to a test class to enable and configure
|
||||
* auto-configuration of a single {@link MockRestServiceServer}. Only useful when a single
|
||||
* call is made to {@link RestTemplateBuilder}. If multiple
|
||||
* {@link org.springframework.web.client.RestTemplate RestTemplates} are in use, inject
|
||||
* call is made to {@link RestTemplateBuilder} or {@link RestClient.Builder}. If multiple
|
||||
* {@link org.springframework.web.client.RestTemplate RestTemplates} or
|
||||
* {@link org.springframework.web.client.RestClient RestClients} are in use, inject a
|
||||
* {@link MockServerRestTemplateCustomizer} and use
|
||||
* {@link MockServerRestTemplateCustomizer#getServer(org.springframework.web.client.RestTemplate)
|
||||
* getServer(RestTemplate)} or bind a {@link MockRestServiceServer} directly.
|
||||
* getServer(RestTemplate)}, or inject a {@link MockServerRestClientCustomizer} and use
|
||||
* {@link MockServerRestClientCustomizer#getServer(org.springframework.web.client.RestClient.Builder)
|
||||
* * getServer(RestClient.Builder)}, or bind a {@link MockRestServiceServer} directly.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @author Scott Frederick
|
||||
* @since 1.4.0
|
||||
* @see MockServerRestTemplateCustomizer
|
||||
*/
|
||||
@@ -51,7 +57,8 @@ import org.springframework.test.web.client.MockRestServiceServer;
|
||||
public @interface AutoConfigureMockRestServiceServer {
|
||||
|
||||
/**
|
||||
* If {@link MockServerRestTemplateCustomizer} should be enabled and
|
||||
* If {@link MockServerRestTemplateCustomizer} and
|
||||
* {@link MockServerRestClientCustomizer} should be enabled and
|
||||
* {@link MockRestServiceServer} beans should be registered. Defaults to {@code true}
|
||||
* @return if mock support is enabled
|
||||
*/
|
||||
|
||||
@@ -19,10 +19,12 @@ package org.springframework.boot.test.autoconfigure.web.client;
|
||||
import java.io.IOException;
|
||||
import java.lang.reflect.Constructor;
|
||||
import java.time.Duration;
|
||||
import java.util.Collection;
|
||||
import java.util.Map;
|
||||
|
||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.test.web.client.MockServerRestClientCustomizer;
|
||||
import org.springframework.boot.test.web.client.MockServerRestTemplateCustomizer;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.http.client.ClientHttpRequest;
|
||||
@@ -33,12 +35,14 @@ import org.springframework.test.web.client.RequestExpectationManager;
|
||||
import org.springframework.test.web.client.RequestMatcher;
|
||||
import org.springframework.test.web.client.ResponseActions;
|
||||
import org.springframework.util.Assert;
|
||||
import org.springframework.web.client.RestClient;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
/**
|
||||
* Auto-configuration for {@link MockRestServiceServer} support.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @author Scott Frederick
|
||||
* @since 1.4.0
|
||||
* @see AutoConfigureMockRestServiceServer
|
||||
*/
|
||||
@@ -52,21 +56,29 @@ public class MockRestServiceServerAutoConfiguration {
|
||||
}
|
||||
|
||||
@Bean
|
||||
public MockRestServiceServer mockRestServiceServer(MockServerRestTemplateCustomizer customizer) {
|
||||
public MockServerRestClientCustomizer mockServerRestClientCustomizer() {
|
||||
return new MockServerRestClientCustomizer();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public MockRestServiceServer mockRestServiceServer(MockServerRestTemplateCustomizer restTemplateCustomizer,
|
||||
MockServerRestClientCustomizer restClientCustomizer) {
|
||||
try {
|
||||
return createDeferredMockRestServiceServer(customizer);
|
||||
return createDeferredMockRestServiceServer(restTemplateCustomizer, restClientCustomizer);
|
||||
}
|
||||
catch (Exception ex) {
|
||||
throw new IllegalStateException(ex);
|
||||
}
|
||||
}
|
||||
|
||||
private MockRestServiceServer createDeferredMockRestServiceServer(MockServerRestTemplateCustomizer customizer)
|
||||
throws Exception {
|
||||
private MockRestServiceServer createDeferredMockRestServiceServer(
|
||||
MockServerRestTemplateCustomizer restTemplateCustomizer,
|
||||
MockServerRestClientCustomizer restClientCustomizer) throws Exception {
|
||||
Constructor<MockRestServiceServer> constructor = MockRestServiceServer.class
|
||||
.getDeclaredConstructor(RequestExpectationManager.class);
|
||||
constructor.setAccessible(true);
|
||||
return constructor.newInstance(new DeferredRequestExpectationManager(customizer));
|
||||
return constructor
|
||||
.newInstance(new DeferredRequestExpectationManager(restTemplateCustomizer, restClientCustomizer));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -77,10 +89,14 @@ public class MockRestServiceServerAutoConfiguration {
|
||||
*/
|
||||
private static class DeferredRequestExpectationManager implements RequestExpectationManager {
|
||||
|
||||
private final MockServerRestTemplateCustomizer customizer;
|
||||
private final MockServerRestTemplateCustomizer restTemplateCustomizer;
|
||||
|
||||
DeferredRequestExpectationManager(MockServerRestTemplateCustomizer customizer) {
|
||||
this.customizer = customizer;
|
||||
private final MockServerRestClientCustomizer restClientCustomizer;
|
||||
|
||||
DeferredRequestExpectationManager(MockServerRestTemplateCustomizer restTemplateCustomizer,
|
||||
MockServerRestClientCustomizer restClientCustomizer) {
|
||||
this.restTemplateCustomizer = restTemplateCustomizer;
|
||||
this.restClientCustomizer = restClientCustomizer;
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -105,19 +121,34 @@ public class MockRestServiceServerAutoConfiguration {
|
||||
|
||||
@Override
|
||||
public void reset() {
|
||||
Map<RestTemplate, RequestExpectationManager> expectationManagers = this.customizer.getExpectationManagers();
|
||||
resetExpectations(this.restTemplateCustomizer.getExpectationManagers().values());
|
||||
resetExpectations(this.restClientCustomizer.getExpectationManagers().values());
|
||||
}
|
||||
|
||||
private void resetExpectations(Collection<RequestExpectationManager> expectationManagers) {
|
||||
if (expectationManagers.size() == 1) {
|
||||
getDelegate().reset();
|
||||
expectationManagers.iterator().next().reset();
|
||||
}
|
||||
}
|
||||
|
||||
private RequestExpectationManager getDelegate() {
|
||||
Map<RestTemplate, RequestExpectationManager> expectationManagers = this.customizer.getExpectationManagers();
|
||||
Assert.state(!expectationManagers.isEmpty(), "Unable to use auto-configured MockRestServiceServer since "
|
||||
+ "MockServerRestTemplateCustomizer has not been bound to a RestTemplate");
|
||||
Assert.state(expectationManagers.size() == 1, "Unable to use auto-configured MockRestServiceServer since "
|
||||
+ "MockServerRestTemplateCustomizer has been bound to more than one RestTemplate");
|
||||
return expectationManagers.values().iterator().next();
|
||||
Map<RestTemplate, RequestExpectationManager> restTemplateExpectationManagers = this.restTemplateCustomizer
|
||||
.getExpectationManagers();
|
||||
Map<RestClient.Builder, RequestExpectationManager> restClientExpectationManagers = this.restClientCustomizer
|
||||
.getExpectationManagers();
|
||||
Assert.state(!(restTemplateExpectationManagers.isEmpty() && restClientExpectationManagers.isEmpty()),
|
||||
"Unable to use auto-configured MockRestServiceServer since "
|
||||
+ "a mock server customizer has not been bound to a RestTemplate or RestClient");
|
||||
if (!restTemplateExpectationManagers.isEmpty()) {
|
||||
Assert.state(restTemplateExpectationManagers.size() == 1,
|
||||
"Unable to use auto-configured MockRestServiceServer since "
|
||||
+ "MockServerRestTemplateCustomizer has been bound to more than one RestTemplate");
|
||||
return restTemplateExpectationManagers.values().iterator().next();
|
||||
}
|
||||
Assert.state(restClientExpectationManagers.size() == 1,
|
||||
"Unable to use auto-configured MockRestServiceServer since "
|
||||
+ "MockServerRestClientCustomizer has been bound to more than one RestClient");
|
||||
return restClientExpectationManagers.values().iterator().next();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2012-2019 the original author or authors.
|
||||
* Copyright 2012-2023 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.
|
||||
@@ -38,11 +38,12 @@ import org.springframework.stereotype.Component;
|
||||
import org.springframework.test.context.BootstrapWith;
|
||||
import org.springframework.test.context.junit.jupiter.SpringExtension;
|
||||
import org.springframework.test.web.client.MockRestServiceServer;
|
||||
import org.springframework.web.client.RestClient;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
/**
|
||||
* Annotation for a Spring rest client test that focuses <strong>only</strong> on beans
|
||||
* that use {@link RestTemplateBuilder}.
|
||||
* that use {@link RestTemplateBuilder} or {@link RestClient.Builder}.
|
||||
* <p>
|
||||
* Using this annotation will disable full auto-configuration and instead apply only
|
||||
* configuration relevant to rest client tests (i.e. Jackson or GSON auto-configuration
|
||||
|
||||
@@ -6,4 +6,5 @@ org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration
|
||||
org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration
|
||||
org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration
|
||||
org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration
|
||||
org.springframework.boot.autoconfigure.web.client.RestClientAutoConfiguration
|
||||
org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration
|
||||
@@ -0,0 +1,48 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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
|
||||
*
|
||||
* https://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.autoconfigure.web.client;
|
||||
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.web.client.RestClient;
|
||||
import org.springframework.web.client.RestClient.Builder;
|
||||
|
||||
/**
|
||||
* A second example web client used with {@link RestClientTest @RestClientTest} tests.
|
||||
*
|
||||
* @author Scott Frederick
|
||||
*/
|
||||
@Service
|
||||
public class AnotherExampleRestClientService {
|
||||
|
||||
private final Builder builder;
|
||||
|
||||
private final RestClient restClient;
|
||||
|
||||
public AnotherExampleRestClientService(RestClient.Builder builder) {
|
||||
this.builder = builder;
|
||||
this.restClient = builder.baseUrl("https://example.com").build();
|
||||
}
|
||||
|
||||
protected Builder getRestClientBuilder() {
|
||||
return this.builder;
|
||||
}
|
||||
|
||||
public String test() {
|
||||
return this.restClient.get().uri("/test").retrieve().toEntity(String.class).getBody();
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2012-2020 the original author or authors.
|
||||
* Copyright 2012-2023 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.
|
||||
@@ -26,11 +26,11 @@ import org.springframework.web.client.RestTemplate;
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
@Service
|
||||
public class AnotherExampleRestClient {
|
||||
public class AnotherExampleRestTemplateService {
|
||||
|
||||
private final RestTemplate restTemplate;
|
||||
|
||||
public AnotherExampleRestClient(RestTemplateBuilder builder) {
|
||||
public AnotherExampleRestTemplateService(RestTemplateBuilder builder) {
|
||||
this.restTemplate = builder.rootUri("https://example.com").build();
|
||||
}
|
||||
|
||||
@@ -20,6 +20,7 @@ import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.test.web.client.MockServerRestClientCustomizer;
|
||||
import org.springframework.boot.test.web.client.MockServerRestTemplateCustomizer;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
|
||||
@@ -43,6 +44,8 @@ class AutoConfigureMockRestServiceServerEnabledFalseIntegrationTests {
|
||||
void mockServerRestTemplateCustomizerShouldNotBeRegistered() {
|
||||
assertThatExceptionOfType(NoSuchBeanDefinitionException.class)
|
||||
.isThrownBy(() -> this.applicationContext.getBean(MockServerRestTemplateCustomizer.class));
|
||||
assertThatExceptionOfType(NoSuchBeanDefinitionException.class)
|
||||
.isThrownBy(() -> this.applicationContext.getBean(MockServerRestClientCustomizer.class));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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
|
||||
*
|
||||
* https://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.autoconfigure.web.client;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.test.web.client.MockRestServiceServer;
|
||||
import org.springframework.web.client.RestClient;
|
||||
import org.springframework.web.client.RestClient.Builder;
|
||||
|
||||
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 AutoConfigureMockRestServiceServer @AutoConfigureMockRestServiceServer} with a
|
||||
* {@link RestClient} configured with a base URL.
|
||||
*
|
||||
* @author Scott Frederick
|
||||
*/
|
||||
@SpringBootTest
|
||||
@AutoConfigureMockRestServiceServer
|
||||
class AutoConfigureMockRestServiceServerWithRestClientIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private RestClient restClient;
|
||||
|
||||
@Autowired
|
||||
private MockRestServiceServer server;
|
||||
|
||||
@Test
|
||||
void mockServerExpectationsAreMatched() {
|
||||
this.server.expect(requestTo("/rest/test")).andRespond(withSuccess("hello", MediaType.TEXT_HTML));
|
||||
ResponseEntity<String> entity = this.restClient.get().uri("/test").retrieve().toEntity(String.class);
|
||||
assertThat(entity.getBody()).isEqualTo("hello");
|
||||
}
|
||||
|
||||
@EnableAutoConfiguration(exclude = CassandraAutoConfiguration.class)
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class RootUriConfiguration {
|
||||
|
||||
@Bean
|
||||
RestClient restClient(Builder restClientBuilder) {
|
||||
return restClientBuilder.baseUrl("/rest").build();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2012-2022 the original author or authors.
|
||||
* Copyright 2012-2023 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.
|
||||
@@ -44,7 +44,7 @@ import static org.springframework.test.web.client.response.MockRestResponseCreat
|
||||
*/
|
||||
@SpringBootTest
|
||||
@AutoConfigureMockRestServiceServer
|
||||
class AutoConfigureMockRestServiceServerWithRootUriIntegrationTests {
|
||||
class AutoConfigureMockRestServiceServerWithRestTemplateRootUriIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private RestTemplate restTemplate;
|
||||
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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
|
||||
*
|
||||
* https://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.autoconfigure.web.client;
|
||||
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.web.client.RestClient;
|
||||
import org.springframework.web.client.RestClient.Builder;
|
||||
|
||||
/**
|
||||
* Example web client using {@code RestClient} with {@link RestClientTest @RestClientTest}
|
||||
* tests.
|
||||
*
|
||||
* @author Scott Frederick
|
||||
*/
|
||||
@Service
|
||||
public class ExampleRestClientService {
|
||||
|
||||
private final Builder builder;
|
||||
|
||||
private final RestClient restClient;
|
||||
|
||||
public ExampleRestClientService(RestClient.Builder builder) {
|
||||
this.builder = builder;
|
||||
this.restClient = builder.baseUrl("https://example.com").build();
|
||||
}
|
||||
|
||||
protected Builder getRestClientBuilder() {
|
||||
return this.builder;
|
||||
}
|
||||
|
||||
public String test() {
|
||||
return this.restClient.get().uri("/test").retrieve().toEntity(String.class).getBody();
|
||||
}
|
||||
|
||||
public void testPostWithBody(String body) {
|
||||
this.restClient.post().uri("/test").body(body).retrieve().toBodilessEntity();
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2012-2022 the original author or authors.
|
||||
* Copyright 2012-2023 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.
|
||||
@@ -21,16 +21,17 @@ import org.springframework.stereotype.Service;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
/**
|
||||
* Example web client used with {@link RestClientTest @RestClientTest} tests.
|
||||
* Example web client using {@code RestTemplate} with
|
||||
* {@link RestClientTest @RestClientTest} tests.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
@Service
|
||||
public class ExampleRestClient {
|
||||
public class ExampleRestTemplateService {
|
||||
|
||||
private final RestTemplate restTemplate;
|
||||
|
||||
public ExampleRestClient(RestTemplateBuilder builder) {
|
||||
public ExampleRestTemplateService(RestTemplateBuilder builder) {
|
||||
this.restTemplate = builder.rootUri("https://example.com").build();
|
||||
}
|
||||
|
||||
@@ -50,7 +50,7 @@ class RestClientTestNoComponentIntegrationTests {
|
||||
@Test
|
||||
void exampleRestClientIsNotInjected() {
|
||||
assertThatExceptionOfType(NoSuchBeanDefinitionException.class)
|
||||
.isThrownBy(() -> this.applicationContext.getBean(ExampleRestClient.class));
|
||||
.isThrownBy(() -> this.applicationContext.getBean(ExampleRestTemplateService.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -61,7 +61,7 @@ class RestClientTestNoComponentIntegrationTests {
|
||||
|
||||
@Test
|
||||
void manuallyCreateBean() {
|
||||
ExampleRestClient client = new ExampleRestClient(this.restTemplateBuilder);
|
||||
ExampleRestTemplateService client = new ExampleRestTemplateService(this.restTemplateBuilder);
|
||||
this.server.expect(requestTo("/test")).andRespond(withSuccess("hello", MediaType.TEXT_HTML));
|
||||
assertThat(client.test()).isEqualTo("hello");
|
||||
}
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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
|
||||
*
|
||||
* https://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.autoconfigure.web.client;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.test.web.client.MockRestServiceServer;
|
||||
import org.springframework.web.client.RestClient;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.springframework.test.web.client.match.MockRestRequestMatchers.content;
|
||||
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
|
||||
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
|
||||
|
||||
/**
|
||||
* Tests for {@link RestClientTest @RestClientTest} with a {@link RestClient}.
|
||||
*
|
||||
* @author Scott Frederick
|
||||
*/
|
||||
@RestClientTest(ExampleRestClientService.class)
|
||||
class RestClientTestRestClientIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private MockRestServiceServer server;
|
||||
|
||||
@Autowired
|
||||
private ExampleRestClientService client;
|
||||
|
||||
@Test
|
||||
void mockServerCall1() {
|
||||
this.server.expect(requestTo(uri("/test"))).andRespond(withSuccess("1", MediaType.TEXT_HTML));
|
||||
assertThat(this.client.test()).isEqualTo("1");
|
||||
}
|
||||
|
||||
@Test
|
||||
void mockServerCall2() {
|
||||
this.server.expect(requestTo(uri("/test"))).andRespond(withSuccess("2", MediaType.TEXT_HTML));
|
||||
assertThat(this.client.test()).isEqualTo("2");
|
||||
}
|
||||
|
||||
@Test
|
||||
void mockServerCallWithContent() {
|
||||
this.server.expect(requestTo(uri("/test")))
|
||||
.andExpect(content().string("test"))
|
||||
.andRespond(withSuccess("1", MediaType.TEXT_HTML));
|
||||
this.client.testPostWithBody("test");
|
||||
}
|
||||
|
||||
private static String uri(String path) {
|
||||
return "https://example.com" + path;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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
|
||||
*
|
||||
* https://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.autoconfigure.web.client;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.test.web.client.MockServerRestClientCustomizer;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.test.web.client.MockRestServiceServer;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
|
||||
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
|
||||
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
|
||||
|
||||
/**
|
||||
* Tests for {@link RestClientTest @RestClientTest} with two {@code RestClient} clients.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @author Scott Frederick
|
||||
*/
|
||||
@RestClientTest({ ExampleRestClientService.class, AnotherExampleRestClientService.class })
|
||||
class RestClientTestRestClientTwoComponentsIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private ExampleRestClientService client1;
|
||||
|
||||
@Autowired
|
||||
private AnotherExampleRestClientService client2;
|
||||
|
||||
@Autowired
|
||||
private MockServerRestClientCustomizer customizer;
|
||||
|
||||
@Autowired
|
||||
private MockRestServiceServer server;
|
||||
|
||||
@Test
|
||||
void serverShouldNotWork() {
|
||||
assertThatIllegalStateException().isThrownBy(
|
||||
() -> this.server.expect(requestTo(uri("/test"))).andRespond(withSuccess("hello", MediaType.TEXT_HTML)))
|
||||
.withMessageContaining("Unable to use auto-configured");
|
||||
}
|
||||
|
||||
@Test
|
||||
void client1RestCallViaCustomizer() {
|
||||
this.customizer.getServer(this.client1.getRestClientBuilder())
|
||||
.expect(requestTo(uri("/test")))
|
||||
.andRespond(withSuccess("hello", MediaType.TEXT_HTML));
|
||||
assertThat(this.client1.test()).isEqualTo("hello");
|
||||
}
|
||||
|
||||
@Test
|
||||
void client2RestCallViaCustomizer() {
|
||||
this.customizer.getServer(this.client2.getRestClientBuilder())
|
||||
.expect(requestTo(uri("/test")))
|
||||
.andRespond(withSuccess("there", MediaType.TEXT_HTML));
|
||||
assertThat(this.client2.test()).isEqualTo("there");
|
||||
}
|
||||
|
||||
private static String uri(String path) {
|
||||
return "https://example.com" + path;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -32,14 +32,14 @@ import static org.springframework.test.web.client.response.MockRestResponseCreat
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
@RestClientTest(ExampleRestClient.class)
|
||||
class RestClientRestIntegrationTests {
|
||||
@RestClientTest(ExampleRestTemplateService.class)
|
||||
class RestClientTestRestTemplateIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private MockRestServiceServer server;
|
||||
|
||||
@Autowired
|
||||
private ExampleRestClient client;
|
||||
private ExampleRestTemplateService client;
|
||||
|
||||
@Test
|
||||
void mockServerCall1() {
|
||||
@@ -29,18 +29,18 @@ import static org.springframework.test.web.client.match.MockRestRequestMatchers.
|
||||
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
|
||||
|
||||
/**
|
||||
* Tests for {@link RestClientTest @RestClientTest} with two clients.
|
||||
* Tests for {@link RestClientTest @RestClientTest} with two {@code RestTemplate} clients.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
@RestClientTest({ ExampleRestClient.class, AnotherExampleRestClient.class })
|
||||
class RestClientTestTwoComponentsIntegrationTests {
|
||||
@RestClientTest({ ExampleRestTemplateService.class, AnotherExampleRestTemplateService.class })
|
||||
class RestClientTestRestTemplateTwoComponentsIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private ExampleRestClient client1;
|
||||
private ExampleRestTemplateService client1;
|
||||
|
||||
@Autowired
|
||||
private AnotherExampleRestClient client2;
|
||||
private AnotherExampleRestTemplateService client2;
|
||||
|
||||
@Autowired
|
||||
private MockServerRestTemplateCustomizer customizer;
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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
|
||||
*
|
||||
* https://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.autoconfigure.web.client;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.test.web.client.MockRestServiceServer;
|
||||
|
||||
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 RestClientTest @RestClientTest} with a single client using
|
||||
* {@code RestClient}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @author Scott Frederick
|
||||
*/
|
||||
@RestClientTest(ExampleRestClientService.class)
|
||||
class RestClientTestWithRestClientComponentIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private MockRestServiceServer server;
|
||||
|
||||
@Autowired
|
||||
private ExampleRestClientService client;
|
||||
|
||||
@Test
|
||||
void mockServerCall() {
|
||||
this.server.expect(requestTo("https://example.com/test")).andRespond(withSuccess("hello", MediaType.TEXT_HTML));
|
||||
assertThat(this.client.test()).isEqualTo("hello");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2012-2019 the original author or authors.
|
||||
* Copyright 2012-2023 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.
|
||||
@@ -27,18 +27,19 @@ import static org.springframework.test.web.client.match.MockRestRequestMatchers.
|
||||
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
|
||||
|
||||
/**
|
||||
* Tests for {@link RestClientTest @RestClientTest} with a single client.
|
||||
* Tests for {@link RestClientTest @RestClientTest} with a single client using
|
||||
* {@code RestTemplate}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
@RestClientTest(ExampleRestClient.class)
|
||||
class RestClientTestWithComponentIntegrationTests {
|
||||
@RestClientTest(ExampleRestTemplateService.class)
|
||||
class RestClientTestWithRestTemplateComponentIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private MockRestServiceServer server;
|
||||
|
||||
@Autowired
|
||||
private ExampleRestClient client;
|
||||
private ExampleRestTemplateService client;
|
||||
|
||||
@Test
|
||||
void mockServerCall() {
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2012-2019 the original author or authors.
|
||||
* Copyright 2012-2023 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.
|
||||
@@ -34,14 +34,14 @@ import static org.springframework.test.web.client.response.MockRestResponseCreat
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
@ClassPathExclusions("jackson-*.jar")
|
||||
@RestClientTest(ExampleRestClient.class)
|
||||
@RestClientTest(ExampleRestTemplateService.class)
|
||||
class RestClientTestWithoutJacksonIntegrationTests {
|
||||
|
||||
@Autowired
|
||||
private MockRestServiceServer server;
|
||||
|
||||
@Autowired
|
||||
private ExampleRestClient client;
|
||||
private ExampleRestTemplateService client;
|
||||
|
||||
@Test
|
||||
void restClientTestCanBeUsedWhenJacksonIsNotOnTheClassPath() {
|
||||
|
||||
Reference in New Issue
Block a user