Provide test auto-configuration for Spring REST Docs

This commit introduces a new annotation, @AutoConfigureRestDocs,
which can be used to enable auto-configuration of Spring REST Docs.
The auto-configuration removes the need to use Spring REST Docs' JUnit
rule and will automatically configure MockMvc. Combined with the new
auto-configuration for MockMvc it allows a test class to be free of
boilerplate configuration:

@RunWith(SpringRunner.class)
@WebMvcTest
@AutoConfigureRestDocs(outputDir = "target/generated-snippets",
        uriScheme = "https", uriHost = "api.example.com",
        uriPort = 443)
public class ExampleDocumentationTests {

    @Autowired
    private MockMvc mvc;

    @Test
    public void documentIndex() {
        // …
    }

}

For more advanced customization a RestDocsMockMvcConfigurationCustomizer
bean can be used.

If a RestDocumentationResultHandler is found in the context, it will
be passed to the ConfigurableMockMvcBuilder's alwaysDo method as part
of its customization.

Closes gh-5563

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/AutoConfigureRestDocs.java

@@ -0,0 +1,81 @@
+/*
+ * 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.restdocs;
+
+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.context.annotation.Import;
+
+/**
+ * Annotation that can be applied to a test class to enable and configure
+ * auto-configuration of Spring REST Docs. Allows configuration of the output directory
+ * and the host, scheme, and port of generated URIs. When further configuration is
+ * required a {@link RestDocsMockMvcConfigurationCustomizer} bean can be used.
+ *
+ * @author Andy Wilkinson
+ * @since 1.4.0
+ * @see RestDocsAutoConfiguration
+ * @see RestDocsMockMvcConfigurationCustomizer
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@ImportAutoConfiguration(RestDocsAutoConfiguration.class)
+@Import(RestDocumentationContextProviderRegistrar.class)
+@PropertyMapping("spring.test.restdocs")
+public @interface AutoConfigureRestDocs {
+
+	/**
+	 * The output directory to which generated snippets will be written. A synonym for
+	 * {@link #outputDir}.
+	 * @return the output directory
+	 */
+	String value() default "";
+
+	/**
+	 * The output directory to which generated snippets will be written. A synonym for
+	 * {@link #value}.
+	 * @return the output directory
+	 */
+	String outputDir() default "";
+
+	/**
+	 * The scheme (typically {@code http} or {@code https}) to be used in documented URIs.
+	 * Defaults to {@code http}.
+	 * @return the scheme
+	 */
+	String uriScheme() default "http";
+
+	/**
+	 * The host to be used in documented URIs. Defaults to {@code localhost}.
+	 * @return the host
+	 */
+	String uriHost() default "localhost";
+
+	/**
+	 * The port to be used in documented URIs. Defaults to {@code 8080}.
+	 * @return the port
+	 */
+	int uriPort() default 8080;
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsAutoConfiguration.java

@@ -0,0 +1,66 @@
+/*
+ * 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.restdocs;
+
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.restdocs.RestDocumentationContextProvider;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer;
+import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for Spring REST Docs.
+ *
+ * @author Andy Wilkinson
+ */
+@Configuration
+@ConditionalOnWebApplication
+@EnableConfigurationProperties
+class RestDocsAutoConfiguration {
+
+	@Bean
+	@ConditionalOnMissingBean(MockMvcRestDocumentationConfigurer.class)
+	public MockMvcRestDocumentationConfigurer restDocsMockMvcConfigurer(
+			ObjectProvider<RestDocsMockMvcConfigurationCustomizer> configurationCustomizerProvider,
+			RestDocumentationContextProvider contextProvider) {
+		MockMvcRestDocumentationConfigurer configurer = MockMvcRestDocumentation
+				.documentationConfiguration(contextProvider);
+		RestDocsMockMvcConfigurationCustomizer configurationCustomizer = configurationCustomizerProvider
+				.getIfAvailable();
+		if (configurationCustomizer != null) {
+			configurationCustomizer.customize(configurer);
+		}
+		return configurer;
+	}
+
+	@Bean
+	@ConfigurationProperties("spring.test.restdocs")
+	public RestDocsMockMvcBuilderCustomizer restDocumentationConfigurer(
+			MockMvcRestDocumentationConfigurer configurer,
+			ObjectProvider<RestDocumentationResultHandler> resultHandler) {
+		return new RestDocsMockMvcBuilderCustomizer(configurer,
+				resultHandler.getIfAvailable());
+	}
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsMockMvcBuilderCustomizer.java

@@ -0,0 +1,95 @@
+/*
+ * 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.restdocs;
+
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.boot.test.autoconfigure.web.servlet.MockMvcBuilderCustomizer;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer;
+import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;
+import org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder;
+import org.springframework.util.StringUtils;
+
+/**
+ * A {@link MockMvcBuilderCustomizer} that configures Spring REST Docs.
+ *
+ * @author Andy Wilkinson
+ */
+class RestDocsMockMvcBuilderCustomizer
+		implements InitializingBean, MockMvcBuilderCustomizer {
+
+	private final MockMvcRestDocumentationConfigurer delegate;
+
+	private final RestDocumentationResultHandler resultHandler;
+
+	private String uriScheme;
+
+	private String uriHost;
+
+	private Integer uriPort;
+
+	RestDocsMockMvcBuilderCustomizer(MockMvcRestDocumentationConfigurer delegate,
+			RestDocumentationResultHandler resultHandler) {
+		this.delegate = delegate;
+		this.resultHandler = resultHandler;
+	}
+
+	public String getUriScheme() {
+		return this.uriScheme;
+	}
+
+	public void setUriScheme(String uriScheme) {
+		this.uriScheme = uriScheme;
+	}
+
+	public String getUriHost() {
+		return this.uriHost;
+	}
+
+	public void setUriHost(String uriHost) {
+		this.uriHost = uriHost;
+	}
+
+	public Integer getUriPort() {
+		return this.uriPort;
+	}
+
+	public void setUriPort(Integer uriPort) {
+		this.uriPort = uriPort;
+	}
+
+	@Override
+	public void afterPropertiesSet() throws Exception {
+		if (StringUtils.hasText(this.uriScheme)) {
+			this.delegate.uris().withScheme(this.uriScheme);
+		}
+		if (StringUtils.hasText(this.uriHost)) {
+			this.delegate.uris().withHost(this.uriHost);
+		}
+		if (this.uriPort != null) {
+			this.delegate.uris().withPort(this.uriPort);
+		}
+	}
+
+	@Override
+	public void customize(ConfigurableMockMvcBuilder<?> builder) {
+		builder.apply(this.delegate);
+		if (this.resultHandler != null) {
+			builder.alwaysDo(this.resultHandler);
+		}
+	}
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsMockMvcConfigurationCustomizer.java

@@ -0,0 +1,40 @@
+/*
+ * 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.restdocs;
+
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer;
+
+/**
+ * A customizer for {@link MockMvcRestDocumentationConfigurer}. If a
+ * {@code RestDocsMockMvcConfigurationCustomizer} bean is found in the application context
+ * it will be {@link #customize called} to customize the
+ * {@code MockMvcRestDocumentationConfigurer} before it is applied. Intended for use only
+ * when the attributes on {@link AutoConfigureRestDocs} do not provide sufficient
+ * customization.
+ *
+ * @author Andy Wilkinson
+ * @since 1.4.0
+ */
+public interface RestDocsMockMvcConfigurationCustomizer {
+
+	/**
+	 * Customize the given {@configurer}.
+	 * @param configurer the configurer
+	 */
+	void customize(MockMvcRestDocumentationConfigurer configurer);
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsTestExecutionListener.java

@@ -0,0 +1,87 @@
+/*
+ * 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.restdocs;
+
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.restdocs.ManualRestDocumentation;
+import org.springframework.test.context.TestContext;
+import org.springframework.test.context.TestExecutionListener;
+import org.springframework.test.context.support.AbstractTestExecutionListener;
+import org.springframework.util.ClassUtils;
+
+/**
+ * A {@link TestExecutionListener} for Spring REST Docs that removes the need for a
+ * <code>@Rule</code> when using JUnit or manual before and after test calls when using
+ * TestNG.
+ *
+ * @author Andy Wilkinson
+ * @since 1.4.0
+ */
+public class RestDocsTestExecutionListener extends AbstractTestExecutionListener {
+
+	private static final String REST_DOCS_CLASS = "org.springframework.restdocs.ManualRestDocumentation";
+
+	@Override
+	public void beforeTestMethod(TestContext testContext) throws Exception {
+		if (restDocsIsPresent()) {
+			new DocumentationHandler().beforeTestMethod(testContext);
+		}
+	}
+
+	@Override
+	public void afterTestMethod(TestContext testContext) throws Exception {
+		if (restDocsIsPresent()) {
+			new DocumentationHandler().afterTestMethod(testContext);
+		}
+	}
+
+	private boolean restDocsIsPresent() {
+		return ClassUtils.isPresent(REST_DOCS_CLASS, getClass().getClassLoader());
+	}
+
+	private static class DocumentationHandler {
+
+		private void beforeTestMethod(TestContext testContext) throws Exception {
+			ManualRestDocumentation restDocumentation = findManualRestDocumentation(
+					testContext);
+			if (restDocumentation != null) {
+				restDocumentation.beforeTest(testContext.getTestClass(),
+						testContext.getTestMethod().getName());
+			}
+		}
+
+		private void afterTestMethod(TestContext testContext) {
+			ManualRestDocumentation restDocumentation = findManualRestDocumentation(
+					testContext);
+			if (restDocumentation != null) {
+				restDocumentation.afterTest();
+			}
+		}
+
+		private ManualRestDocumentation findManualRestDocumentation(
+				TestContext testContext) {
+			try {
+				return testContext.getApplicationContext()
+						.getBean(ManualRestDocumentation.class);
+			}
+			catch (NoSuchBeanDefinitionException ex) {
+				return null;
+			}
+		}
+	}
+
+}

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocumentationContextProviderRegistrar.java

@@ -0,0 +1,61 @@
+/*
+ * 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.restdocs;
+
+import java.util.Map;
+
+import org.springframework.beans.factory.support.AbstractBeanDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
+import org.springframework.core.type.AnnotationMetadata;
+import org.springframework.restdocs.ManualRestDocumentation;
+import org.springframework.util.StringUtils;
+
+/**
+ * {@link ImportBeanDefinitionRegistrar} used by {@link AutoConfigureRestDocs}.
+ *
+ * @author Andy Wilkinson
+ */
+class RestDocumentationContextProviderRegistrar implements ImportBeanDefinitionRegistrar {
+
+	@Override
+	public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
+			BeanDefinitionRegistry registry) {
+		AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder
+				.genericBeanDefinition(ManualRestDocumentation.class)
+				.addConstructorArgValue(determineOutputDir(importingClassMetadata))
+				.getBeanDefinition();
+		registry.registerBeanDefinition(ManualRestDocumentation.class.getName(),
+				beanDefinition);
+	}
+
+	private String determineOutputDir(AnnotationMetadata annotationMetadata) {
+		Map<String, Object> annotationAttributes = annotationMetadata
+				.getAnnotationAttributes(AutoConfigureRestDocs.class.getName());
+		String outputDir = (String) annotationAttributes.get("outputDir");
+		if (!StringUtils.hasText(outputDir)) {
+			outputDir = (String) annotationAttributes.get("value");
+			if (!StringUtils.hasText(outputDir)) {
+				throw new IllegalStateException(
+						"Either value or outputDir must be specified on @AutoConfigureRestDocs");
+			}
+		}
+		return outputDir;
+	}
+
+}

spring-boot-test-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -7,4 +7,5 @@ org.springframework.boot.test.autoconfigure.properties.PropertyMappingContextCus
 # Test Execution Listeners
 org.springframework.test.context.TestExecutionListener=\
 org.springframework.boot.test.autoconfigure.AutoConfigureReportTestExecutionListener,\
-org.springframework.boot.test.autoconfigure.json.JsonTesterInitializationTestExecutionListener
+org.springframework.boot.test.autoconfigure.json.JsonTesterInitializationTestExecutionListener,\
+org.springframework.boot.test.autoconfigure.restdocs.RestDocsTestExecutionListener

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/ContentContainingCondition.java

@@ -0,0 +1,67 @@
+/*
+ * 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.restdocs;
+
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.io.Reader;
+
+import org.assertj.core.api.Condition;
+import org.assertj.core.description.TextDescription;
+
+import org.springframework.util.FileCopyUtils;
+
+/**
+ * A {@link Condition} to assert that a file's contents contain a given string.
+ *
+ * @author Andy Wilkinson
+ */
+class ContentContainingCondition extends Condition<File> {
+
+	private final String toContain;
+
+	ContentContainingCondition(String toContain) {
+		super(new TextDescription("content containing %s", toContain));
+		this.toContain = toContain;
+	}
+
+	@Override
+	public boolean matches(File value) {
+		Reader reader = null;
+		try {
+			reader = new FileReader(value);
+			String content = FileCopyUtils.copyToString(new FileReader(value));
+			System.out.println(content);
+			return content.contains(this.toContain);
+		}
+		catch (IOException ex) {
+			throw new IllegalStateException(ex);
+		}
+		finally {
+			if (reader != null) {
+				try {
+					reader.close();
+				}
+				catch (IOException ex) {
+					// Ignore
+				}
+			}
+		}
+	}
+
+}

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsAutoConfigurationAdvancedConfigurationIntegrationTests.java

@@ -0,0 +1,95 @@
+/*
+ * 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.restdocs;
+
+import java.io.File;
+
+import org.assertj.core.api.Condition;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
+import org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer;
+import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;
+import org.springframework.restdocs.templates.TemplateFormats;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.util.FileSystemUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+
+/**
+ * @author Andy Wilkinson
+ */
+@RunWith(SpringRunner.class)
+@WebMvcTest(RestDocsTestController.class)
+@AutoConfigureRestDocs(outputDir = "target/generated-snippets")
+public class RestDocsAutoConfigurationAdvancedConfigurationIntegrationTests {
+
+	@Before
+	public void deleteSnippets() {
+		FileSystemUtils.deleteRecursively(new File("target/generated-snippets"));
+	}
+
+	@Autowired
+	private MockMvc mvc;
+
+	@Autowired
+	private RestDocumentationResultHandler document;
+
+	@Test
+	public void snippetGeneration() throws Exception {
+		this.document.snippets(links(
+				linkWithRel("self").description("Canonical location of this resource")));
+		this.mvc.perform(get("/"));
+		File defaultSnippetsDir = new File(
+				"target/generated-snippets/snippet-generation");
+		assertThat(defaultSnippetsDir).exists();
+		assertThat(new File(defaultSnippetsDir, "curl-request.md"))
+				.has(contentContaining("'http://localhost:8080/'"));
+		assertThat(new File(defaultSnippetsDir, "links.md")).isFile();
+	}
+
+	private Condition<File> contentContaining(String toContain) {
+		return new ContentContainingCondition(toContain);
+	}
+
+	@TestConfiguration
+	public static class CustomizationConfiguration
+			implements RestDocsMockMvcConfigurationCustomizer {
+
+		@Bean
+		public RestDocumentationResultHandler restDocumentation() {
+			return MockMvcRestDocumentation.document("{method-name}");
+		}
+
+		@Override
+		public void customize(MockMvcRestDocumentationConfigurer configurer) {
+			configurer.snippets().withTemplateFormat(TemplateFormats.markdown());
+		}
+
+	}
+
+}

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsAutoConfigurationIntegrationTests.java

@@ -0,0 +1,70 @@
+/*
+ * 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.restdocs;
+
+import java.io.File;
+
+import org.assertj.core.api.Condition;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.util.FileSystemUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+
+/**
+ * Tests for {@link RestDocsAutoConfiguration}.
+ *
+ * @author Andy Wilkinson
+ */
+@RunWith(SpringRunner.class)
+@WebMvcTest
+@AutoConfigureRestDocs(outputDir = "target/generated-snippets", uriScheme = "https", uriHost = "api.example.com", uriPort = 443)
+public class RestDocsAutoConfigurationIntegrationTests {
+
+	@Before
+	public void deleteSnippets() {
+		FileSystemUtils.deleteRecursively(new File("target/generated-snippets"));
+	}
+
+	@Autowired
+	private MockMvc mvc;
+
+	@Test
+	public void defaultSnippetsAreWritten() throws Exception {
+		this.mvc.perform(get("/")).andDo(document("default-snippets"));
+		File defaultSnippetsDir = new File("target/generated-snippets/default-snippets");
+		assertThat(defaultSnippetsDir).exists();
+		assertThat(new File(defaultSnippetsDir, "curl-request.adoc"))
+				.has(contentContaining("'https://api.example.com/'"));
+		assertThat(new File(defaultSnippetsDir, "http-request.adoc"))
+				.has(contentContaining("api.example.com"));
+		assertThat(new File(defaultSnippetsDir, "http-response.adoc")).isFile();
+	}
+
+	private Condition<File> contentContaining(String toContain) {
+		return new ContentContainingCondition(toContain);
+	}
+
+}

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsTestApplication.java

@@ -0,0 +1,29 @@
+/*
+ * 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.restdocs;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Test application used with {@link AutoConfigureRestDocs} tests.
+ *
+ * @author Andy Wilkinson
+ */
+@SpringBootApplication
+public class RestDocsTestApplication {
+
+}

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsTestController.java

@@ -0,0 +1,41 @@
+/*
+ * 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.restdocs;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.springframework.hateoas.MediaTypes;
+import org.springframework.hateoas.mvc.ControllerLinkBuilder;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class RestDocsTestController {
+
+	@ResponseBody
+	@RequestMapping(path = "/", produces = MediaTypes.HAL_JSON_VALUE)
+	public Map<String, Object> index() {
+		Map<String, Object> response = new HashMap<String, Object>();
+		Map<String, String> links = new HashMap<String, String>();
+		links.put("self", ControllerLinkBuilder.linkTo(getClass()).toUri().toString());
+		response.put("_links", links);
+		return response;
+	}
+
+}