Skip to content

Introduce soft assertions for WebTestClient #26969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
Expand Down Expand Up @@ -507,6 +508,24 @@ public <T> FluxExchangeResult<T> returnResult(ParameterizedTypeReference<T> elem
Flux<T> body = this.response.bodyToFlux(elementTypeRef);
return new FluxExchangeResult<>(this.exchangeResult, body);
}

@Override
public ResponseSpec expectAllSoftly(ResponseSpecMatcher... asserts) {
List<String> failedMessages = new ArrayList<>();
for (int i = 0; i < asserts.length; i++) {
ResponseSpecMatcher anAssert = asserts[i];
try {
anAssert.accept(this);
}
catch (AssertionError assertionException) {
failedMessages.add("[" + i + "] " + assertionException.getMessage());
}
}
if (!failedMessages.isEmpty()) {
throw new AssertionError(String.join("\n", failedMessages));
}
return this;
}
}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -845,6 +845,11 @@ interface ResponseSpec {
* about a target type with generics.
*/
<T> FluxExchangeResult<T> returnResult(ParameterizedTypeReference<T> elementTypeRef);

/**
* Array of assertions to test together a.k.a. soft assertions.
*/
ResponseSpec expectAllSoftly(ResponseSpecMatcher... asserts);
}


Expand Down Expand Up @@ -1006,4 +1011,5 @@ default XpathAssertions xpath(String expression, Object... args) {
EntityExchangeResult<byte[]> returnResult();
}

interface ResponseSpecMatcher extends Consumer<ResponseSpec> {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
* 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.
* 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.reactive.server.samples;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import static org.assertj.core.api.Assertions.assertThatExceptionOfType;

/**
* Samples of tests using {@link WebTestClient} with soft assertions.
*
* @author Michał Rowicki
* @since 5.3
*/
public class SoftAssertionTests {

private WebTestClient client;


@BeforeEach
public void setUp() throws Exception {
this.client = WebTestClient.bindToController(new TestController()).build();
}


@Test
public void test() throws Exception {
this.client.get().uri("/test")
.exchange()
.expectAllSoftly(
exchange -> exchange.expectStatus().isOk(),
exchange -> exchange.expectBody(String.class).isEqualTo("It works!")
);
}

@Test
public void testAllFails() throws Exception {
assertThatExceptionOfType(AssertionError.class).isThrownBy(() ->
this.client.get().uri("/test")
.exchange()
.expectAllSoftly(
exchange -> exchange.expectStatus().isBadRequest(),
exchange -> exchange.expectBody(String.class).isEqualTo("It won't work :(")
)
).withMessage("[0] Status expected:<400 BAD_REQUEST> but was:<200 OK>\n[1] Response body expected:<It won't work :(> but was:<It works!>");
}


@RestController
static class TestController {

@GetMapping("/test")
public String handle() {
return "It works!";
}
}
}