Skip to content
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

Document benefits of messageSupplier in Assertions #3635

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions documentation/src/test/java/example/AssertionsDemo.java
Expand Up @@ -41,10 +41,24 @@ void standardAssertions() {
assertEquals(2, calculator.add(1, 1));
assertEquals(4, calculator.multiply(2, 2),
"The optional failure message is now the last parameter");
// When third parameter is used as message supplier (lambda expression)
// it will be lazily evaluated, only when the assertion fails.
assertTrue('a' < 'b', () -> "Assertion messages can be lazily evaluated -- "
+ "to avoid constructing complex messages unnecessarily.");
}

@Test
void assertWithMessageSupplier() {
// When assertion failure message is used as a plain expression,
// the expression will be evaluated irrespective of the assertion result.
assertEquals(4, calculator.multiply(2, 2),
"This expression will always evaluate irrespective of assertion result.");
// When assertion failure message is created as a lambda expression,
// expression will only evaluate when assertion result is failed (lazy evaluation)
// and can help us save unnecessary computations when they are not needed.
assertTrue('a' < 'b', () -> "This lambda will evaluate only if assertion fails.");
}

@Test
void groupedAssertions() {
// In a grouped assertion all assertions are executed, and all
Expand Down