JUnit Display Name - @DisplayName

JUnit @DisplayName annotation is used to provide a custom name for the test class and test methods. We can use spaces, special characters, and even emojis in the display name.

JUnit Display Name Example

By default, JUnit reporting prints the class name and method name in the IDE test report. We can use @DisplayName to specify a custom name that is easy to read and provide information about the test class and method. Let’s see some examples of JUnit Jupiter @DisplayName annotation. Display Name for Test Class

@DisplayName("MyTestClass")
public class DisplayNameTest {
}

Display Name for Methods

@Test
@DisplayName("Example Test Method with No Business Logic")
void test() {
	assertTrue(3 > 0);
}

Display Name with Emojis

@Test
@DisplayName("MyTestMethod ☺")
void test1(TestInfo testInfo) {
	assertEquals("MyTestMethod ☺", testInfo.getDisplayName());
}

Notice that we can get the Test method display name in the method by injecting TestInfo to the method argument.

JUnit DisplayName in Reporting

When we run our JUnit test class, we can see the display name in the JUnit view window.

Summary

JUnit Jupiter @DisplayName annotation doesn’t provide any testing benefits. However, it can be used to provide information about the test methods that show in reporting and can be understood easily by any non-technical user too.

You can checkout complete class and other JUnit examples at our GitHub Repository.