org.springframework.restdocs.mockmvc.RestDocumentationMockMvcConfigurer Maven / Gradle / Ivy
/*
* Copyright 2014-2015 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.restdocs.mockmvc;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.restdocs.RestDocumentation;
import org.springframework.restdocs.RestDocumentationContext;
import org.springframework.restdocs.curl.CurlDocumentation;
import org.springframework.restdocs.http.HttpDocumentation;
import org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver;
import org.springframework.restdocs.snippet.StandardWriterResolver;
import org.springframework.restdocs.snippet.WriterResolver;
import org.springframework.restdocs.templates.StandardTemplateResourceResolver;
import org.springframework.restdocs.templates.TemplateEngine;
import org.springframework.restdocs.templates.mustache.MustacheTemplateEngine;
import org.springframework.test.web.servlet.request.RequestPostProcessor;
import org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder;
import org.springframework.test.web.servlet.setup.MockMvcConfigurer;
import org.springframework.test.web.servlet.setup.MockMvcConfigurerAdapter;
import org.springframework.web.context.WebApplicationContext;
/**
* A {@link MockMvcConfigurer} that can be used to configure the documentation.
*
* In the absence of any {@link #snippets() customization} the following snippets will be
* produced by default:
*
* - {@link CurlDocumentation#curlRequest() Curl request}
* - {@link HttpDocumentation#httpRequest() HTTP request}
* - {@link HttpDocumentation#httpResponse() HTTP response}
*
*
* In the absence of any {@link #uris() customization}, documented URIs have the following
* defaults:
*
* - Scheme: {@code http}
* - Host: {@code localhost}
* - Port: {@code 8080}
*
*
* @author Andy Wilkinson
* @author Dmitriy Mayboroda
* @see ConfigurableMockMvcBuilder#apply(MockMvcConfigurer)
* @see MockMvcRestDocumentation#documentationConfiguration(RestDocumentation)
*/
public class RestDocumentationMockMvcConfigurer extends MockMvcConfigurerAdapter {
private final UriConfigurer uriConfigurer = new UriConfigurer(this);
private final SnippetConfigurer snippetConfigurer = new SnippetConfigurer(this);
private final RequestPostProcessor requestPostProcessor;
private final TemplateEngineConfigurer templateEngineConfigurer = new TemplateEngineConfigurer();
private final WriterResolverConfigurer writerResolverConfigurer = new WriterResolverConfigurer();
/**
* Creates a new {code RestDocumentationMockMvcConfigurer} that will use the given
* {@code restDocumentation} when configuring MockMvc.
*
* @param restDocumentation the rest documentation
* @see MockMvcRestDocumentation#documentationConfiguration(RestDocumentation)
*/
RestDocumentationMockMvcConfigurer(RestDocumentation restDocumentation) {
this.requestPostProcessor = new ConfigurerApplyingRequestPostProcessor(
restDocumentation, this.uriConfigurer, this.writerResolverConfigurer,
this.snippetConfigurer, this.templateEngineConfigurer);
}
/**
* Returns a {@link UriConfigurer} that can be used to configure the request URIs that
* will be documented.
*
* @return the URI configurer
*/
public UriConfigurer uris() {
return this.uriConfigurer;
}
/**
* Returns a {@link SnippetConfigurer} that can be used to configure the snippets that
* will be generated.
*
* @return the snippet configurer
*/
public SnippetConfigurer snippets() {
return this.snippetConfigurer;
}
/**
* Configures the {@link TemplateEngine} that will be used for snippet rendering.
*
* @param templateEngine the template engine to use
* @return {@code this}
*/
public RestDocumentationMockMvcConfigurer templateEngine(
TemplateEngine templateEngine) {
this.templateEngineConfigurer.setTemplateEngine(templateEngine);
return this;
}
/**
* Configures the {@link WriterResolver} that will be used to resolve a writer for a
* snippet.
*
* @param writerResolver The writer resolver to use
* @return {@code this}
*/
public RestDocumentationMockMvcConfigurer writerResolver(
WriterResolver writerResolver) {
this.writerResolverConfigurer.setWriterResolver(writerResolver);
return this;
}
@Override
public RequestPostProcessor beforeMockMvcCreated(
ConfigurableMockMvcBuilder builder, WebApplicationContext context) {
return this.requestPostProcessor;
}
private static final class TemplateEngineConfigurer extends AbstractConfigurer {
private TemplateEngine templateEngine = new MustacheTemplateEngine(
new StandardTemplateResourceResolver());
@Override
void apply(MockHttpServletRequest request) {
request.setAttribute(TemplateEngine.class.getName(), this.templateEngine);
}
void setTemplateEngine(TemplateEngine templateEngine) {
this.templateEngine = templateEngine;
}
}
private static final class WriterResolverConfigurer extends AbstractConfigurer {
private WriterResolver writerResolver;
@Override
void apply(MockHttpServletRequest request) {
WriterResolver resolverToUse = this.writerResolver;
if (resolverToUse == null) {
resolverToUse = new StandardWriterResolver(
new RestDocumentationContextPlaceholderResolver(
(RestDocumentationContext) request.getAttribute(
RestDocumentationContext.class.getName())));
}
request.setAttribute(WriterResolver.class.getName(), resolverToUse);
}
void setWriterResolver(WriterResolver writerResolver) {
this.writerResolver = writerResolver;
}
}
private static final class ConfigurerApplyingRequestPostProcessor
implements RequestPostProcessor {
private final RestDocumentation restDocumentation;
private final AbstractConfigurer[] configurers;
private ConfigurerApplyingRequestPostProcessor(
RestDocumentation restDocumentation, AbstractConfigurer... configurers) {
this.restDocumentation = restDocumentation;
this.configurers = configurers;
}
@Override
public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request) {
request.setAttribute(RestDocumentationContext.class.getName(),
this.restDocumentation.beforeOperation());
for (AbstractConfigurer configurer : this.configurers) {
configurer.apply(request);
}
return request;
}
}
}