Skip to content

Commit 033d9d0

Browse files
sbrannensbrannen
committed
Merge branch '5.3.x'
2 parents ecdd934 + 9ea4569 commit 033d9d0

File tree

6 files changed

+87
-14
lines changed

6 files changed

+87
-14
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2021 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -142,6 +142,9 @@ else if (StringUtils.startsWithIgnoreCase(attribute, "HttpOnly")) {
142142
else if (StringUtils.startsWithIgnoreCase(attribute, "SameSite")) {
143143
cookie.setSameSite(extractAttributeValue(attribute, setCookieHeader));
144144
}
145+
else if (StringUtils.startsWithIgnoreCase(attribute, "Comment")) {
146+
cookie.setComment(extractAttributeValue(attribute, setCookieHeader));
147+
}
145148
}
146149
return cookie;
147150
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,9 @@ else if (expires != null) {
452452
buf.append("; SameSite=").append(mockCookie.getSameSite());
453453
}
454454
}
455+
if (StringUtils.hasText(cookie.getComment())) {
456+
buf.append("; Comment=").append(cookie.getComment());
457+
}
455458
return buf.toString();
456459
}
457460

‎spring-test/src/test/java/org/springframework/mock/web/MockCookieTests.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -67,7 +67,7 @@ void parseHeaderWithoutAttributes() {
6767

6868
@Test
6969
void parseHeaderWithAttributes() {
70-
MockCookie cookie = MockCookie.parse("SESSION=123; Domain=example.com; Max-Age=60; " +
70+
MockCookie cookie = MockCookie.parse("SESSION=123; Comment=Session Cookie; Domain=example.com; Max-Age=60; " +
7171
"Expires=Tue, 8 Oct 2019 19:50:00 GMT; Path=/; Secure; HttpOnly; SameSite=Lax");
7272

7373
assertCookie(cookie, "SESSION", "123");
@@ -79,6 +79,7 @@ void parseHeaderWithAttributes() {
7979
assertThat(cookie.getExpires()).isEqualTo(ZonedDateTime.parse("Tue, 8 Oct 2019 19:50:00 GMT",
8080
DateTimeFormatter.RFC_1123_DATE_TIME));
8181
assertThat(cookie.getSameSite()).isEqualTo("Lax");
82+
assertThat(cookie.getComment()).isEqualTo("Session Cookie");
8283
}
8384

8485
@ParameterizedTest

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

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2021 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@
3434

3535
import static org.assertj.core.api.Assertions.assertThat;
3636
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
37+
import static org.assertj.core.api.InstanceOfAssertFactories.type;
3738
import static org.assertj.core.api.SoftAssertions.assertSoftly;
3839
import static org.springframework.http.HttpHeaders.CONTENT_LANGUAGE;
3940
import static org.springframework.http.HttpHeaders.CONTENT_LENGTH;
@@ -257,7 +258,7 @@ void httpHeaderNameCasingIsPreserved() throws Exception {
257258

258259
@Test
259260
void cookies() {
260-
Cookie cookie = new Cookie("foo", "bar");
261+
Cookie cookie = new MockCookie("foo", "bar");
261262
cookie.setPath("/path");
262263
cookie.setDomain("example.com");
263264
cookie.setMaxAge(0);
@@ -473,6 +474,23 @@ void setCookieHeaderWithZeroExpiresAttribute() {
473474
assertThat(header).startsWith("SESSION=123; Path=/; Max-Age=100; Expires=");
474475
}
475476

477+
/**
478+
* @since 5.3.22
479+
*/
480+
@Test
481+
void setCookieHeaderWithComment() {
482+
response.setHeader(SET_COOKIE, "SESSION=123;Comment=Test Comment;Path=/");
483+
484+
assertThat(response.getHeader(SET_COOKIE)).isEqualTo(("SESSION=123; Path=/; Comment=Test Comment"));
485+
486+
assertNumCookies(1);
487+
assertThat(response.getCookies()[0]).isInstanceOf(MockCookie.class).satisfies(mockCookie -> {
488+
assertThat(mockCookie.getName()).isEqualTo("SESSION");
489+
assertThat(mockCookie.getPath()).isEqualTo("/");
490+
assertThat(mockCookie.getComment()).isEqualTo("Test Comment");
491+
});
492+
}
493+
476494
@Test
477495
void addCookieHeader() {
478496
response.addHeader(SET_COOKIE, "SESSION=123; Path=/; Secure; HttpOnly; SameSite=Lax");
@@ -486,6 +504,26 @@ void addCookieHeader() {
486504
assertCookieValues("123", "999");
487505
}
488506

507+
@Test
508+
void addCookieHeaderWithComment() {
509+
response.addHeader(SET_COOKIE, "SESSION=123; Path=/; Secure; HttpOnly; SameSite=Lax");
510+
assertNumCookies(1);
511+
assertPrimarySessionCookie("123");
512+
513+
// Adding a 2nd cookie header should result in 2 cookies.
514+
response.addHeader(SET_COOKIE, "SESSION=999; Comment=Test Comment; Path=/; Secure; HttpOnly; SameSite=Lax");
515+
assertNumCookies(2);
516+
assertPrimarySessionCookie("123");
517+
assertThat(response.getCookies()[1]).isInstanceOf(MockCookie.class).satisfies(mockCookie -> {
518+
assertThat(mockCookie.getName()).isEqualTo("SESSION");
519+
assertThat(mockCookie.getValue()).isEqualTo("999");
520+
assertThat(mockCookie.getComment()).isEqualTo("Test Comment");
521+
assertThat(mockCookie.getPath()).isEqualTo("/");
522+
assertThat(mockCookie.getSecure()).isTrue();
523+
assertThat(mockCookie.isHttpOnly()).isTrue();
524+
});
525+
}
526+
489527
/**
490528
* @since 5.1.11
491529
*/
@@ -569,13 +607,16 @@ private void assertCookieValues(String... expected) {
569607

570608
private void assertPrimarySessionCookie(String expectedValue) {
571609
Cookie cookie = this.response.getCookie("SESSION");
572-
assertThat(cookie).isInstanceOf(MockCookie.class);
573-
assertThat(cookie.getName()).isEqualTo("SESSION");
574-
assertThat(cookie.getValue()).isEqualTo(expectedValue);
575-
assertThat(cookie.getPath()).isEqualTo("/");
576-
assertThat(cookie.getSecure()).isTrue();
577-
assertThat(cookie.isHttpOnly()).isTrue();
578-
assertThat(((MockCookie) cookie).getSameSite()).isEqualTo("Lax");
610+
assertThat(cookie).asInstanceOf(type(MockCookie.class)).satisfies(mockCookie -> {
611+
assertThat(mockCookie.getName()).isEqualTo("SESSION");
612+
assertThat(mockCookie.getValue()).isEqualTo(expectedValue);
613+
assertThat(mockCookie.getPath()).isEqualTo("/");
614+
assertThat(mockCookie.getSecure()).isTrue();
615+
assertThat(mockCookie.isHttpOnly()).isTrue();
616+
assertThat(mockCookie.getComment()).isNull();
617+
assertThat(mockCookie.getExpires()).isNull();
618+
assertThat(mockCookie.getSameSite()).isEqualTo("Lax");
619+
});
579620
}
580621

581622
@Test // gh-25501

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

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
2222

2323
import jakarta.servlet.http.Cookie;
2424

25+
import org.springframework.core.style.ToStringCreator;
2526
import org.springframework.lang.Nullable;
2627
import org.springframework.util.Assert;
2728
import org.springframework.util.StringUtils;
@@ -67,8 +68,8 @@ public void setExpires(@Nullable ZonedDateTime expires) {
6768

6869
/**
6970
* Get the "Expires" attribute for this cookie.
70-
* @since 5.1.11
7171
* @return the "Expires" attribute for this cookie, or {@code null} if not set
72+
* @since 5.1.11
7273
*/
7374
@Nullable
7475
public ZonedDateTime getExpires() {
@@ -141,6 +142,9 @@ else if (StringUtils.startsWithIgnoreCase(attribute, "HttpOnly")) {
141142
else if (StringUtils.startsWithIgnoreCase(attribute, "SameSite")) {
142143
cookie.setSameSite(extractAttributeValue(attribute, setCookieHeader));
143144
}
145+
else if (StringUtils.startsWithIgnoreCase(attribute, "Comment")) {
146+
cookie.setComment(extractAttributeValue(attribute, setCookieHeader));
147+
}
144148
}
145149
return cookie;
146150
}
@@ -152,4 +156,22 @@ private static String extractAttributeValue(String attribute, String header) {
152156
return nameAndValue[1];
153157
}
154158

159+
@Override
160+
public String toString() {
161+
return new ToStringCreator(this)
162+
.append("name", getName())
163+
.append("value", getValue())
164+
.append("Path", getPath())
165+
.append("Domain", getDomain())
166+
.append("Version", getVersion())
167+
.append("Comment", getComment())
168+
.append("Secure", getSecure())
169+
.append("HttpOnly", isHttpOnly())
170+
.append("SameSite", this.sameSite)
171+
.append("Max-Age", getMaxAge())
172+
.append("Expires", (this.expires != null ?
173+
DateTimeFormatter.RFC_1123_DATE_TIME.format(this.expires) : null))
174+
.toString();
175+
}
176+
155177
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,9 @@ else if (expires != null) {
452452
buf.append("; SameSite=").append(mockCookie.getSameSite());
453453
}
454454
}
455+
if (StringUtils.hasText(cookie.getComment())) {
456+
buf.append("; Comment=").append(cookie.getComment());
457+
}
455458
return buf.toString();
456459
}
457460

0 commit comments

Comments
 (0)