diff --git a/spring-boot-actuator-docs/pom.xml b/spring-boot-actuator-docs/pom.xml index 3b2268d7403..d621f1a3d69 100644 --- a/spring-boot-actuator-docs/pom.xml +++ b/spring-boot-actuator-docs/pom.xml @@ -50,7 +50,7 @@ org.springframework.restdocs - spring-restdocs + spring-restdocs-mockmvc provided @@ -96,9 +96,6 @@ **/*Documentation.java - - ${project.build.directory}/generated-snippets - false diff --git a/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/EndpointDocumentation.java b/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/EndpointDocumentation.java index a11c2a36439..2528bf30b78 100644 --- a/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/EndpointDocumentation.java +++ b/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/EndpointDocumentation.java @@ -32,15 +32,16 @@ import java.util.Map; import javax.servlet.Filter; import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint; import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoints; import org.springframework.boot.test.SpringApplicationConfiguration; import org.springframework.http.MediaType; +import org.springframework.restdocs.RestDocumentation; import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.TestPropertySource; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; @@ -52,8 +53,8 @@ import org.springframework.test.web.servlet.setup.MockMvcBuilders; import org.springframework.util.StringUtils; import org.springframework.web.context.WebApplicationContext; -import static org.springframework.restdocs.RestDocumentation.document; -import static org.springframework.restdocs.RestDocumentation.documentationConfiguration; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -65,6 +66,12 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. @DirtiesContext public class EndpointDocumentation { + private static final String RESTDOCS_OUTPUT_DIR = "target/generated-snippets"; + + @Rule + public final RestDocumentation restDocumentation = new RestDocumentation( + RESTDOCS_OUTPUT_DIR); + @Autowired private WebApplicationContext context; @@ -82,18 +89,13 @@ public class EndpointDocumentation { @Autowired private TemplateEngine templates; - @Value("${org.springframework.restdocs.outputDir:${user.dir}/target/generated-snippets}") - private String restdocsOutputDir; - private MockMvc mockMvc; @Before public void setUp() { - System.setProperty("org.springframework.restdocs.outputDir", - this.restdocsOutputDir); this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context) .addFilters(this.metricFilter, this.traceFilter) - .apply(documentationConfiguration()).build(); + .apply(documentationConfiguration(this.restDocumentation)).build(); } @Test @@ -129,7 +131,7 @@ public class EndpointDocumentation { }); } } - File file = new File(this.restdocsOutputDir + "/endpoints.adoc"); + File file = new File(RESTDOCS_OUTPUT_DIR + "/endpoints.adoc"); file.getParentFile().mkdirs(); PrintWriter writer = new PrintWriter(file, "UTF-8"); try { diff --git a/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HealthEndpointDocumentation.java b/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HealthEndpointDocumentation.java index 66b1c59cc2d..12555d3e8a7 100644 --- a/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HealthEndpointDocumentation.java +++ b/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HealthEndpointDocumentation.java @@ -17,12 +17,13 @@ package org.springframework.boot.actuate.hypermedia; import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.test.SpringApplicationConfiguration; import org.springframework.http.MediaType; +import org.springframework.restdocs.RestDocumentation; import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.TestPropertySource; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; @@ -31,8 +32,8 @@ import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.setup.MockMvcBuilders; import org.springframework.web.context.WebApplicationContext; -import static org.springframework.restdocs.RestDocumentation.document; -import static org.springframework.restdocs.RestDocumentation.documentationConfiguration; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -44,20 +45,19 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. @DirtiesContext public class HealthEndpointDocumentation { + @Rule + public final RestDocumentation restDocumentation = new RestDocumentation( + "target/generated-snippets"); + @Autowired private WebApplicationContext context; - @Value("${org.springframework.restdocs.outputDir:target/generated-snippets}") - private String restdocsOutputDir; - private MockMvc mockMvc; @Before public void setUp() { - System.setProperty("org.springframework.restdocs.outputDir", - this.restdocsOutputDir); this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context) - .apply(documentationConfiguration()).build(); + .apply(documentationConfiguration(this.restDocumentation)).build(); } @Test diff --git a/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HypermediaEndpointDocumentation.java b/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HypermediaEndpointDocumentation.java index e6e6620f499..da731045fad 100644 --- a/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HypermediaEndpointDocumentation.java +++ b/spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HypermediaEndpointDocumentation.java @@ -17,12 +17,13 @@ package org.springframework.boot.actuate.hypermedia; import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.test.SpringApplicationConfiguration; import org.springframework.http.MediaType; +import org.springframework.restdocs.RestDocumentation; import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.TestPropertySource; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; @@ -31,8 +32,8 @@ import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.setup.MockMvcBuilders; import org.springframework.web.context.WebApplicationContext; -import static org.springframework.restdocs.RestDocumentation.document; -import static org.springframework.restdocs.RestDocumentation.documentationConfiguration; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document; +import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -43,20 +44,19 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. @DirtiesContext public class HypermediaEndpointDocumentation { + @Rule + public final RestDocumentation restDocumentation = new RestDocumentation( + "target/generated-snippets"); + @Autowired private WebApplicationContext context; - @Value("${org.springframework.restdocs.outputDir:target/generated-snippets}") - private String restdocsOutputDir; - private MockMvc mockMvc; @Before public void setUp() { - System.setProperty("org.springframework.restdocs.outputDir", - this.restdocsOutputDir); this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context) - .apply(documentationConfiguration()).build(); + .apply(documentationConfiguration(this.restDocumentation)).build(); } @Test diff --git a/spring-boot-parent/pom.xml b/spring-boot-parent/pom.xml index 319d2852ca7..1acbf278bce 100755 --- a/spring-boot-parent/pom.xml +++ b/spring-boot-parent/pom.xml @@ -23,7 +23,7 @@ UTF-8 UTF-8 3.1.1 - 1.0.0.M1 + 1.0.0.RC1 http://github.com/spring-projects/spring-boot @@ -199,7 +199,7 @@ org.springframework.restdocs - spring-restdocs + spring-restdocs-mockmvc ${spring-restdocs.version}