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 spring-projectsgh-6030

Author: philwebb

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/client/AutoConfigureMockRestServiceServer.java

@@ -0,0 +1,58 @@
+/*
+ * 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.autoconfigure.web.client;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+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.MockServerRestTemplateCustomizer;
+import org.springframework.boot.web.client.RestTemplateBuilder;
+import org.springframework.test.web.client.MockRestServiceServer;
+
+/**
+ * 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
+ * {@link MockServerRestTemplateCustomizer} and use
+ * {@link MockServerRestTemplateCustomizer#getServer(org.springframework.web.client.RestTemplate)
+ * getServer(RestTemplate)} or bind a {@link MockRestServiceServer} directly.
+ *
+ * @author Phillip Webb
+ * @since 1.4.0
+ * @see MockServerRestTemplateCustomizer
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@ImportAutoConfiguration
+@PropertyMapping("spring.test.webclient.mockrestserviceserver")
+public @interface AutoConfigureMockRestServiceServer {
+
+	/**
+	 * If {@link MockServerRestTemplateCustomizer} should be enabled and
+	 * {@link MockRestServiceServer} beans should be registered. Defaults to {@code true}
+	 * @return if mock support is enabled
+	 */
+	boolean enabled() default true;
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/client/AutoConfigureWebClient.java

@@ -0,0 +1,52 @@
+/*
+ * 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.autoconfigure.web.client;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
+import org.springframework.boot.test.autoconfigure.properties.PropertyMapping;
+import org.springframework.boot.web.client.RestTemplateBuilder;
+import org.springframework.web.client.RestTemplate;
+
+/**
+ * Annotation that can be applied to a test class to enable and configure
+ * auto-configuration of web clients.
+ *
+ * @author Stephane Nicoll
+ * @author Phillip Webb
+ * @since 1.4.0
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@ImportAutoConfiguration
+@PropertyMapping("spring.test.webclient")
+public @interface AutoConfigureWebClient {
+
+	/**
+	 * If a {@link RestTemplate} bean should be registered. Defaults to {@code false} with
+	 * the assumption that the {@link RestTemplateBuilder} will be used.
+	 * @return if a {@link RestTemplate} bean should be added.
+	 */
+	boolean registerRestTemplate() default false;
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/client/MockRestServiceServerAutoConfiguration.java

@@ -0,0 +1,128 @@
+/*
+ * 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.autoconfigure.web.client;
+
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.util.Map;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.test.web.client.MockServerRestTemplateCustomizer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.client.ClientHttpRequest;
+import org.springframework.http.client.ClientHttpResponse;
+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.test.web.client.ResponseActions;
+import org.springframework.util.Assert;
+import org.springframework.web.client.RestTemplate;
+
+/**
+ * Auto-configuration for {@link MockRestServiceServer} support.
+ *
+ * @author Phillip Webb
+ * @see AutoConfigureMockRestServiceServer
+ */
+@Configuration
+@ConditionalOnProperty(prefix = "spring.test.webclient.mockrestserviceserver", name = "enabled")
+class MockRestServiceServerAutoConfiguration {
+
+	@Bean
+	public MockServerRestTemplateCustomizer mockServerRestTemplateCustomizer() {
+		return new MockServerRestTemplateCustomizer();
+	}
+
+	@Bean
+	public MockRestServiceServer mockRestServiceServer(
+			MockServerRestTemplateCustomizer customizer) {
+		try {
+			return createDeferredMockRestServiceServer(customizer);
+		}
+		catch (Exception ex) {
+			throw new IllegalStateException(ex);
+		}
+	}
+
+	private MockRestServiceServer createDeferredMockRestServiceServer(
+			MockServerRestTemplateCustomizer customizer) throws Exception {
+		Constructor<MockRestServiceServer> constructor = MockRestServiceServer.class
+				.getDeclaredConstructor(RequestExpectationManager.class);
+		constructor.setAccessible(true);
+		return constructor.newInstance(new DeferredRequestExpectationManager(customizer));
+	}
+
+	/**
+	 * {@link RequestExpectationManager} with the injected {@link MockRestServiceServer}
+	 * so that the bean can be created before the
+	 * {@link MockServerRestTemplateCustomizer#customize(RestTemplate)
+	 * MockServerRestTemplateCustomizer} has been called.
+	 */
+	private static class DeferredRequestExpectationManager
+			implements RequestExpectationManager {
+
+		private MockServerRestTemplateCustomizer customizer;
+
+		DeferredRequestExpectationManager(MockServerRestTemplateCustomizer customizer) {
+			this.customizer = customizer;
+		}
+
+		@Override
+		public ResponseActions expectRequest(ExpectedCount count,
+				RequestMatcher requestMatcher) {
+			return getDelegate().expectRequest(count, requestMatcher);
+		}
+
+		@Override
+		public ClientHttpResponse validateRequest(ClientHttpRequest request)
+				throws IOException {
+			return getDelegate().validateRequest(request);
+		}
+
+		@Override
+		public void verify() {
+			getDelegate().verify();
+		}
+
+		@Override
+		public void reset() {
+			Map<RestTemplate, RequestExpectationManager> expectationManagers = this.customizer
+					.getExpectationManagers();
+			if (expectationManagers.size() == 1) {
+				getDelegate().reset();
+			}
+		}
+
+		private RequestExpectationManager getDelegate() {
+			Map<RestTemplate, RequestExpectationManager> expectationManagers = this.customizer
+					.getExpectationManagers();
+			Assert.state(expectationManagers.size() > 0,
+					"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();
+		}
+
+	}
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/client/MockRestServiceServerResetTestExecutionListener.java

@@ -0,0 +1,43 @@
+/*
+ * 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.autoconfigure.web.client;
+
+import org.springframework.context.ApplicationContext;
+import org.springframework.test.context.TestContext;
+import org.springframework.test.context.TestExecutionListener;
+import org.springframework.test.context.support.AbstractTestExecutionListener;
+import org.springframework.test.web.client.MockRestServiceServer;
+
+/**
+ * {@link TestExecutionListener} to reset {@link MockRestServiceServer} beans.
+ *
+ * @author Phillip Webb
+ */
+class MockRestServiceServerResetTestExecutionListener
+		extends AbstractTestExecutionListener {
+
+	@Override
+	public void afterTestMethod(TestContext testContext) throws Exception {
+		ApplicationContext applicationContext = testContext.getApplicationContext();
+		String[] names = applicationContext
+				.getBeanNamesForType(MockRestServiceServer.class, false, false);
+		for (String name : names) {
+			applicationContext.getBean(name, MockRestServiceServer.class).reset();
+		}
+	}
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/client/RestClientExcludeFilter.java

@@ -0,0 +1,97 @@
+/*
+ * 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.autoconfigure.web.client;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.Set;
+
+import com.fasterxml.jackson.databind.Module;
+
+import org.springframework.boot.context.TypeExcludeFilter;
+import org.springframework.boot.jackson.JsonComponent;
+import org.springframework.boot.test.autoconfigure.filter.AnnotationCustomizableTypeExcludeFilter;
+import org.springframework.context.annotation.ComponentScan.Filter;
+import org.springframework.core.annotation.AnnotatedElementUtils;
+import org.springframework.core.type.classreading.MetadataReader;
+import org.springframework.core.type.classreading.MetadataReaderFactory;
+
+/**
+ * {@link TypeExcludeFilter} for {@link RestClientTest @RestClientTest}.
+ *
+ * @author Stephane Nicoll
+ */
+class RestClientExcludeFilter extends AnnotationCustomizableTypeExcludeFilter {
+
+	private static final Set<Class<?>> DEFAULT_INCLUDES;
+
+	static {
+		Set<Class<?>> includes = new LinkedHashSet<Class<?>>();
+		includes.add(Module.class);
+		includes.add(JsonComponent.class);
+		DEFAULT_INCLUDES = Collections.unmodifiableSet(includes);
+	}
+
+	private final RestClientTest annotation;
+
+	RestClientExcludeFilter(Class<?> testClass) {
+		this.annotation = AnnotatedElementUtils.getMergedAnnotation(testClass,
+				RestClientTest.class);
+	}
+
+	@Override
+	protected boolean defaultInclude(MetadataReader metadataReader,
+			MetadataReaderFactory metadataReaderFactory) throws IOException {
+		if (super.defaultInclude(metadataReader, metadataReaderFactory)) {
+			return true;
+		}
+		for (Class<?> controller : this.annotation.components()) {
+			if (isTypeOrAnnotated(metadataReader, metadataReaderFactory, controller)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	@Override
+	protected boolean hasAnnotation() {
+		return this.annotation != null;
+	}
+
+	@Override
+	protected Filter[] getFilters(FilterType type) {
+		switch (type) {
+		case INCLUDE:
+			return this.annotation.includeFilters();
+		case EXCLUDE:
+			return this.annotation.excludeFilters();
+		}
+		throw new IllegalStateException("Unsupported type " + type);
+	}
+
+	@Override
+	protected boolean isUseDefaultFilters() {
+		return this.annotation.useDefaultFilters();
+	}
+
+	@Override
+	protected Set<Class<?>> getDefaultIncludes() {
+		return DEFAULT_INCLUDES;
+	}
+
+}