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

Polish "Provide a preprocessor for modifying request and response headers"

Browse Source 
See gh-584
This commit is contained in:
Andy Wilkinson
2022-05-12 14:27:49 +01:00
parent 768a43a61e
commit 36418f47d7
6 changed files with 102 additions and 270 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/src/docs/asciidoc/customizing-requests-and-responses.adoc
View File

@@ -108,12 +108,10 @@ You can also specify a different replacement if you wish.
[[customizing-requests-and-responses-preprocessors-remove-headers]]
==== Removing Headers
[[customizing-requests-and-responses-preprocessors-modify-headers]]
==== Modifying Headers
`removeHeaders` on `Preprocessors` removes any headers from the request or response where the name is equal to any of the given header names.
`removeMatchingHeaders` on `Preprocessors` removes any headers from the request or response where the name matches any of the given regular expression patterns.
You can use `modifyHeaders` on `Preprocessors` to add, set, and remove request or response headers.
@@ -125,13 +123,6 @@ Any occurrences that match a regular expression are replaced.
[[customizing-requests-and-responses-preprocessors-modify-headers]]
==== Modifying Headers
You can use `modifyHeaders` on `Preprocessors` to add, set, and remove request or response headers.
[[customizing-requests-and-responses-preprocessors-modify-request-parameters]]
==== Modifying Request Parameters

69
spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/HeaderRemovingOperationPreprocessor.java
View File

@@ -1,69 +0,0 @@
/*
* Copyright 2014-2019 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
*
* https://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.operation.preprocess;
import java.util.List;
import java.util.Map.Entry;
import org.springframework.http.HttpHeaders;
import org.springframework.restdocs.operation.OperationRequest;
import org.springframework.restdocs.operation.OperationRequestFactory;
import org.springframework.restdocs.operation.OperationResponse;
import org.springframework.restdocs.operation.OperationResponseFactory;
/**
* An {@link OperationPreprocessor} that removes headers. The headers to remove are
* provided as constructor arguments and can be either plain string or patterns to match
* against the headers found
*
* @author Andy Wilkinson
* @deprecated Use {@link HeadersModifyingOperationPreprocessor} instead
*/
@Deprecated
class HeaderRemovingOperationPreprocessor implements OperationPreprocessor {
private final OperationRequestFactory requestFactory = new OperationRequestFactory();
private final OperationResponseFactory responseFactory = new OperationResponseFactory();
private final HeaderFilter headerFilter;
HeaderRemovingOperationPreprocessor(HeaderFilter headerFilter) {
this.headerFilter = headerFilter;
}
@Override
public OperationResponse preprocess(OperationResponse response) {
return this.responseFactory.createFrom(response, removeHeaders(response.getHeaders()));
}
@Override
public OperationRequest preprocess(OperationRequest request) {
return this.requestFactory.createFrom(request, removeHeaders(request.getHeaders()));
}
private HttpHeaders removeHeaders(HttpHeaders originalHeaders) {
HttpHeaders processedHeaders = new HttpHeaders();
for (Entry<String, List<String>> header : originalHeaders.entrySet()) {
if (!this.headerFilter.excludeHeader(header.getKey())) {
processedHeaders.put(header.getKey(), header.getValue());
}
}
return processedHeaders;
}
}

37
spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/HeadersModifyingOperationPreprocessor.java
View File

@@ -30,10 +30,12 @@ import org.springframework.restdocs.operation.OperationResponseFactory;
import org.springframework.util.Assert;
/**
* An {@link OperationPreprocessor} that can be used to modify a request's
* {@link OperationRequest#getHeaders()} by adding, setting, and removing headers.
* An {@link OperationPreprocessor} that modifies a request or response by adding,
* setting, or removing headers.
*
* @author Jihoon Cha
* @author Andy Wilkinson
* @since 3.0.0
*/
public class HeadersModifyingOperationPreprocessor implements OperationPreprocessor {
@@ -45,32 +47,21 @@ public class HeadersModifyingOperationPreprocessor implements OperationPreproces
@Override
public OperationRequest preprocess(OperationRequest request) {
HttpHeaders headers = copyHttpHeaders(request.getHeaders());
for (Modification modification : this.modifications) {
modification.applyTo(headers);
}
return this.requestFactory.createFrom(request, headers);
return this.requestFactory.createFrom(request, preprocess(request.getHeaders()));
}
@Override
public OperationResponse preprocess(OperationResponse response) {
HttpHeaders headers = copyHttpHeaders(response.getHeaders());
for (Modification modification : this.modifications) {
modification.applyTo(headers);
}
return this.responseFactory.createFrom(response, headers);
return this.responseFactory.createFrom(response, preprocess(response.getHeaders()));
}
private HttpHeaders copyHttpHeaders(HttpHeaders headers) {
HttpHeaders copy = new HttpHeaders();
for (String name : headers.keySet()) {
List<String> values = headers.get(name);
if (values == null) {
continue;
}
copy.put(name, new ArrayList<>(values));
private HttpHeaders preprocess(HttpHeaders headers) {
HttpHeaders modifiedHeaders = new HttpHeaders();
modifiedHeaders.putAll(headers);
for (Modification modification : this.modifications) {
modification.applyTo(modifiedHeaders);
}
return copy;
return modifiedHeaders;
}
/**
@@ -123,8 +114,8 @@ public class HeadersModifyingOperationPreprocessor implements OperationPreproces
* @return {@code this}
* @see Matcher#matches()
*/
public HeadersModifyingOperationPreprocessor remove(Pattern namePattern) {
this.modifications.add(new RemoveHeadersByNamePatternModification(namePattern));
public HeadersModifyingOperationPreprocessor removeMatching(String namePattern) {
this.modifications.add(new RemoveHeadersByNamePatternModification(Pattern.compile(namePattern)));
return this;
}

19
spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/Preprocessors.java
View File

@@ -74,12 +74,17 @@ public final class Preprocessors {
* {@code headersToRemove}.
* @param headerNames the header names
* @return the preprocessor
* @deprecated Use {@link #modifyHeaders()} instead
* @deprecated since 3.0.0 in favor of {@link #modifyHeaders()} and
* {@link HeadersModifyingOperationPreprocessor#remove(String)}
* @see String#equals(Object)
*/
@Deprecated
public static OperationPreprocessor removeHeaders(String... headerNames) {
return new HeaderRemovingOperationPreprocessor(new ExactMatchHeaderFilter(headerNames));
HeadersModifyingOperationPreprocessor preprocessor = new HeadersModifyingOperationPreprocessor();
for (String headerName : headerNames) {
preprocessor.remove(headerName);
}
return preprocessor;
}
/**
@@ -88,12 +93,17 @@ public final class Preprocessors {
* {@code headerNamePatterns} regular expressions.
* @param headerNamePatterns the header name patterns
* @return the preprocessor
* @deprecated Use {@link #modifyHeaders()} instead
* @deprecated since 3.0.0 in favor of {@link #modifyHeaders()} and
* {@link HeadersModifyingOperationPreprocessor#removeMatching(String)}
* @see java.util.regex.Matcher#matches()
*/
@Deprecated
public static OperationPreprocessor removeMatchingHeaders(String... headerNamePatterns) {
return new HeaderRemovingOperationPreprocessor(new PatternMatchHeaderFilter(headerNamePatterns));
HeadersModifyingOperationPreprocessor preprocessor = new HeadersModifyingOperationPreprocessor();
for (String headerNamePattern : headerNamePatterns) {
preprocessor.removeMatching(headerNamePattern);
}
return preprocessor;
}
/**
@@ -141,6 +151,7 @@ public final class Preprocessors {
* Returns a {@code HeadersModifyingOperationPreprocessor} that can then be configured
* to modify the headers of the request.
* @return the preprocessor
* @since 3.0.0
*/
public static HeadersModifyingOperationPreprocessor modifyHeaders() {
return new HeadersModifyingOperationPreprocessor();

104
spring-restdocs-core/src/test/java/org/springframework/restdocs/operation/preprocess/HeaderRemovingOperationPreprocessorTests.java
View File

@@ -1,104 +0,0 @@
/*
* Copyright 2014-2019 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
*
* https://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.operation.preprocess;
import java.net.URI;
import java.util.Arrays;
import java.util.Collections;
import org.junit.Test;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.restdocs.operation.OperationRequest;
import org.springframework.restdocs.operation.OperationRequestFactory;
import org.springframework.restdocs.operation.OperationRequestPart;
import org.springframework.restdocs.operation.OperationResponse;
import org.springframework.restdocs.operation.OperationResponseFactory;
import org.springframework.restdocs.operation.Parameters;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link HeaderRemovingOperationPreprocessorTests}.
*
* @author Andy Wilkinson
* @author Roland Huss
*/
public class HeaderRemovingOperationPreprocessorTests {
private final OperationRequestFactory requestFactory = new OperationRequestFactory();
private final OperationResponseFactory responseFactory = new OperationResponseFactory();
private final HeaderRemovingOperationPreprocessor preprocessor = new HeaderRemovingOperationPreprocessor(
new ExactMatchHeaderFilter("b"));
@Test
public void modifyRequestHeaders() {
OperationRequest request = this.requestFactory.create(URI.create("http://localhost"), HttpMethod.GET,
new byte[0], getHttpHeaders(), new Parameters(), Collections.<OperationRequestPart>emptyList());
OperationRequest preprocessed = this.preprocessor.preprocess(request);
assertThat(preprocessed.getHeaders().size()).isEqualTo(2);
assertThat(preprocessed.getHeaders()).containsEntry("a", Arrays.asList("alpha"));
assertThat(preprocessed.getHeaders()).containsEntry("Host", Arrays.asList("localhost"));
}
@Test
public void modifyResponseHeaders() {
OperationResponse response = createResponse();
OperationResponse preprocessed = this.preprocessor.preprocess(response);
assertThat(preprocessed.getHeaders().size()).isEqualTo(1);
assertThat(preprocessed.getHeaders()).containsEntry("a", Arrays.asList("alpha"));
}
@Test
public void modifyWithPattern() {
OperationResponse response = createResponse("content-length", "1234");
HeaderRemovingOperationPreprocessor processor = new HeaderRemovingOperationPreprocessor(
new PatternMatchHeaderFilter("co.*le(.)gth]"));
OperationResponse preprocessed = processor.preprocess(response);
assertThat(preprocessed.getHeaders().size()).isEqualTo(2);
assertThat(preprocessed.getHeaders()).containsEntry("a", Arrays.asList("alpha"));
assertThat(preprocessed.getHeaders()).containsEntry("b", Arrays.asList("bravo", "banana"));
}
@Test
public void removeAllHeaders() {
HeaderRemovingOperationPreprocessor processor = new HeaderRemovingOperationPreprocessor(
new PatternMatchHeaderFilter(".*"));
OperationResponse preprocessed = processor.preprocess(createResponse());
assertThat(preprocessed.getHeaders().size()).isEqualTo(0);
}
private OperationResponse createResponse(String... extraHeaders) {
return this.responseFactory.create(HttpStatus.OK.value(), getHttpHeaders(extraHeaders), new byte[0]);
}
private HttpHeaders getHttpHeaders(String... extraHeaders) {
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.add("a", "alpha");
httpHeaders.add("b", "bravo");
httpHeaders.add("b", "banana");
for (int i = 0; i < extraHeaders.length; i += 2) {
httpHeaders.add(extraHeaders[i], extraHeaders[i + 1]);
}
return httpHeaders;
}
}

128
spring-restdocs-core/src/test/java/org/springframework/restdocs/operation/preprocess/HeadersModifyingOperationPreprocessorTests.java
View File

@@ -19,7 +19,8 @@ package org.springframework.restdocs.operation.preprocess;
import java.net.URI;
import java.util.Arrays;
import java.util.Collections;
import java.util.regex.Pattern;
import java.util.List;
import java.util.function.Consumer;
import org.junit.Test;
@@ -38,6 +39,7 @@ import static org.assertj.core.api.Assertions.assertThat;
* Tests for {@link HeadersModifyingOperationPreprocessor}.
*
* @author Jihoon Cha
* @author Andy Wilkinson
*/
public class HeadersModifyingOperationPreprocessorTests {
@@ -45,110 +47,120 @@ public class HeadersModifyingOperationPreprocessorTests {
@Test
public void addNewHeader() {
HttpHeaders headers = new HttpHeaders();
OperationPreprocessor preprocessor = this.preprocessor.add("a", "alpha");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).containsEntry("a",
this.preprocessor.add("a", "alpha");
assertThat(this.preprocessor.preprocess(createRequest()).getHeaders()).containsEntry("a",
Arrays.asList("alpha"));
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).containsEntry("a",
assertThat(this.preprocessor.preprocess(createResponse()).getHeaders()).containsEntry("a",
Arrays.asList("alpha"));
}
@Test
public void addValueToExistingHeader() {
HttpHeaders headers = new HttpHeaders();
headers.add("a", "apple");
OperationPreprocessor preprocessor = this.preprocessor.add("a", "alpha");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).containsEntry("a",
Arrays.asList("apple", "alpha"));
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).containsEntry("a",
Arrays.asList("apple", "alpha"));
this.preprocessor.add("a", "alpha");
assertThat(this.preprocessor.preprocess(createRequest((headers) -> headers.add("a", "apple"))).getHeaders())
.containsEntry("a", Arrays.asList("apple", "alpha"));
assertThat(this.preprocessor.preprocess(createResponse((headers) -> headers.add("a", "apple"))).getHeaders())
.containsEntry("a", Arrays.asList("apple", "alpha"));
}
@Test
public void setNewHeader() {
HttpHeaders headers = new HttpHeaders();
OperationPreprocessor preprocessor = this.preprocessor.set("a", "alpha", "avocado");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).containsEntry("a",
this.preprocessor.set("a", "alpha", "avocado");
assertThat(this.preprocessor.preprocess(createRequest()).getHeaders()).containsEntry("a",
Arrays.asList("alpha", "avocado"));
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).containsEntry("a",
assertThat(this.preprocessor.preprocess(createResponse()).getHeaders()).containsEntry("a",
Arrays.asList("alpha", "avocado"));
}
@Test
public void setExistingHeader() {
HttpHeaders headers = new HttpHeaders();
headers.add("a", "apple");
OperationPreprocessor preprocessor = this.preprocessor.set("a", "alpha", "avocado");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).containsEntry("a",
Arrays.asList("alpha", "avocado"));
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).containsEntry("a",
Arrays.asList("alpha", "avocado"));
this.preprocessor.set("a", "alpha", "avocado");
assertThat(this.preprocessor.preprocess(createRequest((headers) -> headers.add("a", "apple"))).getHeaders())
.containsEntry("a", Arrays.asList("alpha", "avocado"));
assertThat(this.preprocessor.preprocess(createResponse((headers) -> headers.add("a", "apple"))).getHeaders())
.containsEntry("a", Arrays.asList("alpha", "avocado"));
}
@Test
public void removeNonExistentHeader() {
HttpHeaders headers = new HttpHeaders();
OperationPreprocessor preprocessor = this.preprocessor.remove("a");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).doesNotContainKey("a");
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).doesNotContainKey("a");
this.preprocessor.remove("a");
assertThat(this.preprocessor.preprocess(createRequest()).getHeaders()).doesNotContainKey("a");
assertThat(this.preprocessor.preprocess(createResponse()).getHeaders()).doesNotContainKey("a");
}
@Test
public void removeHeader() {
HttpHeaders headers = new HttpHeaders();
headers.add("a", "apple");
OperationPreprocessor preprocessor = this.preprocessor.remove("a");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).doesNotContainKey("a");
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).doesNotContainKey("a");
assertThat(preprocessor.preprocess(createRequest((headers) -> headers.add("a", "apple"))).getHeaders())
.doesNotContainKey("a");
assertThat(preprocessor.preprocess(createResponse((headers) -> headers.add("a", "apple"))).getHeaders())
.doesNotContainKey("a");
}
@Test
public void removeHeaderValueForNonExistentHeader() {
HttpHeaders headers = new HttpHeaders();
OperationPreprocessor preprocessor = this.preprocessor.remove("a", "apple");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).doesNotContainKey("a");
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).doesNotContainKey("a");
this.preprocessor.remove("a", "apple");
assertThat(this.preprocessor.preprocess(createRequest()).getHeaders()).doesNotContainKey("a");
assertThat(this.preprocessor.preprocess(createResponse()).getHeaders()).doesNotContainKey("a");
}
@Test
public void removeHeaderValueWithMultipleValues() {
HttpHeaders headers = new HttpHeaders();
headers.add("a", "apple");
headers.add("a", "alpha");
OperationPreprocessor preprocessor = this.preprocessor.remove("a", "apple");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).containsEntry("a",
Arrays.asList("alpha"));
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).containsEntry("a",
Arrays.asList("alpha"));
this.preprocessor.remove("a", "apple");
assertThat(this.preprocessor
.preprocess(createRequest((headers) -> headers.addAll("a", List.of("apple", "alpha")))).getHeaders())
.containsEntry("a", Arrays.asList("alpha"));
assertThat(this.preprocessor
.preprocess(createResponse((headers) -> headers.addAll("a", List.of("apple", "alpha")))).getHeaders())
.containsEntry("a", Arrays.asList("alpha"));
}
@Test
public void removeHeaderValueWithSingleValueRemovesEntryEntirely() {
HttpHeaders headers = new HttpHeaders();
headers.add("a", "apple");
OperationPreprocessor preprocessor = this.preprocessor.remove("a", "apple");
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders()).doesNotContainKey("a");
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders()).doesNotContainKey("a");
this.preprocessor.remove("a", "apple");
assertThat(this.preprocessor.preprocess(createRequest((headers) -> headers.add("a", "apple"))).getHeaders())
.doesNotContainKey("a");
assertThat(this.preprocessor.preprocess(createResponse((headers) -> headers.add("a", "apple"))).getHeaders())
.doesNotContainKey("a");
}
@Test
public void removeHeadersByNamePattern() {
HttpHeaders headers = new HttpHeaders();
headers.add("apple", "apple");
headers.add("alpha", "alpha");
headers.add("avocado", "avocado");
headers.add("bravo", "bravo");
OperationPreprocessor preprocessor = this.preprocessor.remove(Pattern.compile("^a.*"));
assertThat(preprocessor.preprocess(createRequest(headers)).getHeaders().size()).isEqualTo(2);
assertThat(preprocessor.preprocess(createResponse(headers)).getHeaders().size()).isEqualTo(1);
Consumer<HttpHeaders> headersCustomizer = (headers) -> {
headers.add("apple", "apple");
headers.add("alpha", "alpha");
headers.add("avocado", "avocado");
headers.add("bravo", "bravo");
};
this.preprocessor.removeMatching("^a.*");
assertThat(this.preprocessor.preprocess(createRequest(headersCustomizer)).getHeaders()).containsOnlyKeys("Host",
"bravo");
assertThat(this.preprocessor.preprocess(createResponse(headersCustomizer)).getHeaders())
.containsOnlyKeys("bravo");
}
private OperationRequest createRequest(HttpHeaders headers) {
private OperationRequest createRequest() {
return createRequest(null);
}
private OperationRequest createRequest(Consumer<HttpHeaders> headersCustomizer) {
HttpHeaders headers = new HttpHeaders();
if (headersCustomizer != null) {
headersCustomizer.accept(headers);
}
return new OperationRequestFactory().create(URI.create("http://localhost:8080"), HttpMethod.GET, new byte[0],
headers, new Parameters(), Collections.emptyList());
}
private OperationResponse createResponse(HttpHeaders headers) {
private OperationResponse createResponse() {
return createResponse(null);
}
private OperationResponse createResponse(Consumer<HttpHeaders> headersCustomizer) {
HttpHeaders headers = new HttpHeaders();
if (headersCustomizer != null) {
headersCustomizer.accept(headers);
}
return new OperationResponseFactory().create(HttpStatus.OK.value(), headers, new byte[0]);
}