Skip to content

Commit

Permalink
Soft assertions for MockMvc
Browse files Browse the repository at this point in the history
It happens very often that MockMvc is used in
heavyweight integration tests. It's no use to waste
time to check if another condition has been fixed or
not. Soft assertion could help a lot to check all
conditions at once even if one of them fail.
  • Loading branch information
wyhasany committed May 9, 2021
1 parent 355d394 commit 4362294
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 1 deletion.
Expand Up @@ -42,7 +42,7 @@ public interface ResultActions {
* .andExpect(jsonPath("$.person.name").value("Jason"));
* </pre>
*
* <p>Or alternatively provide all matchers as a vararg:
* <p>Either provide all matchers as a vararg:
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAll
*
Expand All @@ -56,6 +56,16 @@ public interface ResultActions {
* flash().attribute("message", "success!"))
* );
* </pre>
*
* <p>Or provide all matchers to be evaluated no matter if one of them fail:
* <pre class="code">
* static imports: MockMvcRequestBuilders.*, MockMvcResultMatchers.*, ResultMatcher.matchAllSoftly
* mockMvc.perform(post("/form"))
* .andExpect(matchAllSoftly(
* status().isOk(),
* redirectedUrl("/person/1")
* );
* </pre>
*/
ResultActions andExpect(ResultMatcher matcher) throws Exception;

Expand Down
Expand Up @@ -16,6 +16,9 @@

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.
Expand Down Expand Up @@ -70,4 +73,32 @@ static ResultMatcher matchAll(ResultMatcher... matchers) {
};
}

/**
* 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.
* @param matchers the matchers
* @author Michał Rowicki
* @since 5.2
*/
static ResultMatcher matchAllSoftly(ResultMatcher... matchers) {
return result -> {
List<String> failedMessages = null;
for (ResultMatcher matcher : matchers) {
try {
matcher.match(result);
}
catch (AssertionError assertionException) {
if (failedMessages == null) {
failedMessages = new ArrayList<>();
}
failedMessages.add(assertionException.getMessage());
}
}
if (failedMessages != null) {
throw new AssertionError(String.join("\n", failedMessages));
}
};
}

}
@@ -0,0 +1,50 @@
package org.springframework.test.web.servlet;

import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.Test;

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

class ResultMatcherTest {

@Test
void whenProvidedMatcherPassesThenSoftAssertionsAlsoPasses() {
ResultMatcher resultMatcher = ResultMatcher.matchAllSoftly(this::doNothing);
StubMvcResult stubMvcResult = new StubMvcResult(null, null, null, null, null, null, null);

assertThatNoException().isThrownBy(() -> resultMatcher.match(stubMvcResult));
}

@Test
void whenOneOfMatcherFailsThenSoftAssertionFailsWithTheVerySameMessage() {
String failMessage = "fail message";
StubMvcResult stubMvcResult = new StubMvcResult(null, null, null, null, null, null, null);
ResultMatcher resultMatcher = ResultMatcher.matchAllSoftly(failMatcher(failMessage));

assertThatExceptionOfType(AssertionError.class)
.isThrownBy(() -> resultMatcher.match(stubMvcResult))
.withMessage(failMessage);
}

@Test
void whenMultipleMatchersFailsThenSoftAssertionFailsWithOneErrorWithMessageContainingAllErrorMessagesWithTheSameOrder() {
String firstFail = "firstFail";
String secondFail = "secondFail";
StubMvcResult stubMvcResult = new StubMvcResult(null, null, null, null, null, null, null);
ResultMatcher resultMatcher = ResultMatcher.matchAllSoftly(failMatcher(firstFail), failMatcher(secondFail));

assertThatExceptionOfType(AssertionError.class)
.isThrownBy(() -> resultMatcher.match(stubMvcResult))
.withMessage(firstFail + "\n" + secondFail);
}

@NotNull
private ResultMatcher failMatcher(String failMessage) {
return result -> {
throw new AssertionError(failMessage);
};
}

void doNothing(MvcResult mvcResult) {}
}

0 comments on commit 4362294

Please sign in to comment.