@DisplayName for readable names in JUnit - Test Execution Trace

Test Overview

This test demonstrates how to use @DisplayName in JUnit to give a readable name to a test method. It verifies that the addition of two numbers returns the correct result.

Test Code - JUnit

JUnit

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class CalculatorTest {

    @Test
    @DisplayName("Adding two positive numbers should return their sum")
    void testAddition() {
        int a = 5;
        int b = 7;
        int result = a + b;
        assertEquals(12, result, "Sum should be 12");
    }
}

Execution Trace - 4 Steps

Step	Action	System State	Assertion	Result
1	Test runner starts and identifies test methods with @Test annotation	JUnit test environment initialized, CalculatorTest class loaded	-	PASS
2	Test runner reads @DisplayName annotation for testAddition method	Test method labeled as 'Adding two positive numbers should return their sum' in test report	-	PASS
3	Test runner executes testAddition method	Variables a=5, b=7 initialized; addition performed	assertEquals(12, result) verifies result is 12	PASS
4	Test runner reports test result with readable name from @DisplayName	Test report shows 'Adding two positive numbers should return their sum' as test name with status PASS	-	PASS

Failure Scenario

Failing Condition: The addition result is incorrect (e.g., result is not 12)

Execution Trace Quiz - 3 Questions

What does the @DisplayName annotation do in this test?

A Skips the test during execution

B Provides a readable name for the test method in reports

C Changes the method name in the code

D Runs the test multiple times

Key Result

Using @DisplayName helps make test reports clearer and easier to understand by giving tests descriptive names instead of method names.