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

Polish "Improve diagnostics for null configuration"

Browse Source 
See gh-583
This commit is contained in:
Andy Wilkinson
2019-08-30 16:57:21 +01:00
parent b5f2454c00
commit fce255695e
8 changed files with 39 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -49,7 +49,7 @@ public class RestDocumentationResultHandler implements ResultHandler {
@Override
public void handle(MvcResult result) throws Exception {
this.delegate.handle(result.getRequest(), result.getResponse(), getRequiredConfiguration(result));
this.delegate.handle(result.getRequest(), result.getResponse(), retrieveConfiguration(result));
}
/**
@@ -72,7 +72,7 @@ public class RestDocumentationResultHandler implements ResultHandler {
@Override
public void handle(MvcResult result) throws Exception {
Map<String, Object> configuration = new HashMap<>(getRequiredConfiguration(result));
Map<String, Object> configuration = new HashMap<>(retrieveConfiguration(result));
configuration.remove(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_SNIPPETS);
getDelegate().handle(result.getRequest(), result.getResponse(), configuration);
}
@@ -88,15 +88,12 @@ public class RestDocumentationResultHandler implements ResultHandler {
return this.delegate;
}
private static Map<String, Object> getRequiredConfiguration(MvcResult result) {
private Map<String, Object> retrieveConfiguration(MvcResult result) {
@SuppressWarnings("unchecked")
Map<String, Object> configuration = (Map<String, Object>) result.getRequest()
.getAttribute(ATTRIBUTE_NAME_CONFIGURATION);
Assert.state(configuration != null,
() -> String.format(
"There is no REST Docs configuration. Looks like "
+ "'%s' was not invoked. Please check your configuration.",
MockMvcRestDocumentationConfigurer.class.getName()));
Assert.state(configuration != null, () -> "REST Docs configuration not found. Did you forget to apply a "
+ MockMvcRestDocumentationConfigurer.class.getSimpleName() + " when building the MockMvc instance?");
return configuration;
}

13
spring-restdocs-mockmvc/src/test/java/org/springframework/restdocs/mockmvc/MockMvcRestDocumentationIntegrationTests.java
View File

@@ -496,7 +496,8 @@ public class MockMvcRestDocumentationIntegrationTests {
public void exceptionShouldBeThrownWhenCallDocumentMockMvcNotConfigured() {
MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(this.context).build();
assertThatThrownBy(() -> mockMvc.perform(get("/").accept(MediaType.APPLICATION_JSON)).andDo(document("basic")))
.isInstanceOf(IllegalStateException.class).hasMessageContaining(missingConfigurationMessage());
.isInstanceOf(IllegalStateException.class).hasMessage("REST Docs configuration not found. Did you "
+ "forget to apply a MockMvcRestDocumentationConfigurer when building the MockMvc instance?");
}
@@ -506,13 +507,9 @@ public class MockMvcRestDocumentationIntegrationTests {
MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(this.context).build();
assertThatThrownBy(() -> mockMvc.perform(get("/").accept(MediaType.APPLICATION_JSON))
.andDo(documentation.document(responseHeaders(headerWithName("a").description("one")))))
.isInstanceOf(IllegalStateException.class).hasMessageContaining(missingConfigurationMessage());
}
private String missingConfigurationMessage() {
return "There is no REST Docs configuration. Looks like "
+ "'org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer' "
+ "was not invoked. Please check your configuration.";
.isInstanceOf(IllegalStateException.class)
.hasMessage("REST Docs configuration not found. Did you forget to apply a "
+ "MockMvcRestDocumentationConfigurer when building the MockMvc instance?");
}
@Test

11
spring-restdocs-restassured/src/main/java/org/springframework/restdocs/restassured3/RestDocumentationFilter.java
View File

@@ -67,7 +67,7 @@ public class RestDocumentationFilter implements Filter {
* @return the configuration
*/
protected Map<String, Object> getConfiguration(FilterableRequestSpecification requestSpec, FilterContext context) {
Map<String, Object> configuration = new HashMap<>(getRequiredConfiguration(context));
Map<String, Object> configuration = new HashMap<>(retrieveConfiguration(context));
configuration.put(RestDocumentationContext.class.getName(),
context.<RestDocumentationContext>getValue(RestDocumentationContext.class.getName()));
configuration.put(RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, requestSpec.getUserDefinedPath());
@@ -96,13 +96,12 @@ public class RestDocumentationFilter implements Filter {
};
}
private static Map<String, Object> getRequiredConfiguration(FilterContext context) {
private static Map<String, Object> retrieveConfiguration(FilterContext context) {
Map<String, Object> configuration = context.getValue(CONTEXT_KEY_CONFIGURATION);
Assert.state(configuration != null,
() -> String.format(
"There is no REST Docs configuration. Looks like "
+ "'%s' was not invoked. Please check your configuration.",
RestDocumentationFilter.class.getName()));
() -> "REST Docs configuration not found. Did you forget to add a "
+ RestAssuredRestDocumentationConfigurer.class.getSimpleName()
+ " as a filter when building the RequestSpecification?");
return configuration;
}

16
spring-restdocs-restassured/src/test/java/org/springframework/restdocs/restassured3/RestAssuredRestDocumentationIntegrationTests.java
View File

@@ -343,7 +343,9 @@ public class RestAssuredRestDocumentationIntegrationTests {
@Test
public void exceptionShouldBeThrownWhenCallDocumentRequestSpecificationNotConfigured() {
assertThatThrownBy(() -> given().port(tomcat.getPort()).filter(document("default")).get("/"))
.isInstanceOf(IllegalStateException.class).hasMessageContaining(messingConfigurationMessage());
.isInstanceOf(IllegalStateException.class)
.hasMessage("REST Docs configuration not found. Did you forget to add a "
+ "RestAssuredRestDocumentationConfigurer as a filter when building the RequestSpecification?");
}
@Test
@@ -351,14 +353,10 @@ public class RestAssuredRestDocumentationIntegrationTests {
RestDocumentationFilter documentation = document("{method-name}-{step}");
assertThatThrownBy(() -> given().port(tomcat.getPort())
.filter(documentation.document(responseHeaders(headerWithName("a").description("one")))).get("/"))
.isInstanceOf(IllegalStateException.class).hasMessageContaining(messingConfigurationMessage());
}
private String messingConfigurationMessage() {
return "There is no REST Docs configuration. Looks like 'org.springframework."
+ "restdocs.restassured3.RestDocumentationFilter' was not invoked."
+ " Please check your configuration.";
.isInstanceOf(IllegalStateException.class)
.hasMessage("REST Docs configuration not found. Did you forget to add a "
+ "RestAssuredRestDocumentationConfigurer as a filter when building the "
+ "RequestSpecification?");
}
private void assertExpectedSnippetFilesExist(File directory, String... snippets) {

19
spring-restdocs-webtestclient/src/main/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentation.java
View File

@@ -16,7 +16,6 @@
package org.springframework.restdocs.webtestclient;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Consumer;
@@ -30,7 +29,6 @@ import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.test.web.reactive.server.WebTestClient.BodyContentSpec;
import org.springframework.test.web.reactive.server.WebTestClient.BodySpec;
import org.springframework.test.web.reactive.server.WebTestClient.Builder;
import org.springframework.util.Assert;
import org.springframework.web.reactive.function.client.ExchangeFilterFunction;
/**
@@ -76,7 +74,7 @@ public abstract class WebTestClientRestDocumentation {
*/
public static <T extends ExchangeResult> Consumer<T> document(String identifier, Snippet... snippets) {
return (result) -> new RestDocumentationGenerator<>(identifier, REQUEST_CONVERTER, RESPONSE_CONVERTER, snippets)
.handle(result, result, getRequiredConfiguration(result));
.handle(result, result, retrieveConfiguration(result));
}
/**
@@ -93,7 +91,7 @@ public abstract class WebTestClientRestDocumentation {
public static <T extends ExchangeResult> Consumer<T> document(String identifier,
OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) {
return (result) -> new RestDocumentationGenerator<>(identifier, REQUEST_CONVERTER, RESPONSE_CONVERTER,
requestPreprocessor, snippets).handle(result, result, getRequiredConfiguration(result));
requestPreprocessor, snippets).handle(result, result, retrieveConfiguration(result));
}
/**
@@ -110,7 +108,7 @@ public abstract class WebTestClientRestDocumentation {
public static <T extends ExchangeResult> Consumer<T> document(String identifier,
OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) {
return (result) -> new RestDocumentationGenerator<>(identifier, REQUEST_CONVERTER, RESPONSE_CONVERTER,
responsePreprocessor, snippets).handle(result, result, getRequiredConfiguration(result));
responsePreprocessor, snippets).handle(result, result, retrieveConfiguration(result));
}
/**
@@ -131,17 +129,12 @@ public abstract class WebTestClientRestDocumentation {
Snippet... snippets) {
return (result) -> new RestDocumentationGenerator<>(identifier, REQUEST_CONVERTER, RESPONSE_CONVERTER,
requestPreprocessor, responsePreprocessor, snippets).handle(result, result,
getRequiredConfiguration(result));
retrieveConfiguration(result));
}
private static Map<String, Object> getRequiredConfiguration(ExchangeResult result) {
Map<String, Object> config = WebTestClientRestDocumentationConfigurer
private static Map<String, Object> retrieveConfiguration(ExchangeResult result) {
Map<String, Object> configuration = WebTestClientRestDocumentationConfigurer
.retrieveConfiguration(result.getRequestHeaders());
Assert.state(config != null,
() -> String.format("There is no REST Docs configuration. Looks like '%s' "
+ "was not invoked or configuration has already been removed. Please check your configuration.",
WebTestClientRestDocumentationConfigurer.class.getName()));
Map<String, Object> configuration = new HashMap<>(config);
configuration.put(RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, result.getUriTemplate());
return configuration;
}

6
spring-restdocs-webtestclient/src/main/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentationConfigurer.java
View File

@@ -29,6 +29,7 @@ import org.springframework.restdocs.RestDocumentationContext;
import org.springframework.restdocs.RestDocumentationContextProvider;
import org.springframework.restdocs.config.RestDocumentationConfigurer;
import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.web.reactive.function.client.ClientRequest;
import org.springframework.web.reactive.function.client.ClientResponse;
@@ -78,7 +79,10 @@ public class WebTestClientRestDocumentationConfigurer extends
static Map<String, Object> retrieveConfiguration(HttpHeaders headers) {
String requestId = headers.getFirst(WebTestClient.WEBTESTCLIENT_REQUEST_ID);
return configurations.remove(requestId);
Map<String, Object> configuration = configurations.remove(requestId);
Assert.state(configuration != null, () -> "REST Docs configuration not found. Did you forget to register a "
+ WebTestClientRestDocumentationConfigurer.class.getSimpleName() + " as a filter?");
return configuration;
}
@Override

4
spring-restdocs-webtestclient/src/test/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentationConfigurerTests.java
View File

@@ -29,6 +29,7 @@ import org.springframework.web.reactive.function.client.ClientRequest;
import org.springframework.web.reactive.function.client.ExchangeFunction;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
@@ -51,7 +52,8 @@ public class WebTestClientRestDocumentationConfigurerTests {
.header(WebTestClient.WEBTESTCLIENT_REQUEST_ID, "1").build();
this.configurer.filter(request, mock(ExchangeFunction.class));
assertThat(WebTestClientRestDocumentationConfigurer.retrieveConfiguration(request.headers())).isNotNull();
assertThat(WebTestClientRestDocumentationConfigurer.retrieveConfiguration(request.headers())).isNull();
assertThatIllegalStateException()
.isThrownBy(() -> WebTestClientRestDocumentationConfigurer.retrieveConfiguration(request.headers()));
}
@Test

10
spring-restdocs-webtestclient/src/test/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentationIntegrationTests.java
View File

@@ -180,13 +180,9 @@ public class WebTestClientRestDocumentationIntegrationTests {
assertThatThrownBy(() -> this.webTestClient
.mutateWith((builder, httpHandlerBuilder, connector) -> builder.filters(List::clear).build()).get()
.uri("/").exchange().expectBody().consumeWith(document("default-snippets")))
.isInstanceOf(IllegalStateException.class).hasMessageContaining(missingConfiguration());
}
private String missingConfiguration() {
return "There is no REST Docs configuration. Looks like "
+ "'org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer' "
+ "was not invoked or configuration has already been removed. Please check your configuration.";
.isInstanceOf(IllegalStateException.class)
.hasMessage("REST Docs configuration not found. Did you forget to register a "
+ "WebTestClientRestDocumentationConfigurer as a filter?");
}
private void assertExpectedSnippetFilesExist(File directory, String... snippets) {