AssertJ support for RestTestClient

See gh-35701
2026-09-25 08:19:01 +00:00 · 2025-10-30 13:30:46 +00:00
parent 41ae13df5d
commit a8349e1c5c
8 changed files with 669 additions and 6 deletions
@@ -0,0 +1,129 @@
+/*
+ * Copyright 2002-present 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.test.web.servlet.client.assertj;
+
+
+import java.util.Map;
+
+import jakarta.servlet.http.Cookie;
+import jakarta.servlet.http.HttpServletResponse;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.http.converter.HttpMessageConverters;
+import org.springframework.test.web.servlet.client.RestTestClient;
+import org.springframework.test.web.servlet.client.RestTestClient.ResponseSpec;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Unit tests for {@link RestTestClientResponse}.
+ *
+ * @author Rossen Stoyanchev
+ */
+public class RestTestClientResponseTests {
+
+	private final RestTestClient client =
+			RestTestClient.bindToController(HelloController.class)
+					.configureMessageConverters(HttpMessageConverters.Builder::registerDefaults)
+					.build();
+
+
+	@Test
+	void status() {
+		ResponseSpec spec = client.get().uri("/greeting").exchange();
+		assertThat(RestTestClientResponse.from(spec)).hasStatusOk().hasStatus2xxSuccessful();
+	}
+
+	@Test
+	void headers() {
+		RestTestClient.ResponseSpec spec = client.get().uri("/greeting").exchange();
+
+		RestTestClientResponse response = RestTestClientResponse.from(spec);
+		assertThat(response).hasStatusOk();
+		assertThat(response).headers()
+				.containsOnlyHeaders(HttpHeaders.CONTENT_TYPE, HttpHeaders.CONTENT_LENGTH)
+				.hasValue(HttpHeaders.CONTENT_TYPE, "text/plain;charset=ISO-8859-1")
+				.hasValue(HttpHeaders.CONTENT_LENGTH, 11);
+	}
+
+	@Test
+	void contentType() {
+		ResponseSpec spec = client.get().uri("/greeting").exchange();
+
+		RestTestClientResponse response = RestTestClientResponse.from(spec);
+		assertThat(response).hasStatusOk();
+		assertThat(response).contentType().isEqualTo("text/plain;charset=ISO-8859-1");
+		assertThat(response).hasContentTypeCompatibleWith(MediaType.TEXT_PLAIN);
+	}
+
+	@Test
+	void cookies() {
+		ResponseSpec spec = client.get().uri("/cookie").exchange();
+
+		RestTestClientResponse response = RestTestClientResponse.from(spec);
+		assertThat(response).hasStatusOk();
+		assertThat(response).cookies().hasValue("foo", "bar");
+		assertThat(response).body().isEmpty();
+	}
+
+	@Test
+	void bodyText() {
+		ResponseSpec spec = client.get().uri("/greeting").exchange();
+
+		RestTestClientResponse response = RestTestClientResponse.from(spec);
+		assertThat(response).hasStatusOk();
+		assertThat(response).contentType().isCompatibleWith(MediaType.TEXT_PLAIN);
+		assertThat(response).bodyText().isEqualTo("Hello World");
+		assertThat(response).hasBodyTextEqualTo("Hello World");
+	}
+
+	@Test
+	void bodyJson() {
+		ResponseSpec spec = client.get().uri("/message").exchange();
+
+		RestTestClientResponse response = RestTestClientResponse.from(spec);
+		assertThat(response).hasStatusOk();
+		assertThat(response).contentType().isEqualTo(MediaType.APPLICATION_JSON);
+		assertThat(response).bodyJson().extractingPath("$.message").asString().isEqualTo("Hello World");
+	}
+
+
+	@SuppressWarnings("unused")
+	@RestController
+	private static class HelloController {
+
+		@GetMapping("/greeting")
+		public String getGreeting() {
+			return "Hello World";
+		}
+
+		@GetMapping("/message")
+		public Map<String, ?> getMessage() {
+			return Map.of("message", "Hello World");
+		}
+
+		@GetMapping("/cookie")
+		public void getCookie(HttpServletResponse response) {
+			response.addCookie(new Cookie("foo", "bar"));
+		}
+	}
+
+}