Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Introduce constants for common attribute names

Browse Source 
Closes gh-193
This commit is contained in:
Andy Wilkinson
2016-02-05 20:57:46 +00:00
parent 6df01419cd
commit 83b72f7962
14 changed files with 89 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/MockMvcRestDocumentationConfigurer.java
View File

@@ -23,6 +23,7 @@ import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.restdocs.RestDocumentation;
import org.springframework.restdocs.RestDocumentationContext;
import org.springframework.restdocs.config.RestDocumentationConfigurer;
import org.springframework.restdocs.generate.RestDocumentationGenerator;
import org.springframework.test.web.servlet.request.RequestPostProcessor;
import org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder;
import org.springframework.test.web.servlet.setup.MockMvcConfigurer;
@@ -90,11 +91,12 @@ public class MockMvcRestDocumentationConfigurer
RestDocumentationContext context = this.restDocumentation.beforeOperation();
Map<String, Object> configuration = new HashMap<>();
configuration.put(MockHttpServletRequest.class.getName(), request);
String urlTemplateAttribute = "org.springframework.restdocs.urlTemplate";
configuration.put(urlTemplateAttribute,
request.getAttribute(urlTemplateAttribute));
configuration
.put(RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE,
request.getAttribute(RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE));
configuration.put(RestDocumentationContext.class.getName(), context);
request.setAttribute("org.springframework.restdocs.configuration",
request.setAttribute(
RestDocumentationResultHandler.ATTRIBUTE_NAME_CONFIGURATION,
configuration);
MockMvcRestDocumentationConfigurer.this.apply(configuration, context);
MockMvcRestDocumentationConfigurer.this.uriConfigurer.apply(configuration,

23
spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationRequestBuilders.java
View File

@@ -19,6 +19,7 @@ package org.springframework.restdocs.mockmvc;
import java.net.URI;
import org.springframework.http.HttpMethod;
import org.springframework.restdocs.generate.RestDocumentationGenerator;
import org.springframework.restdocs.request.RequestDocumentation;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
import org.springframework.test.web.servlet.request.MockMultipartHttpServletRequestBuilder;
@@ -38,8 +39,6 @@ import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
*/
public abstract class RestDocumentationRequestBuilders {
private static final String ATTRIBUTE_NAME_URL_TEMPLATE = "org.springframework.restdocs.urlTemplate";
private RestDocumentationRequestBuilders() {
}
@@ -55,7 +54,7 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder get(String urlTemplate,
Object... urlVariables) {
return MockMvcRequestBuilders.get(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
}
/**
@@ -79,7 +78,7 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder post(String urlTemplate,
Object... urlVariables) {
return MockMvcRequestBuilders.post(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
}
/**
@@ -103,7 +102,7 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder put(String urlTemplate,
Object... urlVariables) {
return MockMvcRequestBuilders.put(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
}
/**
@@ -127,7 +126,7 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder patch(String urlTemplate,
Object... urlVariables) {
return MockMvcRequestBuilders.patch(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
}
/**
@@ -151,7 +150,7 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder delete(String urlTemplate,
Object... urlVariables) {
return MockMvcRequestBuilders.delete(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
}
/**
@@ -175,7 +174,7 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder options(String urlTemplate,
Object... urlVariables) {
return MockMvcRequestBuilders.options(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
}
/**
@@ -199,7 +198,7 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder head(String urlTemplate,
Object... urlVariables) {
return MockMvcRequestBuilders.head(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
}
/**
@@ -224,7 +223,8 @@ public abstract class RestDocumentationRequestBuilders {
public static MockHttpServletRequestBuilder request(HttpMethod httpMethod,
String urlTemplate, Object... urlVariables) {
return MockMvcRequestBuilders.request(httpMethod, urlTemplate, urlVariables)
.requestAttr(ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
.requestAttr(RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE,
urlTemplate);
}
/**
@@ -250,7 +250,8 @@ public abstract class RestDocumentationRequestBuilders {
Object... urlVariables) {
return (MockMultipartHttpServletRequestBuilder) MockMvcRequestBuilders
.fileUpload(urlTemplate, urlVariables).requestAttr(
ATTRIBUTE_NAME_URL_TEMPLATE, urlTemplate);
RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE,
urlTemplate);
}
/**

4
spring-restdocs-mockmvc/src/main/java/org/springframework/restdocs/mockmvc/RestDocumentationResultHandler.java
View File

@@ -35,6 +35,8 @@ import org.springframework.util.Assert;
*/
public class RestDocumentationResultHandler implements ResultHandler {
static final String ATTRIBUTE_NAME_CONFIGURATION = "org.springframework.restdocs.configuration";
private final RestDocumentationGenerator<MockHttpServletRequest, MockHttpServletResponse> delegate;
RestDocumentationResultHandler(
@@ -47,7 +49,7 @@ public class RestDocumentationResultHandler implements ResultHandler {
public void handle(MvcResult result) throws Exception {
@SuppressWarnings("unchecked")
Map<String, Object> configuration = (Map<String, Object>) result.getRequest()
.getAttribute("org.springframework.restdocs.configuration");
.getAttribute(ATTRIBUTE_NAME_CONFIGURATION);
this.delegate.handle(result.getRequest(), result.getResponse(), configuration);
}

4
spring-restdocs-mockmvc/src/test/java/org/springframework/restdocs/mockmvc/RestDocumentationRequestBuildersTests.java
View File

@@ -24,6 +24,7 @@ import org.junit.Test;
import org.springframework.http.HttpMethod;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockServletContext;
import org.springframework.restdocs.generate.RestDocumentationGenerator;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
import static org.hamcrest.CoreMatchers.equalTo;
@@ -143,7 +144,8 @@ public class RestDocumentationRequestBuildersTests {
HttpMethod httpMethod) {
MockHttpServletRequest request = builder.buildRequest(this.servletContext);
assertThat(
(String) request.getAttribute("org.springframework.restdocs.urlTemplate"),
(String) request
.getAttribute(RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE),
is(equalTo("{template}")));
assertThat(request.getRequestURI(), is(equalTo("t")));
assertThat(request.getMethod(), is(equalTo(httpMethod.name())));