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

Update query string when modifying GET request's parameters

Browse Source 
Fixes gh-682
This commit is contained in:
Andy Wilkinson
2020-09-01 15:30:11 +01:00
parent d62ee4f849
commit baaf4f2e05
2 changed files with 71 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/OperationRequestFactory.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2019 the original author or authors.
* Copyright 2014-2020 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.
@@ -17,6 +17,7 @@
package org.springframework.restdocs.operation;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Collection;
import java.util.Collections;
@@ -94,14 +95,28 @@ public class OperationRequestFactory {
/**
* Creates a new {@code OperationRequest} based on the given {@code original} but with
* the given {@code newParameters}.
* the given {@code newParameters} applied. The query string of a {@code GET} request
* will be updated to reflect the new parameters.
* @param original the original request
* @param newParameters the new parameters
* @return the new request with the new parameters
* @return the new request with the parameters applied
*/
public OperationRequest createFrom(OperationRequest original, Parameters newParameters) {
return new StandardOperationRequest(original.getUri(), original.getMethod(), original.getContent(),
original.getHeaders(), newParameters, original.getParts(), original.getCookies());
URI uri = (original.getMethod() == HttpMethod.GET) ? updateQueryString(original.getUri(), newParameters)
: original.getUri();
return new StandardOperationRequest(uri, original.getMethod(), original.getContent(), original.getHeaders(),
newParameters, original.getParts(), original.getCookies());
}
private URI updateQueryString(URI originalUri, Parameters parameters) {
try {
return new URI(originalUri.getScheme(), originalUri.getUserInfo(), originalUri.getHost(),
originalUri.getPort(), originalUri.getPath(),
parameters.isEmpty() ? null : parameters.toQueryString(), originalUri.getFragment());
}
catch (URISyntaxException ex) {
throw new RuntimeException(ex);
}
}
private HttpHeaders augmentHeaders(HttpHeaders originalHeaders, URI uri, byte[] content) {

72
spring-restdocs-core/src/test/java/org/springframework/restdocs/operation/preprocess/ParametersModifyingOperationPreprocessorTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2019 the original author or authors.
* Copyright 2014-2020 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.
@@ -43,53 +43,62 @@ public class ParametersModifyingOperationPreprocessorTests {
@Test
public void addNewParameter() {
Parameters parameters = new Parameters();
assertThat(this.preprocessor.add("a", "alpha").preprocess(createRequest(parameters)).getParameters())
.containsEntry("a", Arrays.asList("alpha"));
OperationRequest request = this.preprocessor.add("a", "alpha").preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).containsEntry("a", Arrays.asList("alpha"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080?a=alpha"));
}
@Test
public void addValueToExistingParameter() {
Parameters parameters = new Parameters();
parameters.add("a", "apple");
assertThat(this.preprocessor.add("a", "alpha").preprocess(createRequest(parameters)).getParameters())
.containsEntry("a", Arrays.asList("apple", "alpha"));
OperationRequest request = this.preprocessor.add("a", "alpha").preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).containsEntry("a", Arrays.asList("apple", "alpha"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080?a=apple&a=alpha"));
}
@Test
public void setNewParameter() {
Parameters parameters = new Parameters();
assertThat(this.preprocessor.set("a", "alpha", "avocado").preprocess(createRequest(parameters)).getParameters())
.containsEntry("a", Arrays.asList("alpha", "avocado"));
OperationRequest request = this.preprocessor.set("a", "alpha", "avocado")
.preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).containsEntry("a", Arrays.asList("alpha", "avocado"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080?a=alpha&a=avocado"));
}
@Test
public void setExistingParameter() {
Parameters parameters = new Parameters();
parameters.add("a", "apple");
assertThat(this.preprocessor.set("a", "alpha", "avocado").preprocess(createRequest(parameters)).getParameters())
.containsEntry("a", Arrays.asList("alpha", "avocado"));
OperationRequest request = this.preprocessor.set("a", "alpha", "avocado")
.preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).containsEntry("a", Arrays.asList("alpha", "avocado"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080?a=alpha&a=avocado"));
}
@Test
public void removeNonExistentParameter() {
Parameters parameters = new Parameters();
assertThat(this.preprocessor.remove("a").preprocess(createRequest(parameters)).getParameters().size())
.isEqualTo(0);
OperationRequest request = this.preprocessor.remove("a").preprocess(createGetRequest(parameters));
assertThat(request.getParameters().size()).isEqualTo(0);
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080"));
}
@Test
public void removeParameter() {
Parameters parameters = new Parameters();
parameters.add("a", "apple");
assertThat(this.preprocessor.set("a", "alpha", "avocado").preprocess(createRequest(parameters)).getParameters())
.containsEntry("a", Arrays.asList("alpha", "avocado"));
OperationRequest request = this.preprocessor.remove("a").preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).isEmpty();
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080"));
}
@Test
public void removeParameterValueForNonExistentParameter() {
Parameters parameters = new Parameters();
assertThat(this.preprocessor.remove("a", "apple").preprocess(createRequest(parameters)).getParameters().size())
.isEqualTo(0);
OperationRequest request = this.preprocessor.remove("a", "apple").preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).isEmpty();
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080"));
}
@Test
@@ -97,20 +106,41 @@ public class ParametersModifyingOperationPreprocessorTests {
Parameters parameters = new Parameters();
parameters.add("a", "apple");
parameters.add("a", "alpha");
assertThat(this.preprocessor.remove("a", "apple").preprocess(createRequest(parameters)).getParameters())
.containsEntry("a", Arrays.asList("alpha"));
parameters.add("b", "bravo");
OperationRequest request = this.preprocessor.remove("a", "apple").preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).containsEntry("a", Arrays.asList("alpha"));
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080?a=alpha&b=bravo"));
}
@Test
public void removeParameterValueWithSingleValueRemovesEntryEntirely() {
Parameters parameters = new Parameters();
parameters.add("a", "apple");
assertThat(this.preprocessor.remove("a", "apple").preprocess(createRequest(parameters)).getParameters().size())
.isEqualTo(0);
parameters.add("b", "bravo");
OperationRequest request = this.preprocessor.remove("a", "apple").preprocess(createGetRequest(parameters));
assertThat(request.getParameters()).doesNotContainKey("a");
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080?b=bravo"));
}
private OperationRequest createRequest(Parameters parameters) {
return new OperationRequestFactory().create(URI.create("http://localhost:8080"), HttpMethod.GET, new byte[0],
@Test
public void whenParametersOfANonGetRequestAreModifiedThenTheQueryStringIsUnaffected() {
Parameters parameters = new Parameters();
parameters.add("a", "apple");
parameters.add("b", "bravo");
OperationRequest request = this.preprocessor.remove("a", "apple").preprocess(createPostRequest(parameters));
assertThat(request.getParameters()).doesNotContainKey("a");
assertThat(request.getUri()).isEqualTo(URI.create("http://localhost:8080"));
}
private OperationRequest createGetRequest(Parameters parameters) {
return new OperationRequestFactory().create(
URI.create("http://localhost:8080" + (parameters.isEmpty() ? "" : "?" + parameters.toQueryString())),
HttpMethod.GET, new byte[0], new HttpHeaders(), parameters,
Collections.<OperationRequestPart>emptyList());
}
private OperationRequest createPostRequest(Parameters parameters) {
return new OperationRequestFactory().create(URI.create("http://localhost:8080"), HttpMethod.POST, new byte[0],
new HttpHeaders(), parameters, Collections.<OperationRequestPart>emptyList());
}