Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish soft assertions for MockMvc

Browse Source 
See gh-26917
This commit is contained in:
Sam Brannen
2021-08-22 18:32:05 +02:00
parent 35bec8102b
commit 5f47d3be22
3 changed files with 55 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
spring-test/src/main/java/org/springframework/test/web/servlet/ResultActions.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 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.
@@ -32,9 +32,11 @@ public interface ResultActions {
/**
* Perform an expectation.
*
* <h4>Example</h4>
* <h4>Examples</h4>
*
* <p>You can invoke {@code andExpect()} multiple times.
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*
* // static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*
*
* mockMvc.perform(get("/person/1"))
* .andExpect(status().isOk())
@@ -42,9 +44,9 @@ public interface ResultActions {
* .andExpect(jsonPath("$.person.name").value("Jason"));
* </pre>
*
* <p>Either provide all matchers as a vararg:
* <p>You can provide all matchers as a var-arg list with {@code matchAll()}.
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAll
* // static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAll
*
* mockMvc.perform(post("/form"))
* .andExpect(matchAll(
@@ -57,13 +59,14 @@ public interface ResultActions {
* );
* </pre>
*
* <p>Or provide all matchers to be evaluated no matter if one of them fail:
* <p>Alternatively, you can provide all matchers to be evaluated using
* <em>soft assertions</em> with {@code matchAllSoftly()}.
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAllSoftly
* // static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAllSoftly
* mockMvc.perform(post("/form"))
* .andExpect(matchAllSoftly(
* status().isOk(),
* redirectedUrl("/person/1")
* redirectedUrl("/person/1"))
* );
* </pre>
*/

32
spring-test/src/main/java/org/springframework/test/web/servlet/ResultMatcher.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 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.
@@ -16,9 +16,6 @@
package org.springframework.test.web.servlet;
import java.util.ArrayList;
import java.util.List;
/**
* A {@code ResultMatcher} matches the result of an executed request against
* some expectation.
@@ -47,6 +44,7 @@ import java.util.List;
*
* @author Rossen Stoyanchev
* @author Sam Brannen
* @author Michał Rowicki
* @since 3.2
*/
@FunctionalInterface
@@ -74,27 +72,29 @@ public interface ResultMatcher {
}
/**
* Static method for matching with an array of result matchers whose assertion failures are caught and stored.
* Only when all of them would be called a {@link AssertionError} be thrown containing the error messages of those
* previously caught assertion failures.
* Static method for matching with an array of result matchers whose assertion
* failures are caught and stored. Once all matchers have been called, if any
* failures occurred, an {@link AssertionError} will be thrown containing the
* error messages of all assertion failures.
* @param matchers the matchers
* @author Michał Rowicki
* @since 5.2
* @since 5.3.10
*/
static ResultMatcher matchAllSoftly(ResultMatcher... matchers) {
return result -> {
List<String> failedMessages = new ArrayList<>();
for (int i = 0; i < matchers.length; i++) {
ResultMatcher matcher = matchers[i];
String message = "";
for (ResultMatcher matcher : matchers) {
try {
matcher.match(result);
}
catch (AssertionError assertionException) {
failedMessages.add("[" + i + "] " + assertionException.getMessage());
catch (Error | Exception ex) {
if (!message.isEmpty()) {
message += System.lineSeparator();
}
message += ex.getMessage();
}
}
if (!failedMessages.isEmpty()) {
throw new AssertionError(String.join("\n", failedMessages));
if (!message.isEmpty()) {
throw new AssertionError(message);
}
};
}