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.
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.
When we run our JUnit test class, we can see the display name in the JUnit view window.
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.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
Java and Python Developer for 20+ years, Open Source Enthusiast, Founder of https://www.askpython.com/, https://www.linuxfordevices.com/, and JournalDev.com (acquired by DigitalOcean). Passionate about writing technical articles and sharing knowledge with others. Love Java, Python, Unix and related technologies. Follow my X @PankajWebDev
Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.
Full documentation for every DigitalOcean product.
The Wave has everything you need to know about building a business, from raising funding to marketing your product.
Stay up to date by signing up for DigitalOcean’s Infrastructure as a Newsletter.
New accounts only. By submitting your email you agree to our Privacy Policy
Scale up as you grow — whether you're running one virtual machine or ten thousand.
Sign up and get $200 in credit for your first 60 days with DigitalOcean.*
*This promotional offer applies to new accounts only.