42353a0b5f
Previously, if alwaysDo was used and the user wanted to generate one or more additional snippets when calling perform a separate call to `snippets` was made prior to calling `perform`. This had two problems: - it required the result handler to be stateful (see gh-243) - it wasn't clear that the additional snippets would be produced when a subsequent call to perform was made This commit introduces a new API that allows the additional snippets to be specified within the MockMvc call. The old API has been deprecated and will be removed in 2.0. Closes gh-249
75 lines
2.9 KiB
Java
75 lines
2.9 KiB
Java
/*
|
|
* Copyright 2014-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 com.example.mockmvc;
|
|
|
|
import org.junit.Before;
|
|
import org.junit.Rule;
|
|
import org.springframework.restdocs.JUnitRestDocumentation;
|
|
import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;
|
|
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.hypermedia.HypermediaDocumentation.linkWithRel;
|
|
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
|
|
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
|
|
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
|
|
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;
|
|
import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
|
|
import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
|
|
import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
|
|
import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
|
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
|
|
|
public class EveryTestPreprocessing {
|
|
|
|
@Rule
|
|
public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation(
|
|
"target/generated-snippets");
|
|
|
|
private WebApplicationContext context;
|
|
|
|
// tag::setup[]
|
|
private MockMvc mockMvc;
|
|
|
|
private RestDocumentationResultHandler documentationHandler;
|
|
|
|
@Before
|
|
public void setup() {
|
|
this.documentationHandler = document("{method-name}", // <1>
|
|
preprocessRequest(removeHeaders("Foo")),
|
|
preprocessResponse(prettyPrint()));
|
|
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
|
|
.apply(documentationConfiguration(this.restDocumentation))
|
|
.alwaysDo(this.documentationHandler) // <2>
|
|
.build();
|
|
}
|
|
|
|
// end::setup[]
|
|
|
|
public void use() throws Exception {
|
|
// tag::use[]
|
|
this.mockMvc.perform(get("/")) // <1>
|
|
.andExpect(status().isOk())
|
|
.andDo(this.documentationHandler.document( // <2>
|
|
links(linkWithRel("self").description("Canonical self link"))
|
|
));
|
|
// end::use[]
|
|
}
|
|
|
|
}
|