JUnit5 Important Annotations

The following are some of the important annotations in JUnit 5.

@Test : Denotes that a method is a test method. Without this annotation, JUnit will ignore the method

Denotes a method to be a parameterized test method. Parameterized tests make it possible to run a test multiple times with different arguments.

@RepeatedTest : Test methods marked with @RepeatedTest can be executed repeatedly

@TestMethodOrder: Helps maintain order in which test methods are executed.

@DisplayName : Helps in using a custom name to be printed either in the console or test report for the test method.

@DisplayNameGeneration : Declares a custom display name generator for the test class

@BeforeEach: Analogous to JUnit 4 @Before. Denotes the annotated method should be executed before each test. The method should not return any value, should not be private.

@AfterEach : Analogous to JUnit 4 @After. Denotes the annotated method should be executed after each test. The method should not return any value, should not be private.

@BeforeAll: Denotes that the annotated method should be executed before all @Test, @RepeatedTest, @ParameterizedTest, and @TestFactory methods in the current class; analogous to JUnit 4’s @BeforeClass. Such methods are inherited (unless they are hidden or overridden) and must be static (unless the "per-class" test instance lifecycle is used).

@AfterAll: Denotes that the annotated method should be executed after all @Test, @RepeatedTest, @ParameterizedTest, and @TestFactory methods in the current class; analogous to JUnit 4’s @AfterClass. A method marked with @AfterAll is inherited (unless they are hidden or overridden) and must be static.

@Nested:Denotes that the annotated class is a non-static nested test class. @BeforeAll and @AfterAll methods cannot be used directly in a @Nested test class unless the "per-class" test instance lifecycle is used. Such annotations are not inherited.

@Tag: Used to declare tags for filtering tests, either at the class or method level; analogous to test groups in TestNG or Categories in JUnit 4. Such annotations are inherited at the class level but not at the method level.

@Disabled : Used to disable a test class or test method; analogous to JUnit 4’s @Ignore. Such annotations are not inherited.

@Timeout: Used to fail a test, test factory, test template, or lifecycle method if its execution exceeds a given duration. Such annotations are inherited.