Leverage RFC_1123_DATE_TIME formatter in tests

Issue: SPR-15661
This commit is contained in:
Sebastien Deleuze 2017-07-02 22:31:28 +02:00
parent f790337880
commit 1fa8410995
5 changed files with 46 additions and 53 deletions

View File

@ -23,16 +23,16 @@ import java.io.OutputStreamWriter;
import java.io.PrintWriter; import java.io.PrintWriter;
import java.io.UnsupportedEncodingException; import java.io.UnsupportedEncodingException;
import java.io.Writer; import java.io.Writer;
import java.text.ParseException; import java.time.Instant;
import java.text.SimpleDateFormat; import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.format.DateTimeParseException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.Date;
import java.util.List; import java.util.List;
import java.util.Locale; import java.util.Locale;
import java.util.Map; import java.util.Map;
import java.util.TimeZone;
import javax.servlet.ServletOutputStream; import javax.servlet.ServletOutputStream;
import javax.servlet.http.Cookie; import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
@ -44,6 +44,8 @@ import org.springframework.util.LinkedCaseInsensitiveMap;
import org.springframework.util.StringUtils; import org.springframework.util.StringUtils;
import org.springframework.web.util.WebUtils; import org.springframework.web.util.WebUtils;
import static java.time.format.DateTimeFormatter.*;
/** /**
* Mock implementation of the {@link javax.servlet.http.HttpServletResponse} interface. * Mock implementation of the {@link javax.servlet.http.HttpServletResponse} interface.
* *
@ -58,9 +60,7 @@ public class MockHttpServletResponse implements HttpServletResponse {
private static final String CHARSET_PREFIX = "charset="; private static final String CHARSET_PREFIX = "charset=";
private static final String DATE_FORMAT = "EEE, dd MMM yyyy HH:mm:ss zzz"; private static final ZoneId GMT = ZoneId.of("GMT");
private static final TimeZone GMT = TimeZone.getTimeZone("GMT");
//--------------------------------------------------------------------- //---------------------------------------------------------------------
@ -508,12 +508,10 @@ public class MockHttpServletResponse implements HttpServletResponse {
} }
public long getDateHeader(String name) { public long getDateHeader(String name) {
SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT, Locale.US);
dateFormat.setTimeZone(GMT);
try { try {
return dateFormat.parse(getHeader(name)).getTime(); return ZonedDateTime.parse(getHeader(name), RFC_1123_DATE_TIME).toInstant().toEpochMilli();
} }
catch (ParseException ex) { catch (DateTimeParseException ex) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Value for header '" + name + "' is not a valid Date: " + getHeader(name)); "Value for header '" + name + "' is not a valid Date: " + getHeader(name));
} }
@ -525,9 +523,9 @@ public class MockHttpServletResponse implements HttpServletResponse {
} }
private String formatDate(long date) { private String formatDate(long date) {
SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT, Locale.US); Instant instant = Instant.ofEpochMilli(date);
dateFormat.setTimeZone(GMT); ZonedDateTime zonedDateTime = ZonedDateTime.ofInstant(instant, GMT);
return dateFormat.format(new Date(date)); return RFC_1123_DATE_TIME.format(zonedDateTime);
} }
@Override @Override

View File

@ -16,11 +16,11 @@
package org.springframework.web.context.request; package org.springframework.web.context.request;
import java.text.SimpleDateFormat; import java.time.Instant;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.Arrays; import java.util.Arrays;
import java.util.Date; import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;
import org.junit.Before; import org.junit.Before;
import org.junit.Test; import org.junit.Test;
@ -32,6 +32,7 @@ import org.junit.runners.Parameterized.Parameters;
import org.springframework.mock.web.test.MockHttpServletRequest; import org.springframework.mock.web.test.MockHttpServletRequest;
import org.springframework.mock.web.test.MockHttpServletResponse; import org.springframework.mock.web.test.MockHttpServletResponse;
import static java.time.format.DateTimeFormatter.*;
import static org.junit.Assert.*; import static org.junit.Assert.*;
/** /**
@ -43,9 +44,9 @@ import static org.junit.Assert.*;
@RunWith(Parameterized.class) @RunWith(Parameterized.class)
public class ServletWebRequestHttpMethodsTests { public class ServletWebRequestHttpMethodsTests {
private static final String CURRENT_TIME = "Wed, 09 Apr 2014 09:57:42 GMT"; private static final ZoneId GMT = ZoneId.of("GMT");
private SimpleDateFormat dateFormat; private static final String CURRENT_TIME = "Wed, 9 Apr 2014 09:57:42 GMT";
private MockHttpServletRequest servletRequest; private MockHttpServletRequest servletRequest;
@ -70,8 +71,6 @@ public class ServletWebRequestHttpMethodsTests {
@Before @Before
public void setup() { public void setup() {
currentDate = new Date(); currentDate = new Date();
dateFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US);
dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
servletRequest = new MockHttpServletRequest(method, "http://example.org"); servletRequest = new MockHttpServletRequest(method, "http://example.org");
servletResponse = new MockHttpServletResponse(); servletResponse = new MockHttpServletResponse();
request = new ServletWebRequest(servletRequest, servletResponse); request = new ServletWebRequest(servletRequest, servletResponse);
@ -127,7 +126,7 @@ public class ServletWebRequestHttpMethodsTests {
assertTrue(request.checkNotModified(epochTime)); assertTrue(request.checkNotModified(epochTime));
assertEquals(304, servletResponse.getStatus()); assertEquals(304, servletResponse.getStatus());
assertEquals(dateFormat.format(epochTime), servletResponse.getHeader("Last-Modified")); assertEquals(RFC_1123_DATE_TIME.format(Instant.ofEpochMilli(epochTime).atZone(GMT)), servletResponse.getHeader("Last-Modified"));
} }
@Test @Test
@ -138,7 +137,7 @@ public class ServletWebRequestHttpMethodsTests {
assertFalse(request.checkNotModified(currentDate.getTime())); assertFalse(request.checkNotModified(currentDate.getTime()));
assertEquals(200, servletResponse.getStatus()); assertEquals(200, servletResponse.getStatus());
assertEquals(dateFormat.format(currentDate.getTime()), servletResponse.getHeader("Last-Modified")); assertEquals(RFC_1123_DATE_TIME.format(currentDate.toInstant().atZone(GMT)), servletResponse.getHeader("Last-Modified"));
} }
@Test @Test
@ -221,7 +220,7 @@ public class ServletWebRequestHttpMethodsTests {
assertEquals(304, servletResponse.getStatus()); assertEquals(304, servletResponse.getStatus());
assertEquals(eTag, servletResponse.getHeader("ETag")); assertEquals(eTag, servletResponse.getHeader("ETag"));
assertEquals(dateFormat.format(currentDate.getTime()), servletResponse.getHeader("Last-Modified")); assertEquals(RFC_1123_DATE_TIME.format(currentDate.toInstant().atZone(GMT)), servletResponse.getHeader("Last-Modified"));
} }
@Test // SPR-14224 @Test // SPR-14224
@ -236,7 +235,7 @@ public class ServletWebRequestHttpMethodsTests {
assertEquals(304, servletResponse.getStatus()); assertEquals(304, servletResponse.getStatus());
assertEquals(eTag, servletResponse.getHeader("ETag")); assertEquals(eTag, servletResponse.getHeader("ETag"));
assertEquals(dateFormat.format(currentEpoch), servletResponse.getHeader("Last-Modified")); assertEquals(RFC_1123_DATE_TIME.format(Instant.ofEpochMilli(currentEpoch).atZone(GMT)), servletResponse.getHeader("Last-Modified"));
} }
@Test @Test
@ -251,7 +250,7 @@ public class ServletWebRequestHttpMethodsTests {
assertEquals(200, servletResponse.getStatus()); assertEquals(200, servletResponse.getStatus());
assertEquals(currentETag, servletResponse.getHeader("ETag")); assertEquals(currentETag, servletResponse.getHeader("ETag"));
assertEquals(dateFormat.format(epochTime), servletResponse.getHeader("Last-Modified")); assertEquals(RFC_1123_DATE_TIME.format(Instant.ofEpochMilli(epochTime).atZone(GMT)), servletResponse.getHeader("Last-Modified"));
} }
@Test @Test
@ -291,26 +290,26 @@ public class ServletWebRequestHttpMethodsTests {
@Test @Test
public void checkNotModifiedTimestampWithLengthPart() throws Exception { public void checkNotModifiedTimestampWithLengthPart() throws Exception {
long epochTime = dateFormat.parse(CURRENT_TIME).getTime(); long epochTime = ZonedDateTime.parse(CURRENT_TIME, RFC_1123_DATE_TIME).toInstant().toEpochMilli();
servletRequest.setMethod("GET"); servletRequest.setMethod("GET");
servletRequest.addHeader("If-Modified-Since", "Wed, 09 Apr 2014 09:57:42 GMT; length=13774"); servletRequest.addHeader("If-Modified-Since", "Wed, 09 Apr 2014 09:57:42 GMT; length=13774");
assertTrue(request.checkNotModified(epochTime)); assertTrue(request.checkNotModified(epochTime));
assertEquals(304, servletResponse.getStatus()); assertEquals(304, servletResponse.getStatus());
assertEquals(dateFormat.format(epochTime), servletResponse.getHeader("Last-Modified")); assertEquals(RFC_1123_DATE_TIME.format(Instant.ofEpochMilli(epochTime).atZone(GMT)), servletResponse.getHeader("Last-Modified"));
} }
@Test @Test
public void checkModifiedTimestampWithLengthPart() throws Exception { public void checkModifiedTimestampWithLengthPart() throws Exception {
long epochTime = dateFormat.parse(CURRENT_TIME).getTime(); long epochTime = ZonedDateTime.parse(CURRENT_TIME, RFC_1123_DATE_TIME).toInstant().toEpochMilli();
servletRequest.setMethod("GET"); servletRequest.setMethod("GET");
servletRequest.addHeader("If-Modified-Since", "Wed, 08 Apr 2014 09:57:42 GMT; length=13774"); servletRequest.addHeader("If-Modified-Since", "Wed, 08 Apr 2014 09:57:42 GMT; length=13774");
assertFalse(request.checkNotModified(epochTime)); assertFalse(request.checkNotModified(epochTime));
assertEquals(200, servletResponse.getStatus()); assertEquals(200, servletResponse.getStatus());
assertEquals(dateFormat.format(epochTime), servletResponse.getHeader("Last-Modified")); assertEquals(RFC_1123_DATE_TIME.format(Instant.ofEpochMilli(epochTime).atZone(GMT)), servletResponse.getHeader("Last-Modified"));
} }
@Test @Test

View File

@ -178,7 +178,7 @@ public class DispatcherServletTests {
MockHttpServletResponse response = new MockHttpServletResponse(); MockHttpServletResponse response = new MockHttpServletResponse();
simpleDispatcherServlet.service(request, response); simpleDispatcherServlet.service(request, response);
assertTrue("Not forwarded", response.getForwardedUrl() == null); assertTrue("Not forwarded", response.getForwardedUrl() == null);
assertEquals("Wed, 01 Apr 2015 00:00:00 GMT", response.getHeader("Last-Modified")); assertEquals("Wed, 1 Apr 2015 00:00:00 GMT", response.getHeader("Last-Modified"));
} }
@Test @Test
@ -208,7 +208,7 @@ public class DispatcherServletTests {
assertTrue(request.getAttribute("test3") != null); assertTrue(request.getAttribute("test3") != null);
assertTrue(request.getAttribute("test3x") != null); assertTrue(request.getAttribute("test3x") != null);
assertTrue(request.getAttribute("test3y") != null); assertTrue(request.getAttribute("test3y") != null);
assertEquals("Wed, 01 Apr 2015 00:00:01 GMT", response.getHeader("Last-Modified")); assertEquals("Wed, 1 Apr 2015 00:00:01 GMT", response.getHeader("Last-Modified"));
} }
@Test @Test

View File

@ -19,13 +19,11 @@ package org.springframework.web.servlet.mvc.method.annotation;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.net.URI; import java.net.URI;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat; import java.time.ZoneId;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections; import java.util.Collections;
import java.util.Date; import java.util.Date;
import java.util.List; import java.util.List;
import java.util.Locale;
import java.util.TimeZone;
import org.junit.Before; import org.junit.Before;
import org.junit.Rule; import org.junit.Rule;
@ -54,6 +52,8 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.context.request.ServletWebRequest; import org.springframework.web.context.request.ServletWebRequest;
import org.springframework.web.method.support.ModelAndViewContainer; import org.springframework.web.method.support.ModelAndViewContainer;
import static java.time.Instant.*;
import static java.time.format.DateTimeFormatter.*;
import static org.junit.Assert.*; import static org.junit.Assert.*;
import static org.mockito.BDDMockito.*; import static org.mockito.BDDMockito.*;
import static org.springframework.web.servlet.HandlerMapping.*; import static org.springframework.web.servlet.HandlerMapping.*;
@ -70,11 +70,12 @@ import static org.springframework.web.servlet.HandlerMapping.*;
*/ */
public class HttpEntityMethodProcessorMockTests { public class HttpEntityMethodProcessorMockTests {
private static final ZoneId GMT = ZoneId.of("GMT");
@Rule @Rule
public ExpectedException thrown = ExpectedException.none(); public ExpectedException thrown = ExpectedException.none();
private SimpleDateFormat dateFormat;
private HttpEntityMethodProcessor processor; private HttpEntityMethodProcessor processor;
private HttpMessageConverter<String> stringHttpMessageConverter; private HttpMessageConverter<String> stringHttpMessageConverter;
@ -113,8 +114,6 @@ public class HttpEntityMethodProcessorMockTests {
@Before @Before
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public void setup() throws Exception { public void setup() throws Exception {
dateFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US);
dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
stringHttpMessageConverter = mock(HttpMessageConverter.class); stringHttpMessageConverter = mock(HttpMessageConverter.class);
given(stringHttpMessageConverter.getSupportedMediaTypes()).willReturn(Collections.singletonList(MediaType.TEXT_PLAIN)); given(stringHttpMessageConverter.getSupportedMediaTypes()).willReturn(Collections.singletonList(MediaType.TEXT_PLAIN));
@ -350,7 +349,7 @@ public class HttpEntityMethodProcessorMockTests {
public void shouldHandleLastModifiedWithHttp304() throws Exception { public void shouldHandleLastModifiedWithHttp304() throws Exception {
long currentTime = new Date().getTime(); long currentTime = new Date().getTime();
long oneMinuteAgo = currentTime - (1000 * 60); long oneMinuteAgo = currentTime - (1000 * 60);
servletRequest.addHeader(HttpHeaders.IF_MODIFIED_SINCE, dateFormat.format(currentTime)); servletRequest.addHeader(HttpHeaders.IF_MODIFIED_SINCE, RFC_1123_DATE_TIME.format(ofEpochMilli(currentTime).atZone(GMT)));
ResponseEntity<String> returnValue = ResponseEntity.ok().lastModified(oneMinuteAgo).body("body"); ResponseEntity<String> returnValue = ResponseEntity.ok().lastModified(oneMinuteAgo).body("body");
initStringMessageConversion(MediaType.TEXT_PLAIN); initStringMessageConversion(MediaType.TEXT_PLAIN);
@ -388,7 +387,7 @@ public class HttpEntityMethodProcessorMockTests {
long currentTime = new Date().getTime(); long currentTime = new Date().getTime();
long oneMinuteAgo = currentTime - (1000 * 60); long oneMinuteAgo = currentTime - (1000 * 60);
String etagValue = "\"deadb33f8badf00d\""; String etagValue = "\"deadb33f8badf00d\"";
servletRequest.addHeader(HttpHeaders.IF_MODIFIED_SINCE, dateFormat.format(currentTime)); servletRequest.addHeader(HttpHeaders.IF_MODIFIED_SINCE, RFC_1123_DATE_TIME.format(ofEpochMilli(currentTime).atZone(GMT)));
servletRequest.addHeader(HttpHeaders.IF_NONE_MATCH, etagValue); servletRequest.addHeader(HttpHeaders.IF_NONE_MATCH, etagValue);
ResponseEntity<String> returnValue = ResponseEntity.ok().eTag(etagValue).lastModified(oneMinuteAgo).body("body"); ResponseEntity<String> returnValue = ResponseEntity.ok().eTag(etagValue).lastModified(oneMinuteAgo).body("body");
@ -418,7 +417,7 @@ public class HttpEntityMethodProcessorMockTests {
long oneMinuteAgo = currentTime - (1000 * 60); long oneMinuteAgo = currentTime - (1000 * 60);
String etagValue = "\"deadb33f8badf00d\""; String etagValue = "\"deadb33f8badf00d\"";
String changedEtagValue = "\"changed-etag-value\""; String changedEtagValue = "\"changed-etag-value\"";
servletRequest.addHeader(HttpHeaders.IF_MODIFIED_SINCE, dateFormat.format(currentTime)); servletRequest.addHeader(HttpHeaders.IF_MODIFIED_SINCE, RFC_1123_DATE_TIME.format(ofEpochMilli(currentTime).atZone(GMT)));
servletRequest.addHeader(HttpHeaders.IF_NONE_MATCH, etagValue); servletRequest.addHeader(HttpHeaders.IF_NONE_MATCH, etagValue);
ResponseEntity<String> returnValue = ResponseEntity.ok() ResponseEntity<String> returnValue = ResponseEntity.ok()
.eTag(changedEtagValue).lastModified(oneMinuteAgo).body("body"); .eTag(changedEtagValue).lastModified(oneMinuteAgo).body("body");
@ -473,7 +472,7 @@ public class HttpEntityMethodProcessorMockTests {
public void shouldHandleIfNoneMatchIfUnmodifiedSince() throws Exception { public void shouldHandleIfNoneMatchIfUnmodifiedSince() throws Exception {
String etagValue = "\"some-etag\""; String etagValue = "\"some-etag\"";
servletRequest.addHeader(HttpHeaders.IF_NONE_MATCH, etagValue); servletRequest.addHeader(HttpHeaders.IF_NONE_MATCH, etagValue);
servletRequest.addHeader(HttpHeaders.IF_UNMODIFIED_SINCE, dateFormat.format(new Date().getTime())); servletRequest.addHeader(HttpHeaders.IF_UNMODIFIED_SINCE, RFC_1123_DATE_TIME.format(ofEpochMilli(new Date().getTime()).atZone(GMT)));
ResponseEntity<String> returnValue = ResponseEntity.ok().eTag(etagValue).body("body"); ResponseEntity<String> returnValue = ResponseEntity.ok().eTag(etagValue).body("body");
initStringMessageConversion(MediaType.TEXT_PLAIN); initStringMessageConversion(MediaType.TEXT_PLAIN);
@ -538,7 +537,7 @@ public class HttpEntityMethodProcessorMockTests {
} }
if (lastModified != -1) { if (lastModified != -1) {
assertEquals(1, servletResponse.getHeaderValues(HttpHeaders.LAST_MODIFIED).size()); assertEquals(1, servletResponse.getHeaderValues(HttpHeaders.LAST_MODIFIED).size());
assertEquals(dateFormat.format(lastModified), servletResponse.getHeader(HttpHeaders.LAST_MODIFIED)); assertEquals(RFC_1123_DATE_TIME.format(ofEpochMilli(lastModified).atZone(GMT)), servletResponse.getHeader(HttpHeaders.LAST_MODIFIED));
} }
} }

View File

@ -17,13 +17,13 @@
package org.springframework.web.servlet.resource; package org.springframework.web.servlet.resource;
import java.io.IOException; import java.io.IOException;
import java.text.SimpleDateFormat; import java.time.Instant;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
import java.util.Locale;
import java.util.TimeZone;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
import org.hamcrest.Matchers; import org.hamcrest.Matchers;
@ -45,6 +45,7 @@ import org.springframework.web.accept.ContentNegotiationManager;
import org.springframework.web.accept.ContentNegotiationManagerFactoryBean; import org.springframework.web.accept.ContentNegotiationManagerFactoryBean;
import org.springframework.web.servlet.HandlerMapping; import org.springframework.web.servlet.HandlerMapping;
import static java.time.format.DateTimeFormatter.*;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertSame; import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertThat; import static org.junit.Assert.assertThat;
@ -61,8 +62,6 @@ import static org.junit.Assert.fail;
*/ */
public class ResourceHttpRequestHandlerTests { public class ResourceHttpRequestHandlerTests {
private SimpleDateFormat dateFormat;
private ResourceHttpRequestHandler handler; private ResourceHttpRequestHandler handler;
private MockHttpServletRequest request; private MockHttpServletRequest request;
@ -72,8 +71,6 @@ public class ResourceHttpRequestHandlerTests {
@Before @Before
public void setUp() throws Exception { public void setUp() throws Exception {
dateFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US);
dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
List<Resource> paths = new ArrayList<>(2); List<Resource> paths = new ArrayList<>(2);
paths.add(new ClassPathResource("test/", getClass())); paths.add(new ClassPathResource("test/", getClass()));
@ -623,7 +620,7 @@ public class ResourceHttpRequestHandlerTests {
private long dateHeaderAsLong(String responseHeaderName) throws Exception { private long dateHeaderAsLong(String responseHeaderName) throws Exception {
return dateFormat.parse(this.response.getHeader(responseHeaderName)).getTime(); return ZonedDateTime.parse(this.response.getHeader(responseHeaderName), RFC_1123_DATE_TIME).toInstant().toEpochMilli();
} }
private long resourceLastModified(String resourceName) throws IOException { private long resourceLastModified(String resourceName) throws IOException {
@ -632,7 +629,7 @@ public class ResourceHttpRequestHandlerTests {
private String resourceLastModifiedDate(String resourceName) throws IOException { private String resourceLastModifiedDate(String resourceName) throws IOException {
long lastModified = new ClassPathResource(resourceName, getClass()).getFile().lastModified(); long lastModified = new ClassPathResource(resourceName, getClass()).getFile().lastModified();
return dateFormat.format(lastModified); return RFC_1123_DATE_TIME.format(Instant.ofEpochMilli(lastModified).atZone(ZoneId.of("GMT")));
} }