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

Improve testing of CurlDocumentation

Browse Source
This commit is contained in:
Andy Wilkinson
2015-02-18 13:11:07 +00:00
parent 3311121f33
commit e8243457d0
3 changed files with 290 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
build.gradle
View File

@@ -62,6 +62,7 @@ project(':spring-restdocs') {
compile "javax.servlet:javax.servlet-api:$servletApiVersion"
compile "com.fasterxml.jackson.core:jackson-databind:$jacksonVersion"
jacoco "org.jacoco:org.jacoco.agent:$jacocoVersion:runtime"
testCompile "org.springframework:spring-webmvc:$springVersion"
}
test {

88
spring-restdocs/src/test/java/org/springframework/restdocs/StubMvcResult.java Normal file
View File

@@ -0,0 +1,88 @@
/*
* 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;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.web.servlet.FlashMap;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
/**
* A minimal stub implementation of {@link MvcResult}
*
* @author Andy Wilkinson
*
*/
public class StubMvcResult implements MvcResult {
private final MockHttpServletRequest request;
private final MockHttpServletResponse response;
public StubMvcResult(MockHttpServletRequest request, MockHttpServletResponse response) {
this.request = request;
this.response = response;
}
@Override
public MockHttpServletRequest getRequest() {
return this.request;
}
@Override
public MockHttpServletResponse getResponse() {
return this.response;
}
@Override
public Object getHandler() {
return null;
}
@Override
public HandlerInterceptor[] getInterceptors() {
return null;
}
@Override
public ModelAndView getModelAndView() {
return null;
}
@Override
public Exception getResolvedException() {
return null;
}
@Override
public FlashMap getFlashMap() {
return null;
}
@Override
public Object getAsyncResult() {
return null;
}
@Override
public Object getAsyncResult(long timeToWait) {
return null;
}
}

201
spring-restdocs/src/test/java/org/springframework/restdocs/curl/CurlDocumentationTests.java Normal file
View File

@@ -0,0 +1,201 @@
/*
* 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.curl;
import static org.hamcrest.CoreMatchers.hasItem;
import static org.hamcrest.CoreMatchers.hasItems;
import static org.hamcrest.CoreMatchers.not;
import static org.junit.Assert.assertThat;
import static org.springframework.restdocs.curl.CurlDocumentation.documentCurlRequest;
import static org.springframework.restdocs.curl.CurlDocumentation.documentCurlRequestAndResponse;
import static org.springframework.restdocs.curl.CurlDocumentation.documentCurlResponse;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.restdocs.StubMvcResult;
/**
* Tests for {@link CurlDocumentation}
*
* @author Andy Wilkinson
*/
public class CurlDocumentationTests {
private final File outputDir = new File("build/curl-documentation-tests");
@Before
public void setup() {
System.setProperty("org.springframework.restdocs.outputDir",
this.outputDir.getAbsolutePath());
}
@After
public void cleanup() {
System.clearProperty("org.springframework.restdocs.outputDir");
}
@Test
public void getRequest() throws IOException {
documentCurlRequest("get-request").handle(
new StubMvcResult(new MockHttpServletRequest("GET", "/foo"), null));
assertThat(requestSnippetLines("get-request"),
hasItem("$ curl http://localhost:80/foo -i"));
}
@Test
public void nonGetRequest() throws IOException {
documentCurlRequest("non-get-request").handle(
new StubMvcResult(new MockHttpServletRequest("POST", "/foo"), null));
assertThat(requestSnippetLines("non-get-request"),
hasItem("$ curl http://localhost:80/foo -i -X POST"));
}
@Test
public void requestWithoutResponseHeaderInclusion() throws IOException {
documentCurlRequest("request-without-response-header-inclusion")
.includeResponseHeaders(false)
.handle(new StubMvcResult(new MockHttpServletRequest("GET", "/foo"), null));
assertThat(requestSnippetLines("request-without-response-header-inclusion"),
hasItem("$ curl http://localhost:80/foo"));
}
@Test
public void requestWithContent() throws IOException {
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/foo");
request.setContent("content".getBytes());
documentCurlRequest("request-with-content").handle(
new StubMvcResult(request, null));
assertThat(requestSnippetLines("request-with-content"),
hasItem("$ curl http://localhost:80/foo -i -d 'content'"));
}
@Test
public void requestWithHeaders() throws IOException {
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/foo");
request.setContentType(MediaType.APPLICATION_JSON_VALUE);
request.addHeader("a", "alpha");
documentCurlRequest("request-with-headers").handle(
new StubMvcResult(request, null));
assertThat(
requestSnippetLines("request-with-headers"),
hasItem("$ curl http://localhost:80/foo -i -H \"Content-Type: application/json\" -H \"a: alpha\""));
}
@Test
public void basicResponse() throws IOException {
documentCurlResponse("basic-response").handle(
new StubMvcResult(null, new MockHttpServletResponse()));
assertThat(responseSnippetLines("basic-response"), hasItem("HTTP/1.1 200 OK"));
}
@Test
public void nonOkResponse() throws IOException {
MockHttpServletResponse response = new MockHttpServletResponse();
response.setStatus(HttpStatus.BAD_REQUEST.value());
documentCurlResponse("non-ok-response").handle(new StubMvcResult(null, response));
assertThat(responseSnippetLines("non-ok-response"),
hasItem("HTTP/1.1 400 Bad Request"));
}
@Test
public void responseWithHeaders() throws IOException {
MockHttpServletResponse response = new MockHttpServletResponse();
response.setContentType(MediaType.APPLICATION_JSON_VALUE);
response.setHeader("a", "alpha");
documentCurlResponse("non-ok-response").handle(new StubMvcResult(null, response));
assertThat(responseSnippetLines("non-ok-response"),
hasItems("HTTP/1.1 200 OK", "Content-Type: application/json", "a: alpha"));
}
@Test
public void responseWithHeaderInclusionDisabled() throws IOException {
MockHttpServletResponse response = new MockHttpServletResponse();
response.setContentType(MediaType.APPLICATION_JSON_VALUE);
response.setHeader("a", "alpha");
response.getWriter().append("content");
documentCurlResponse("response-with-header-inclusion-disabled")
.includeResponseHeaders(false).handle(new StubMvcResult(null, response));
List<String> responseSnippetLines = responseSnippetLines("response-with-header-inclusion-disabled");
assertThat(
responseSnippetLines,
not(hasItems("HTTP/1.1 200 OK", "Content-Type: application/json",
"a: alpha")));
assertThat(responseSnippetLines, hasItem("content"));
}
@Test
public void responseWithContent() throws IOException {
MockHttpServletResponse response = new MockHttpServletResponse();
response.getWriter().append("content");
documentCurlResponse("response-with-content").handle(
new StubMvcResult(null, response));
assertThat(responseSnippetLines("response-with-content"),
hasItems("HTTP/1.1 200 OK", "content"));
}
@Test
public void requestAndResponse() throws IOException {
documentCurlRequestAndResponse("request-and-response").handle(
new StubMvcResult(new MockHttpServletRequest("GET", "/foo"),
new MockHttpServletResponse()));
assertThat(requestResponseSnippetLines("request-and-response"),
hasItems("$ curl http://localhost:80/foo -i", "HTTP/1.1 200 OK"));
}
private List<String> requestSnippetLines(String snippetName) throws IOException {
return snippetLines(snippetName, "request");
}
private List<String> responseSnippetLines(String snippetName) throws IOException {
return snippetLines(snippetName, "response");
}
private List<String> requestResponseSnippetLines(String snippetName)
throws IOException {
return snippetLines(snippetName, "request-response");
}
private List<String> snippetLines(String snippetName, String snippetType)
throws IOException {
File snippetDir = new File(this.outputDir, snippetName);
File snippetFile = new File(snippetDir, snippetType + ".asciidoc");
String line = null;
List<String> lines = new ArrayList<String>();
BufferedReader reader = new BufferedReader(new FileReader(snippetFile));
try {
while ((line = reader.readLine()) != null) {
lines.add(line);
}
}
finally {
reader.close();
}
return lines;
}
}