Add headerDoesNotExist() to MockRestRequestMatchers

sbrannen · sbrannen · commit 06563d8b4b9e · 2019-09-27T17:38:11.000+02:00
Prior to this commit, one could not test for the absence of a specific HTTP header in a request. This commit adds a headerDoesNotExist() method in MockRestRequestMatchers. Closes spring-projectsgh-23721
diff --git a/spring-test/src/main/java/org/springframework/test/web/client/match/MockRestRequestMatchers.java b/spring-test/src/main/java/org/springframework/test/web/client/match/MockRestRequestMatchers.java
@@ -185,6 +185,20 @@ public static RequestMatcher header(String name, String... expectedValues) {
 		};
 	}
 
+	/**
+	 * Assert that the given request header does not exist.
+	 * @since 5.2
+	 */
+	public static RequestMatcher headerDoesNotExist(String name) {
+		return request -> {
+			List<String> headerValues = request.getHeaders().get(name);
+			if (headerValues != null) {
+				fail("Expected header <" + name + "> not to exist, but it exists with values: " +
+						headerValues);
+			}
+		};
+	}
+
 	/**
 	 * Access to request body matchers.
 	 */
diff --git a/spring-test/src/test/java/org/springframework/test/web/client/match/MockRestRequestMatchersTests.java b/spring-test/src/test/java/org/springframework/test/web/client/match/MockRestRequestMatchersTests.java
@@ -19,6 +19,7 @@
 import java.net.URI;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.List;
 
 import org.junit.jupiter.api.Test;
 
@@ -93,6 +94,19 @@ public void header() throws Exception {
 		MockRestRequestMatchers.header("foo", "bar", "baz").match(this.request);
 	}
 
+	@Test
+	public void headerDoesNotExist() throws Exception {
+		MockRestRequestMatchers.headerDoesNotExist(null).match(this.request);
+		MockRestRequestMatchers.headerDoesNotExist("").match(this.request);
+		MockRestRequestMatchers.headerDoesNotExist("foo").match(this.request);
+
+		List<String> values = Arrays.asList("bar", "baz");
+		this.request.getHeaders().put("foo", values);
+		assertThatThrownBy(() -> MockRestRequestMatchers.headerDoesNotExist("foo").match(this.request))
+			.isInstanceOf(AssertionError.class)
+			.hasMessage("Expected header <foo> not to exist, but it exists with values: " + values);
+	}
+
 	@Test
 	public void headerMissing() throws Exception {
 		assertThatThrownBy(() -> MockRestRequestMatchers.header("foo", "bar").match(this.request))
