public Class SoftlyExtension

The injection occurs before each test method execution, after each test assertAll() is invoked to evaluate all test assertions.

A nested test class can provide a SoftAssertions field when it extends this extension or can inherit the parent's Soft assertions field

This extension throws an IllegalStateException if:

• the test class lifecycle is Lifecycle#PER_CLASS (see explanation below).
• multiple SoftAssertions fields are found
• no SoftAssertions field is found

Detecting multiple SoftAssertions fields is a best effort at the time of this writing, some cases are not detected.

Limitations:

1. Cannot be used with test context that have PER_CLASS life cycle as the same SoftAssertions would be reused between tests.
2. May exhibit unpredictable behaviour in concurrent test execution

If you hit such limitations, consider using SoftAssertionsExtension instead, since 3.18.0, SoftAssertionsExtension supports field injection with neither of these two limitations.

Example:

 @ExtendWith(SoftlyExtension.class)
public class SoftlyExtensionExample {

  // initialized by the SoftlyExtension extension
  private SoftAssertions soft;

  @Test
  public void chained_soft_assertions_example() {
    String name = "Michael Jordan - Bulls";
    soft.assertThat(name)
        .startsWith("Mi")
        .contains("Bulls");
    // no need to call softly.assertAll(), this is done by the extension
  }

  // nested classes test work too
  @Nested
  class NestedExample {

    @Test
    public void football_assertions_example() {
      String kylian = "Kylian Mbappé";
      soft.assertThat(kylian)
          .startsWith("Ky")
          .contains("bap");
      // no need to call softly.assertAll(), this is done by the extension
    }
  }
}