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

Allow MockRest to match header/queryParam value list with one Matcher

Browse Source 
This commit adds a `header` variant and a `queryParam` variant to the
`MockRestRequestMatchers` API which take a single `Matcher` over the
list of values.

Contrary to the vararg variants, the whole list is evaluated and the
caller can choose the desired semantics using readily-available iterable
matchers like `everyItem`, `hasItems`, `hasSize`, `contains` or
`containsInAnyOrder`...

The fact that the previous variants don't strictly check the size of the
actual list == the number of provided matchers or expected values is
now documented in their respective javadocs.

See gh-28660
Closes gh-29953
This commit is contained in:
Simon Baslé
2023-02-13 17:51:01 +01:00
committed by GitHub
parent 79a1fcb099
commit 189d4e3e4c
2 changed files with 199 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
spring-test/src/main/java/org/springframework/test/web/client/match/MockRestRequestMatchers.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2023 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.
@@ -23,6 +23,7 @@ import java.util.Map;
import javax.xml.xpath.XPathExpressionException;
import org.hamcrest.Matcher;
import org.hamcrest.Matchers;
import org.springframework.http.HttpMethod;
import org.springframework.http.client.ClientHttpRequest;
@@ -114,6 +115,11 @@ public abstract class MockRestRequestMatchers {
/**
* Assert request query parameter values with the given Hamcrest matcher(s).
* <p> Note that if the queryParam value list is larger than the number of provided
* {@code matchers}, extra values are considered acceptable.
* See {@link #queryParam(String, Matcher)} for a variant that takes a
* {@code Matcher} over the whole list of values.
* @see #queryParam(String, Matcher)
*/
@SafeVarargs
public static RequestMatcher queryParam(String name, Matcher<? super String>... matchers) {
@@ -128,6 +134,11 @@ public abstract class MockRestRequestMatchers {
/**
* Assert request query parameter values.
* <p> Note that if the queryParam value list is larger than {@code expectedValues},
* extra values are considered acceptable.
* See {@link #queryParam(String, Matcher)} for a variant that takes a
* {@code Matcher} over the whole list of values.
* @see #queryParam(String, Matcher)
*/
public static RequestMatcher queryParam(String name, String... expectedValues) {
return request -> {
@@ -139,6 +150,29 @@ public abstract class MockRestRequestMatchers {
};
}
/**
* Assert request query parameter, matching on the whole {@code List} of values.
* <p> This can be used to check that the list has at least one value matching a
* criteria ({@link Matchers#hasItem(Matcher)}), or that every value in the list
* matches a common criteria ({@link Matchers#everyItem(Matcher)}), or that each
* value in the list matches its corresponding dedicated criteria
* ({@link Matchers#contains(Matcher[])}, and more.
* @param name the name of the queryParam to consider
* @param matcher the matcher to apply to the whole list of values for that header
* @since 6.0.5
*/
public static RequestMatcher queryParam(String name, Matcher<? super List<String>> matcher) {
return request -> {
MultiValueMap<String, String> params = getQueryParams(request);
List<String> paramValues = params.get(name);
if (paramValues == null) {
fail("No queryParam [" + name + "]");
}
assertThat("Request queryParam values for [" + name + "]", paramValues, matcher);
};
}
private static MultiValueMap<String, String> getQueryParams(ClientHttpRequest request) {
return UriComponentsBuilder.fromUri(request.getURI()).build().getQueryParams();
}
@@ -158,6 +192,11 @@ public abstract class MockRestRequestMatchers {
/**
* Assert request header values with the given Hamcrest matcher(s).
* <p> Note that if the header's value list is larger than the number of provided
* {@code matchers}, extra values are considered acceptable.
* See {@link #header(String, Matcher)} for a variant that takes a {@code Matcher}
* over the whole list of values.
* @see #header(String, Matcher)
*/
@SafeVarargs
public static RequestMatcher header(String name, Matcher<? super String>... matchers) {
@@ -173,6 +212,11 @@ public abstract class MockRestRequestMatchers {
/**
* Assert request header values.
* <p> Note that if the header's value list is larger than {@code expectedValues},
* extra values are considered acceptable.
* See {@link #header(String, Matcher)} for a variant that takes a {@code Matcher}
* over the whole list of values.
* @see #header(String, Matcher)
*/
public static RequestMatcher header(String name, String... expectedValues) {
return request -> {
@@ -185,6 +229,27 @@ public abstract class MockRestRequestMatchers {
};
}
/**
* Assert request header, matching on the whole {@code List} of values.
* <p> This can be used to check that the list has at least one value matching a
* criteria ({@link Matchers#hasItem(Matcher)}), or that every value in the list
* matches a common criteria ({@link Matchers#everyItem(Matcher)}), or that each
* value in the list matches its corresponding dedicated criteria
* ({@link Matchers#contains(Matcher[])}, and more.
* @param name the name of the header to consider
* @param matcher the matcher to apply to the whole list of values for that header
* @since 6.0.5
*/
public static RequestMatcher header(String name, Matcher<? super List<String>> matcher) {
return request -> {
List<String> headerValues = request.getHeaders().get(name);
if (headerValues == null) {
fail("No header values for header [" + name + "]");
}
assertThat("Request header values for [" + name + "]", headerValues, matcher);
};
}
/**
* Assert that the given request header does not exist.
* @since 5.2