@DisplayName for readable names in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @DisplayName annotation in JUnit?

The @DisplayName annotation is used to give a test method or class a readable and descriptive name that appears in test reports and IDEs, making tests easier to understand.

beginner

How do you use @DisplayName in a JUnit test method?

You place @DisplayName("Your readable name") above the test method to set a custom name that will show in test results instead of the method name.

intermediate

Can @DisplayName be used on test classes as well as test methods?

Yes, @DisplayName can be applied to both test classes and test methods to provide readable names at both levels.

beginner

What happens if you do not use @DisplayName in your tests?

If @DisplayName is not used, the test runner shows the method or class names as they are written in code, which may be less readable or descriptive.

beginner

Give an example of a @DisplayName annotation for a test method.

Example: @DisplayName("Check if user login succeeds with valid credentials") void testUserLogin() { ... }

What does the @DisplayName annotation do in JUnit?

A Sets a readable name for tests in reports and IDEs

B Marks a test as disabled

C Specifies the order of test execution

D Defines a test timeout

The @DisplayName annotation sets a readable and descriptive name for test classes or methods.

Where can you apply the @DisplayName annotation?

A On both test classes and test methods

B Only on test classes

C Only on test methods

D Only on setup methods

@DisplayName can be used on both test classes and test methods to improve readability.

If you omit @DisplayName, what name appears in test reports?

A No name is shown

B The method or class name as written in code

C The package name

D A random generated name

Without @DisplayName, the test runner shows the method or class names exactly as they appear in the code.

Which of these is a valid use of @DisplayName?

A @DisplayName(123)

B @DisplayName(true)

C @DisplayName

D @DisplayName("Test user registration")

@DisplayName requires a string value describing the test; other types are invalid.

Why is using @DisplayName helpful?

A It automatically fixes test failures

B It speeds up test execution

C It makes test reports easier to read and understand

D It encrypts test data

@DisplayName improves test report readability by showing descriptive names.

Explain how @DisplayName improves test readability and where you can apply it.

Think about how test names appear when running tests.

Describe what happens if you do not use @DisplayName in your JUnit tests.

Consider default naming behavior in test reports.