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

Merge branch '1.1.x'

Browse Source
This commit is contained in:
Andy Wilkinson
2016-07-29 21:11:14 +01:00
parent f2717363f0 bf9b0f2d64
commit 8bcfb49219
8 changed files with 276 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
spring-restdocs-core/src/main/java/org/springframework/restdocs/cli/CliOperationRequest.java
View File

@@ -52,34 +52,6 @@ final class CliOperationRequest implements OperationRequest {
new BasicAuthHeaderFilter(), new HostHeaderFilter(delegate.getUri())));
}
Parameters getUniqueParameters() {
Parameters queryStringParameters = new QueryStringParser()
.parse(this.delegate.getUri());
Parameters uniqueParameters = new Parameters();
for (Map.Entry<String, List<String>> parameter : this.delegate.getParameters()
.entrySet()) {
addIfUnique(parameter, queryStringParameters, uniqueParameters);
}
return uniqueParameters;
}
private void addIfUnique(Map.Entry<String, List<String>> parameter,
Parameters queryStringParameters, Parameters uniqueParameters) {
if (!queryStringParameters.containsKey(parameter.getKey())) {
uniqueParameters.put(parameter.getKey(), parameter.getValue());
}
else {
List<String> candidates = parameter.getValue();
List<String> existing = queryStringParameters.get(parameter.getKey());
for (String candidate : candidates) {
if (!existing.contains(candidate)) {
uniqueParameters.add(parameter.getKey(), candidate);
}
}
}
}
boolean isPutOrPost() {
return HttpMethod.PUT.equals(this.delegate.getMethod())
|| HttpMethod.POST.equals(this.delegate.getMethod());

14
spring-restdocs-core/src/main/java/org/springframework/restdocs/cli/CurlRequestSnippet.java
View File

@@ -70,9 +70,12 @@ public class CurlRequestSnippet extends TemplatedSnippet {
private String getUrl(Operation operation) {
OperationRequest request = operation.getRequest();
if (!request.getParameters().isEmpty() && includeParametersInUri(request)) {
return String.format("'%s?%s'", request.getUri(),
request.getParameters().toQueryString());
Parameters uniqueParameters = request.getParameters()
.getUniqueParameters(operation.getRequest().getUri());
if (!uniqueParameters.isEmpty() && includeParametersInUri(request)) {
return String.format("'%s%s%s'", request.getUri(),
StringUtils.hasText(request.getUri().getRawQuery()) ? "&" : "?",
uniqueParameters.toQueryString());
}
return String.format("'%s'", request.getUri());
}
@@ -157,9 +160,10 @@ public class CurlRequestSnippet extends TemplatedSnippet {
}
}
private void writeContentUsingParameters(CliOperationRequest request,
private void writeContentUsingParameters(OperationRequest request,
PrintWriter writer) {
Parameters uniqueParameters = request.getUniqueParameters();
Parameters uniqueParameters = request.getParameters()
.getUniqueParameters(request.getUri());
String queryString = uniqueParameters.toQueryString();
if (StringUtils.hasText(queryString)) {
writer.print(String.format(" -d '%s'", queryString));

24
spring-restdocs-core/src/main/java/org/springframework/restdocs/cli/HttpieRequestSnippet.java
View File

@@ -90,10 +90,13 @@ public class HttpieRequestSnippet extends TemplatedSnippet {
return options.toString();
}
private String getUrl(CliOperationRequest request) {
if (!request.getUniqueParameters().isEmpty() && includeParametersInUri(request)) {
return String.format("'%s?%s'", request.getUri(),
request.getParameters().toQueryString());
private String getUrl(OperationRequest request) {
Parameters uniqueParameters = request.getParameters()
.getUniqueParameters(request.getUri());
if (!uniqueParameters.isEmpty() && includeParametersInUri(request)) {
return String.format("'%s%s%s'", request.getUri(),
StringUtils.hasText(request.getUri().getRawQuery()) ? "&" : "?",
uniqueParameters.toQueryString());
}
return String.format("'%s'", request.getUri());
}
@@ -107,14 +110,15 @@ public class HttpieRequestSnippet extends TemplatedSnippet {
return requestItems.toString();
}
private void writeOptions(CliOperationRequest request, PrintWriter writer) {
if (!request.getParts().isEmpty() || (!request.getUniqueParameters().isEmpty()
&& !includeParametersInUri(request))) {
private void writeOptions(OperationRequest request, PrintWriter writer) {
if (!request.getParts().isEmpty()
|| (!request.getParameters().getUniqueParameters(request.getUri())
.isEmpty() && !includeParametersInUri(request))) {
writer.print("--form ");
}
}
private boolean includeParametersInUri(CliOperationRequest request) {
private boolean includeParametersInUri(OperationRequest request) {
return request.getMethod() == HttpMethod.GET || request.getContent().length > 0;
}
@@ -167,7 +171,9 @@ public class HttpieRequestSnippet extends TemplatedSnippet {
writeContentUsingParameters(request.getParameters(), writer);
}
else if (request.isPutOrPost()) {
writeContentUsingParameters(request.getUniqueParameters(), writer);
writeContentUsingParameters(
request.getParameters().getUniqueParameters(request.getUri()),
writer);
}
}

9
spring-restdocs-core/src/main/java/org/springframework/restdocs/http/HttpRequestSnippet.java
View File

@@ -30,6 +30,7 @@ import org.springframework.http.MediaType;
import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.operation.OperationRequest;
import org.springframework.restdocs.operation.OperationRequestPart;
import org.springframework.restdocs.operation.Parameters;
import org.springframework.restdocs.snippet.Snippet;
import org.springframework.restdocs.snippet.TemplatedSnippet;
import org.springframework.util.StringUtils;
@@ -75,12 +76,14 @@ public class HttpRequestSnippet extends TemplatedSnippet {
private String getPath(OperationRequest request) {
String path = request.getUri().getRawPath();
String queryString = request.getUri().getRawQuery();
if (!request.getParameters().isEmpty() && includeParametersInUri(request)) {
Parameters uniqueParameters = request.getParameters()
.getUniqueParameters(request.getUri());
if (!uniqueParameters.isEmpty() && includeParametersInUri(request)) {
if (StringUtils.hasText(queryString)) {
queryString = queryString + "&" + request.getParameters().toQueryString();
queryString = queryString + "&" + uniqueParameters.toQueryString();
}
else {
queryString = request.getParameters().toQueryString();
queryString = uniqueParameters.toQueryString();
}
}
if (StringUtils.hasText(queryString)) {

35
spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/Parameters.java
View File

@@ -17,10 +17,12 @@
package org.springframework.restdocs.operation;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import org.springframework.restdocs.cli.QueryStringParser;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.StringUtils;
@@ -53,6 +55,39 @@ public class Parameters extends LinkedMultiValueMap<String, String> {
return sb.toString();
}
/**
* Returns a new {@code Parameters} containing only the parameters that do no appear
* in the query string of the given {@code uri}.
*
* @param uri the uri
* @return the unique parameters
*/
public Parameters getUniqueParameters(URI uri) {
Parameters queryStringParameters = new QueryStringParser().parse(uri);
Parameters uniqueParameters = new Parameters();
for (Map.Entry<String, List<String>> parameter : entrySet()) {
addIfUnique(parameter, queryStringParameters, uniqueParameters);
}
return uniqueParameters;
}
private void addIfUnique(Map.Entry<String, List<String>> parameter,
Parameters queryStringParameters, Parameters uniqueParameters) {
if (!queryStringParameters.containsKey(parameter.getKey())) {
uniqueParameters.put(parameter.getKey(), parameter.getValue());
}
else {
List<String> candidates = parameter.getValue();
List<String> existing = queryStringParameters.get(parameter.getKey());
for (String candidate : candidates) {
if (!existing.contains(candidate)) {
uniqueParameters.add(parameter.getKey(), candidate);
}
}
}
}
private static void append(StringBuilder sb, String key) {
append(sb, key, "");
}

72
spring-restdocs-core/src/test/java/org/springframework/restdocs/cli/CurlRequestSnippetTests.java
View File

@@ -95,6 +95,47 @@ public class CurlRequestSnippetTests extends AbstractSnippetTests {
.request("http://localhost/foo?param=value").build());
}
@Test
public void getRequestWithTotallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectCurlRequest(
"request-with-totally-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash")
.content("$ curl 'http://localhost/foo?param=value' -i"));
new CurlRequestSnippet().document(operationBuilder(
"request-with-totally-overlapping-query-string-and-parameters")
.request("http://localhost/foo?param=value")
.param("param", "value").build());
}
@Test
public void getRequestWithPartiallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectCurlRequest(
"request-with-partially-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash")
.content("$ curl 'http://localhost/foo?a=alpha&b=bravo' -i"));
new CurlRequestSnippet().document(operationBuilder(
"request-with-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha").param("a", "alpha")
.param("b", "bravo").build());
}
@Test
public void getRequestWithDisjointQueryStringAndParameters() throws IOException {
this.snippet
.expectCurlRequest(
"request-with-partially-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash")
.content("$ curl 'http://localhost/foo?a=alpha&b=bravo' -i"));
new CurlRequestSnippet().document(operationBuilder(
"request-with-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha").param("b", "bravo")
.build());
}
@Test
public void getRequestWithQueryStringWithNoValue() throws IOException {
this.snippet.expectCurlRequest("request-with-query-string-with-no-value")
@@ -172,25 +213,42 @@ public class CurlRequestSnippetTests extends AbstractSnippetTests {
}
@Test
public void postRequestWithQueryStringAndParameter() throws IOException {
this.snippet.expectCurlRequest("post-request-with-query-string-and-parameter")
public void postRequestWithDisjointQueryStringAndParameter() throws IOException {
this.snippet
.expectCurlRequest(
"post-request-with-disjoint-query-string-and-parameter")
.withContents(codeBlock("bash").content(
"$ curl 'http://localhost/foo?a=alpha' -i -X POST -d 'b=bravo'"));
new CurlRequestSnippet()
.document(operationBuilder("post-request-with-query-string-and-parameter")
new CurlRequestSnippet().document(
operationBuilder("post-request-with-disjoint-query-string-and-parameter")
.request("http://localhost/foo?a=alpha").method("POST")
.param("b", "bravo").build());
}
@Test
public void postRequestWithOverlappingQueryStringAndParameters() throws IOException {
public void postRequestWithTotallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectCurlRequest(
"post-request-with-overlapping-query-string-and-parameters")
"post-request-with-totally-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash").content(
"$ curl 'http://localhost/foo?a=alpha&b=bravo' -i -X POST"));
new CurlRequestSnippet().document(operationBuilder(
"post-request-with-totally-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha&b=bravo").method("POST")
.param("a", "alpha").param("b", "bravo").build());
}
@Test
public void postRequestWithPartiallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectCurlRequest(
"post-request-with-partially-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash").content(
"$ curl 'http://localhost/foo?a=alpha' -i -X POST -d 'b=bravo'"));
new CurlRequestSnippet().document(operationBuilder(
"post-request-with-overlapping-query-string-and-parameters")
"post-request-with-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha").method("POST")
.param("a", "alpha").param("b", "bravo").build());
}

72
spring-restdocs-core/src/test/java/org/springframework/restdocs/cli/HttpieRequestSnippetTests.java
View File

@@ -96,6 +96,47 @@ public class HttpieRequestSnippetTests extends AbstractSnippetTests {
.request("http://localhost/foo?param=value").build());
}
@Test
public void getRequestWithTotallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectHttpieRequest(
"request-with-totally-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash")
.content("$ http GET 'http://localhost/foo?param=value'"));
new HttpieRequestSnippet().document(operationBuilder(
"request-with-totally-overlapping-query-string-and-parameters")
.request("http://localhost/foo?param=value")
.param("param", "value").build());
}
@Test
public void getRequestWithPartiallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectHttpieRequest(
"request-with-partially-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash")
.content("$ http GET 'http://localhost/foo?a=alpha&b=bravo'"));
new HttpieRequestSnippet().document(operationBuilder(
"request-with-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha").param("a", "alpha")
.param("b", "bravo").build());
}
@Test
public void getRequestWithDisjointQueryStringAndParameters() throws IOException {
this.snippet
.expectHttpieRequest(
"request-with-partially-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash")
.content("$ http GET 'http://localhost/foo?a=alpha&b=bravo'"));
new HttpieRequestSnippet().document(operationBuilder(
"request-with-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha").param("b", "bravo")
.build());
}
@Test
public void getRequestWithQueryStringWithNoValue() throws IOException {
this.snippet.expectHttpieRequest("request-with-query-string-with-no-value")
@@ -173,25 +214,42 @@ public class HttpieRequestSnippetTests extends AbstractSnippetTests {
}
@Test
public void postRequestWithQueryStringAndParameter() throws IOException {
this.snippet.expectHttpieRequest("post-request-with-query-string-and-parameter")
public void postRequestWithDisjointQueryStringAndParameter() throws IOException {
this.snippet
.expectHttpieRequest(
"post-request-with-disjoint-query-string-and-parameter")
.withContents(codeBlock("bash").content(
"$ http --form POST 'http://localhost/foo?a=alpha' 'b=bravo'"));
new HttpieRequestSnippet()
.document(operationBuilder("post-request-with-query-string-and-parameter")
new HttpieRequestSnippet().document(
operationBuilder("post-request-with-disjoint-query-string-and-parameter")
.request("http://localhost/foo?a=alpha").method("POST")
.param("b", "bravo").build());
}
@Test
public void postRequestWithOverlappingQueryStringAndParameters() throws IOException {
public void postRequestWithTotallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectHttpieRequest(
"post-request-with-overlapping-query-string-and-parameters")
"post-request-with-totally-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash")
.content("$ http POST 'http://localhost/foo?a=alpha&b=bravo'"));
new HttpieRequestSnippet().document(operationBuilder(
"post-request-with-totally-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha&b=bravo").method("POST")
.param("a", "alpha").param("b", "bravo").build());
}
@Test
public void postRequestWithPartiallyOverlappingQueryStringAndParameters()
throws IOException {
this.snippet
.expectHttpieRequest(
"post-request-with-partially-overlapping-query-string-and-parameters")
.withContents(codeBlock("bash").content(
"$ http --form POST 'http://localhost/foo?a=alpha' 'b=bravo'"));
new HttpieRequestSnippet().document(operationBuilder(
"post-request-with-overlapping-query-string-and-parameters")
"post-request-with-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha").method("POST")
.param("a", "alpha").param("b", "bravo").build());
}

81
spring-restdocs-core/src/test/java/org/springframework/restdocs/http/HttpRequestSnippetTests.java
View File

@@ -102,6 +102,34 @@ public class HttpRequestSnippetTests extends AbstractSnippetTests {
.request("http://localhost/foo?bar").build());
}
@Test
public void getWithPartiallyOverlappingQueryStringAndParameters() throws IOException {
this.snippet
.expectHttpRequest(
"get-with-partially-overlapping-query-string-and-parameters")
.withContents(httpRequest(RequestMethod.GET, "/foo?a=alpha&b=bravo")
.header(HttpHeaders.HOST, "localhost"));
new HttpRequestSnippet().document(operationBuilder(
"get-with-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha").param("a", "alpha")
.param("b", "bravo").build());
}
@Test
public void getWithTotallyOverlappingQueryStringAndParameters() throws IOException {
this.snippet
.expectHttpRequest(
"get-with-totally-overlapping-query-string-and-parameters")
.withContents(httpRequest(RequestMethod.GET, "/foo?a=alpha&b=bravo")
.header(HttpHeaders.HOST, "localhost"));
new HttpRequestSnippet().document(operationBuilder(
"get-with-totally-overlapping-query-string-and-parameters")
.request("http://localhost/foo?a=alpha&b=bravo")
.param("a", "alpha").param("b", "bravo").build());
}
@Test
public void postRequestWithContent() throws IOException {
String content = "Hello, world";
@@ -128,6 +156,59 @@ public class HttpRequestSnippetTests extends AbstractSnippetTests {
.param("a", "alpha").content(content).build());
}
@Test
public void postRequestWithContentAndDisjointQueryStringAndParameters()
throws IOException {
String content = "Hello, world";
this.snippet
.expectHttpRequest(
"post-request-with-content-and-disjoint-query-string-and-parameters")
.withContents(httpRequest(RequestMethod.POST, "/foo?b=bravo&a=alpha")
.header(HttpHeaders.HOST, "localhost").content(content)
.header(HttpHeaders.CONTENT_LENGTH, content.getBytes().length));
new HttpRequestSnippet().document(operationBuilder(
"post-request-with-content-and-disjoint-query-string-and-parameters")
.request("http://localhost/foo?b=bravo").method("POST")
.param("a", "alpha").content(content).build());
}
@Test
public void postRequestWithContentAndPartiallyOverlappingQueryStringAndParameters()
throws IOException {
String content = "Hello, world";
this.snippet
.expectHttpRequest(
"post-request-with-content-and-partially-overlapping-query-string-and-parameters")
.withContents(httpRequest(RequestMethod.POST, "/foo?b=bravo&a=alpha")
.header(HttpHeaders.HOST, "localhost").content(content)
.header(HttpHeaders.CONTENT_LENGTH, content.getBytes().length));
new HttpRequestSnippet().document(operationBuilder(
"post-request-with-content-and-partially-overlapping-query-string-and-parameters")
.request("http://localhost/foo?b=bravo").method("POST")
.param("a", "alpha").param("b", "bravo").content(content)
.build());
}
@Test
public void postRequestWithContentAndTotallyOverlappingQueryStringAndParameters()
throws IOException {
String content = "Hello, world";
this.snippet
.expectHttpRequest(
"post-request-with-content-and-totally-overlapping-query-string-and-parameters")
.withContents(httpRequest(RequestMethod.POST, "/foo?b=bravo&a=alpha")
.header(HttpHeaders.HOST, "localhost").content(content)
.header(HttpHeaders.CONTENT_LENGTH, content.getBytes().length));
new HttpRequestSnippet().document(operationBuilder(
"post-request-with-content-and-totally-overlapping-query-string-and-parameters")
.request("http://localhost/foo?b=bravo&a=alpha").method("POST")
.param("a", "alpha").param("b", "bravo").content(content)
.build());
}
@Test
public void postRequestWithCharset() throws IOException {
String japaneseContent = "\u30b3\u30f3\u30c6\u30f3\u30c4";