Choosing the right test double in JUnit - Framework Patterns

Framework Mode - Choosing the right test double

Folder Structure for JUnit Test Framework with Test Doubles

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── (application code)
│   └── test/
│       └── java/
│           └── com/example/app/
│               ├── unit/
│               │   ├── service/
│               │   │   └── ServiceTest.java
│               │   └── repository/
│               │       └── RepositoryTest.java
│               ├── doubles/
│               │   ├── mocks/
│               │   │   └── MockService.java
│               │   ├── stubs/
│               │   │   └── StubRepository.java
│               │   ├── fakes/
│               │   │   └── FakeDatabase.java
│               │   └── spies/
│               │       └── SpyNotifier.java
│               └── utils/
│                   └── TestUtils.java
├── build.gradle (or pom.xml)
└── junit-platform.properties

Test Framework Layers for JUnit with Test Doubles

• Test Layer: Contains JUnit test classes that verify application logic.
• Test Doubles Layer: Includes mocks, stubs, fakes, and spies used to replace real dependencies during tests.
• Application Layer: The real application code under test.
• Utilities Layer: Helper classes and methods to support tests (e.g., data builders, common assertions).
• Configuration Layer: Settings for test environment, such as test profiles and properties.

Configuration Patterns for Handling Test Doubles in JUnit

• Profiles: Use JUnit tags or Spring profiles to separate tests that use different doubles.
• Dependency Injection: Inject test doubles via constructors or setters to easily swap real objects with doubles.
• Properties Files: Store environment-specific settings (e.g., URLs, credentials) in application-test.properties.
• Mock Frameworks: Use Mockito or similar libraries to create mocks and spies dynamically.
• Test Setup: Use @BeforeEach to initialize doubles and configure behavior before each test.

Test Reporting and CI/CD Integration

• JUnit Reports: Generate XML reports automatically after test runs for CI tools.
• CI Integration: Configure Jenkins, GitHub Actions, or GitLab CI to run tests on every commit or pull request.
• Test Coverage: Use tools like JaCoCo to measure how much code is tested, including code exercised by doubles.
• Failure Analysis: Reports show which tests failed and why, helping identify if a test double caused issues.
• Notifications: Set up email or chat alerts for test failures to keep the team informed.

Best Practices for Choosing and Using Test Doubles

1. Use a Stub when you need to provide fixed data to the system under test without complex behavior.
2. Use a Mock when you want to verify interactions, like method calls or parameters passed.
3. Use a Fake when you want a working implementation that is simpler or faster than the real one (e.g., in-memory database).
4. Use a Spy when you want to record information about calls but still use the real implementation.
5. Keep Test Doubles Simple to avoid hiding bugs or making tests brittle.

Self-Check Question

Where in this folder structure would you add a new mock class for a PaymentService?

Key Result

Organize test doubles by type in dedicated folders and use dependency injection to swap them in JUnit tests.