JUnit 5 assertAll Example

In this article, we will learn how to use assertAll method to group different assertions. assertAll() method belongs to JUnit 5 org.junit.jupiter.api.Assertions Class. Note that in JUnit 5 all JUnit 4 assertion methods are moved to org.junit.jupiter.api.Assertions class.
Let me list out tools and technologies that I have used to develop JUnit 5 assertAll Example.

Tools and Technologies Used

  1. Eclipse photon (only this eclipse version supports JUnit 5)
  2. Maven
  3. JUnit 5
  4. JDK 8 or later

assertAll() Methods

There six overloaded versions of assertAll static methods.
  1. static void assertAll (String heading, Collection executables) - Asserts that all supplied executables do not throw exceptions.
  2. static void assertAll (String heading, Stream executables) - Asserts that all supplied executables do not throw exceptions.
  3. static void assertAll (String heading, Executable... executables) - Asserts that all supplied executables do not throw exceptions.
  4. static void assertAll (Collection executables) - Asserts that all supplied executables do not throw exceptions.
  5. static void assertAll (Stream executables) - Asserts that all supplied executables do not throw exceptions.
  6. static void assertAll (Executable... executables) - Asserts that all supplied executables do not throw exceptions.

assertAll Example

In a grouped assertion all assertions are executed, and any failures will be reported together. In this example, we will create and test Student Class to demonstrate above assertAll() methods with examples.
Let's first create Student Class with firstName and lastName fields:
public class Student {
 public String firstName;
 public String lastName;

 public Student(String firstName, String lastName) {
  this.firstName = firstName;
  this.lastName = lastName;
 }

 public String getFirstName() {
  return firstName;
 }

 public void setFirstName(String firstName) {
  this.firstName = firstName;
 }

 public String getLastName() {
  return lastName;
 }

 public void setLastName(String lastName) {
  this.lastName = lastName;
 }
}

Grouped Assertions Example

In a grouped assertion all assertions are executed, and any failures will be reported together. Refer comments are self-descriptive.
import static org.junit.jupiter.api.Assertions.assertAll;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.junit.jupiter.api.Test;

import com.javaguides.junit5.Student;

public class AssertAllExample {
 @Test
    void groupedAssertions() {
  Student student = new Student("Ramesh", "Fadatare");

        // In a grouped assertion all assertions are executed, and any
        // failures will be reported together.
        assertAll("student", () -> assertEquals("Ramesh", student.getFirstName()),
                () -> assertEquals("Fadatare", student.getLastName()));
    }
}

Dependent Assertions Example

Within a code block, if an assertion fails the subsequent code in the same block will be skipped. Refer comments are self-descriptive.
import static org.junit.jupiter.api.Assertions.assertAll;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.junit.jupiter.api.Test;

import com.javaguides.junit5.Student;

public class AssertAllExample {
 @Test
    void dependentAssertions() {
        // Within a code block, if an assertion fails the
        // subsequent code in the same block will be skipped.
  
  Student student = new Student("Ramesh", "Fadatare");
        assertAll("properties",
            () -> {
                String firstName = student.getFirstName();
                assertNotNull(firstName);

                // Executed only if the previous assertion is valid.
                assertAll("first name",
                    () -> assertTrue(firstName.startsWith("R")),
                    () -> assertTrue(firstName.endsWith("h"))
                );
            },
            () -> {
                // Grouped assertion, so processed independently
                // of results of first name assertions.
                String lastName = student.getLastName();
                assertNotNull(lastName);

                // Executed only if the previous assertion is valid.
                assertAll("last name",
                    () -> assertTrue(lastName.startsWith("F")),
                    () -> assertTrue(lastName.endsWith("e"))
                );
            }
        );
    }
}


Complete Program for Reference 

import static org.junit.jupiter.api.Assertions.assertAll;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.junit.jupiter.api.Test;

import com.javaguides.junit5.Student;

public class AssertAllExample {
 @Test
    void groupedAssertions() {
  Student student = new Student("Ramesh", "Fadatare");

        // In a grouped assertion all assertions are executed, and any
        // failures will be reported together.
        assertAll("student", () -> assertEquals("Ramesh", student.getFirstName()),
                () -> assertEquals("Fadatare", student.getLastName()));
    }
 
 @Test
    void dependentAssertions() {
        // Within a code block, if an assertion fails the
        // subsequent code in the same block will be skipped.
  
  Student student = new Student("Ramesh", "Fadatare");
        assertAll("properties",
            () -> {
                String firstName = student.getFirstName();
                assertNotNull(firstName);

                // Executed only if the previous assertion is valid.
                assertAll("first name",
                    () -> assertTrue(firstName.startsWith("R")),
                    () -> assertTrue(firstName.endsWith("h"))
                );
            },
            () -> {
                // Grouped assertion, so processed independently
                // of results of first name assertions.
                String lastName = student.getLastName();
                assertNotNull(lastName);

                // Executed only if the previous assertion is valid.
                assertAll("last name",
                    () -> assertTrue(lastName.startsWith("F")),
                    () -> assertTrue(lastName.endsWith("e"))
                );
            }
        );
    }
}

Output

Comments