Ignore null header value in MockHttpServletResponse

Prior to this commit, calls to setHeader() and addHeader() in
MockHttpServletResponse would result in an IllegalArgumentException or
NullPointerException if the supplied header value was null.

Although the Javadoc for setHeader(String, String) and
addHeader(String, String) in javax.servlet.http.HttpServletResponse
does not specify how a null header value should be handled, both Tomcat
and Jetty simply ignore a null value. Furthermore,
org.springframework.http.HttpHeaders.add(String, String) declares the
headerValue parameter as @nullable.

This commit therefore updates MockHttpServletResponse to silently
ignore null header values passed to setHeader() and addHeader().

Closes gh-26488

Author: sbrannen

spring-test/src/main/java/org/springframework/mock/web/MockHttpServletResponse.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2021 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.
@@ -421,7 +421,7 @@ public Cookie getCookie(String name) {
 
 	@Override
 	public boolean containsHeader(String name) {
-		return (this.headers.get(name) != null);
+		return this.headers.containsKey(name);
 	}
 
 	/**
@@ -594,12 +594,12 @@ private DateFormat newDateFormat() {
 	}
 
 	@Override
-	public void setHeader(String name, String value) {
+	public void setHeader(String name, @Nullable String value) {
 		setHeaderValue(name, value);
 	}
 
 	@Override
-	public void addHeader(String name, String value) {
+	public void addHeader(String name, @Nullable String value) {
 		addHeaderValue(name, value);
 	}
 
@@ -613,15 +613,21 @@ public void addIntHeader(String name, int value) {
 		addHeaderValue(name, value);
 	}
 
-	private void setHeaderValue(String name, Object value) {
+	private void setHeaderValue(String name, @Nullable Object value) {
+		if (value == null) {
+			return;
+		}
 		boolean replaceHeader = true;
 		if (setSpecialHeader(name, value, replaceHeader)) {
 			return;
 		}
 		doAddHeaderValue(name, value, replaceHeader);
 	}
 
-	private void addHeaderValue(String name, Object value) {
+	private void addHeaderValue(String name, @Nullable Object value) {
+		if (value == null) {
+			return;
+		}
 		boolean replaceHeader = false;
 		if (setSpecialHeader(name, value, replaceHeader)) {
 			return;

spring-test/src/test/java/org/springframework/mock/web/MockHttpServletResponseTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2021 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.
@@ -26,6 +26,8 @@
 import javax.servlet.http.HttpServletResponse;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
 import org.springframework.web.util.WebUtils;
 
@@ -57,6 +59,32 @@ class MockHttpServletResponseTests {
 	private MockHttpServletResponse response = new MockHttpServletResponse();
 
 
+	@ParameterizedTest  // gh-26488
+	@ValueSource(strings = {
+		CONTENT_TYPE,
+		CONTENT_LENGTH,
+		CONTENT_LANGUAGE,
+		SET_COOKIE,
+		"enigma"
+	})
+	void addHeaderWithNullValue(String headerName) {
+		response.addHeader(headerName, null);
+		assertThat(response.containsHeader(headerName)).isFalse();
+	}
+
+	@ParameterizedTest  // gh-26488
+	@ValueSource(strings = {
+		CONTENT_TYPE,
+		CONTENT_LENGTH,
+		CONTENT_LANGUAGE,
+		SET_COOKIE,
+		"enigma"
+	})
+	void setHeaderWithNullValue(String headerName) {
+		response.setHeader(headerName, null);
+		assertThat(response.containsHeader(headerName)).isFalse();
+	}
+
 	@Test
 	void setContentType() {
 		String contentType = "test/plain";

spring-web/src/testFixtures/java/org/springframework/web/testfixture/servlet/MockHttpServletResponse.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2021 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.
@@ -421,7 +421,7 @@ public Cookie getCookie(String name) {
 
 	@Override
 	public boolean containsHeader(String name) {
-		return (this.headers.get(name) != null);
+		return this.headers.containsKey(name);
 	}
 
 	/**
@@ -594,12 +594,12 @@ private DateFormat newDateFormat() {
 	}
 
 	@Override
-	public void setHeader(String name, String value) {
+	public void setHeader(String name, @Nullable String value) {
 		setHeaderValue(name, value);
 	}
 
 	@Override
-	public void addHeader(String name, String value) {
+	public void addHeader(String name, @Nullable String value) {
 		addHeaderValue(name, value);
 	}
 
@@ -613,15 +613,21 @@ public void addIntHeader(String name, int value) {
 		addHeaderValue(name, value);
 	}
 
-	private void setHeaderValue(String name, Object value) {
+	private void setHeaderValue(String name, @Nullable Object value) {
+		if (value == null) {
+			return;
+		}
 		boolean replaceHeader = true;
 		if (setSpecialHeader(name, value, replaceHeader)) {
 			return;
 		}
 		doAddHeaderValue(name, value, replaceHeader);
 	}
 
-	private void addHeaderValue(String name, Object value) {
+	private void addHeaderValue(String name, @Nullable Object value) {
+		if (value == null) {
+			return;
+		}
 		boolean replaceHeader = false;
 		if (setSpecialHeader(name, value, replaceHeader)) {
 			return;