junit

junit Best Practices

JUnit 5 (Jupiter) is the bedrock of modern Java unit testing. This guide outlines the essential practices for crafting robust, readable, and reliable tests that integrate seamlessly into your development workflow. Adhere to these rules to ensure your tests are a valuable asset, not a burden.

1. Code Organization and Structure

1.1. Test File and Package Naming

Always mirror your production code's package structure within src/test/java. Name test classes by appending Test to the class they verify.

❌ BAD:

// src/test/java/com/example/UserServiceLogic.java
package com.example;

class UserServiceLogic { /* ... */ }

✅ GOOD:

// src/main/java/com/example/UserService.java
package com.example;
class UserService { /* ... */ }

// src/test/java/com/example/UserServiceTest.java
package com.example;
class UserServiceTest { /* ... */ }

1.2. Descriptive Test Method Naming

Test method names must clearly convey their purpose: the scenario being tested, the action, and the expected outcome. Use the Given_When_Then pattern or methodName_condition_expectedResult. For enhanced readability in test reports, leverage @DisplayName.

❌ BAD:

@Test
void testAdd() { /* ... */ }

@Test
void calculateDiscount() { /* ... */ }

✅ GOOD:

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

class CalculatorTest {
    @Test
    @DisplayName("Given two positive numbers, when added, then return their sum")
    void add_TwoPositiveNumbers_ReturnsSum() {
        // Arrange, Act, Assert
    }

    @Test
    void calculateDiscount_PremiumCustomer_Applies20PercentDiscount() {
        // Arrange, Act, Assert
    }
}

1.3. Logical Grouping with @Nested

For complex classes with many behaviors, use @Nested classes to group related tests. This improves readability and organization, especially when dealing with different states or conditions.

❌ BAD:

class OrderServiceTest {
    @Test void createOrder_ValidInput_ReturnsOrder() { /* ... */ }
    @Test void createOrder_InvalidProduct_ThrowsException() { /* ... */ }
    @Test void cancelOrder_ExistingOrder_SetsStatusToCancelled() { /* ... */ }
    @Test void cancelOrder_NonExistingOrder_ThrowsException() { /* ... */ }
}