Spy objects in JUnit - Framework Patterns

Framework Mode - Spy objects

Folder Structure for JUnit Test Framework with Spy Objects

src/
├── main/
│   └── java/
│       └── com/example/app/
│           └── service/
│               └── UserService.java
└── test/
    └── java/
        └── com/example/app/
            ├── service/
            │   └── UserServiceTest.java  <-- Tests using spy objects here
            └── utils/
                └── TestUtils.java

Test Framework Layers

• Test Classes: Contain JUnit test methods. Use spy objects to monitor real objects' behavior.
• Spy Objects: Partial mocks that wrap real objects to track method calls and arguments.
• Service Layer: Application logic classes under test (e.g., UserService).
• Utilities: Helper methods for test setup, common assertions, or spy creation.
• Configuration: Settings for test environment, dependencies, and mocking framework setup.

Configuration Patterns

• Dependency Injection: Inject real objects into spies to wrap them easily.
• Mockito Setup: Use @ExtendWith(MockitoExtension.class) and @Spy annotations for spy creation.
• Environment Profiles: Use Maven or Gradle profiles to run tests in different environments if needed.
• Test Properties: Store test-specific configs (e.g., test database URLs) in src/test/resources.

Test Reporting and CI/CD Integration

• JUnit Reports: Use built-in JUnit XML reports for test results.
• Mockito Verification: Spy objects allow verification of method calls, which appear as assertion results.
• CI/CD Integration: Integrate with Jenkins, GitHub Actions, or GitLab CI to run tests automatically on code push.
• Fail Fast: Tests fail immediately if spy verification fails, providing clear feedback.

Best Practices for Using Spy Objects in JUnit

1. Use Spies Only When Needed: Prefer mocks or real objects unless you need to track real method calls.
2. Keep Tests Clear: Verify only relevant interactions to avoid brittle tests.
3. Use Annotations: Use @Spy and @InjectMocks for clean setup.
4. Reset Spies: Reset spy state between tests to avoid cross-test interference.
5. Combine with Real Logic: Spies allow partial mocking, so real methods run unless stubbed.

Self Check Question

Where in this folder structure would you add a new spy object for a PaymentService class to monitor its method calls during tests?

Key Result

Use spy objects in JUnit tests to monitor real object behavior while running actual methods.