Why Custom display names for parameters in JUnit? - Purpose & Use Cases

The Big Idea

Discover how a simple label can turn confusing test results into clear, actionable insights!

The Scenario

Imagine running a set of tests with many input values and seeing only generic test names like 'testMethod(1)', 'testMethod(2)', etc. It's like reading a list of unlabeled boxes--you don't know what's inside without opening each one.

The Problem

Manually figuring out which input caused a test failure is slow and frustrating. You waste time guessing what each test case means because the default names don't explain the inputs. This leads to confusion and errors when fixing bugs.

The Solution

Custom display names let you label each test case clearly, like putting a bright, readable tag on each box. You can describe the input or expected behavior directly in the test report, making it easy to understand results at a glance.

Before vs After

✗ Before

void testMethod(int number) { /* test logic */ }

✓ After

@ParameterizedTest
@ValueSource(ints = {1, 2})
@DisplayName("Test with number {0}")
void testMethod(int number) { /* test logic */ }

What It Enables

It enables quick, clear understanding of each test case's purpose and outcome, speeding up debugging and improving communication.

Real Life Example

When testing a calculator app, instead of seeing 'testAdd(2,3)', you see 'Adding 2 and 3 should return 5'--making it obvious what the test checks.

Key Takeaways

Manual test names are unclear and slow down debugging.

Custom display names add meaningful labels to each test case.

This makes test reports easier to read and understand quickly.