JUnit 4 vs JUnit 5 (Jupiter) differences - Framework Approaches Compared

Framework Mode - JUnit 4 vs JUnit 5 (Jupiter) differences

Folder Structure

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── App.java
│   └── test/
│       └── java/
│           └── com/example/app/
│               ├── JUnit4Tests.java
│               └── JUnit5Tests.java
├── build.gradle (or pom.xml)
└── README.md
  

This structure supports both JUnit 4 and JUnit 5 tests side by side in the same project.

Test Framework Layers

• Test Classes: Separate test classes for JUnit 4 and JUnit 5 tests, e.g., JUnit4Tests.java and JUnit5Tests.java.
• Test Runner Layer: JUnit 4 uses @RunWith and runners like BlockJUnit4ClassRunner. JUnit 5 uses the JUnitPlatform runner or native support in IDEs/build tools.
• Annotations Layer: JUnit 4 uses @Before, @After, @Test. JUnit 5 uses @BeforeEach, @AfterEach, @Test, and more powerful annotations.
• Extension Layer: JUnit 4 uses Rules and Runners. JUnit 5 uses Extensions with the Extension API for more flexible behavior.
• Utilities: Shared helper classes and utilities for assertions, test data, and mocks.

Configuration Patterns

• Build Tool: Use Gradle or Maven to manage dependencies for both JUnit 4 and JUnit 5. For JUnit 5, include junit-jupiter-engine and junit-platform-runner.
• Test Selection: Configure build tool to run JUnit 4 and JUnit 5 tests together or separately using test filters.
• Environment Setup: Use @BeforeClass (JUnit 4) or @BeforeAll (JUnit 5) for global setup.
  Use properties files or environment variables for test environment configuration.
• Parallel Execution: JUnit 5 supports parallel test execution configuration via junit-platform.properties.

Test Reporting and CI/CD Integration

• Test Reports: Both JUnit 4 and JUnit 5 produce XML reports compatible with CI tools like Jenkins, GitHub Actions, or GitLab CI.
• CI Integration: Configure CI pipelines to run tests using Gradle or Maven commands that include both JUnit 4 and JUnit 5 tests.
• IDE Support: Modern IDEs (IntelliJ IDEA, Eclipse) support running and debugging both JUnit 4 and JUnit 5 tests seamlessly.
• Advanced Reporting: Use plugins like Surefire or Gradle Test Logger for enhanced console output and reports.

Best Practices

1. Use JUnit 5 for new tests: It offers better extensibility, more annotations, and improved architecture.
2. Maintain backward compatibility: Keep JUnit 4 tests if legacy code exists, but migrate gradually.
3. Use Extensions over Rules: JUnit 5 Extensions are more powerful and flexible than JUnit 4 Rules.
4. Separate test classes by framework: Helps clarity and easier migration.
5. Configure build tools properly: Ensure both JUnit 4 and JUnit 5 tests run without conflicts.

Self Check

Where in this folder structure would you add a new test class using JUnit 5 for a feature called UserLogin?

Key Result

JUnit 5 offers a modern, extensible test framework while supporting coexistence with JUnit 4 for smooth migration.

Practice

1. Which of the following is a key difference between JUnit 4 and JUnit 5 regarding test method visibility?

easy

A. JUnit 4 requires test methods to be public, but JUnit 5 does not.

B. JUnit 5 requires test methods to be public, but JUnit 4 does not.

C. Both JUnit 4 and JUnit 5 require test methods to be private.

D. Neither JUnit 4 nor JUnit 5 require any specific visibility for test methods.

Solution

1. Step 1: Understand JUnit 4 test method visibility

   JUnit 4 requires test methods to be declared as public for the framework to recognize and run them.

2. Step 2: Understand JUnit 5 test method visibility

   JUnit 5 allows test methods to have any visibility, including package-private, making it more flexible.

3. Final Answer:

   JUnit 4 requires test methods to be public, but JUnit 5 does not. -> Option A

4. Quick Check:

   JUnit 4 public test methods = true [OK]

Hint: Remember: JUnit 4 needs public tests; JUnit 5 is more relaxed [OK]

Common Mistakes:

• Thinking JUnit 5 also requires public test methods
• Assuming both versions have the same visibility rules
• Confusing private and public requirements

2. Which annotation replaces @Before from JUnit 4 in JUnit 5?

easy

A. @Init

B. @BeforeAll

C. @Setup

D. @BeforeEach

Solution

1. Step 1: Identify JUnit 4 setup annotation

   JUnit 4 uses @Before to run code before each test method.

2. Step 2: Identify JUnit 5 equivalent annotation

   JUnit 5 replaces @Before with @BeforeEach to clarify it runs before each test method.

3. Final Answer:

   @BeforeEach -> Option D

4. Quick Check:

   @Before in JUnit 4 = @BeforeEach in JUnit 5 [OK]

Hint: Think "Each" means before every test, replacing @Before [OK]

Common Mistakes:

• Choosing @BeforeAll which runs once before all tests
• Using non-existent annotations like @Setup or @Init
• Confusing @BeforeEach with @AfterEach

3. Consider this JUnit 5 test class snippet:

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

class CalculatorTest {
  @Test
  void addTest() {
    int result = 2 + 3;
    assertEquals(5, result);
  }
}

What will be the test result when running this test?

medium

A. Test passes successfully

B. Test fails with assertion error

C. Compilation error due to missing public modifier

D. Runtime error due to missing @BeforeEach

Solution

1. Step 1: Check method visibility in JUnit 5

   The test method is package-private (no modifier), which is allowed in JUnit 5.

2. Step 2: Verify assertion correctness

   The assertion compares 5 and result (2+3=5), so it matches and passes.

3. Final Answer:

   Test passes successfully -> Option A

4. Quick Check:

   2 + 3 = 5, assertion true [OK]

Hint: JUnit 5 allows non-public tests; 2+3=5 means pass [OK]

Common Mistakes:

• Assuming test methods must be public in JUnit 5
• Thinking missing @BeforeEach causes failure here
• Confusing assertion order causing failure

4. Given this JUnit 4 test snippet:

import org.junit.Before;
import org.junit.Test;

public class SampleTest {
  @Before
  public void setup() {
    System.out.println("Setup");
  }

  @Test
  void testMethod() {
    System.out.println("Test");
  }
}

What is the main issue when running this test?

medium

A. No issues; test runs and prints both lines

B. The test method must be public in JUnit 4

C. The setup method must be static

D. The @Before annotation is not recognized in JUnit 4

Solution

1. Step 1: Check test method visibility requirement in JUnit 4

   JUnit 4 requires test methods to be public, but here testMethod() has default (package-private) visibility.

2. Step 2: Verify @Before method correctness

   The setup() method is public and correctly annotated, so no issue there.

3. Final Answer:

   The test method must be public in JUnit 4 -> Option B

4. Quick Check:

   JUnit 4 test methods must be public [OK]

Hint: JUnit 4 needs public test methods; check method modifiers [OK]

Common Mistakes:

• Thinking @Before is invalid in JUnit 4
• Assuming setup must be static
• Believing test runs despite non-public test method

5. You want to migrate a JUnit 4 test class to JUnit 5. Which of these changes is NOT required?

hard

A. Change import statements to JUnit Jupiter packages

B. Replace @Before with @BeforeEach

C. Make all test methods public

D. Replace @Test import to JUnit Jupiter's @Test

Solution

1. Step 1: Identify visibility requirements in JUnit 5

   JUnit 5 does not require test methods to be public; package-private is allowed.

2. Step 2: Check other migration steps

   Replacing @Before with @BeforeEach and updating imports to Jupiter packages are required for migration.

3. Final Answer:

   Make all test methods public -> Option C

4. Quick Check:

   JUnit 5 relaxes method visibility rules [OK]

Hint: JUnit 5 allows non-public tests; no need to change visibility [OK]

Common Mistakes:

• Thinking test methods must be public in JUnit 5
• Forgetting to update import statements
• Missing @Before to @BeforeEach replacement