Stub objects in JUnit - Framework Patterns

Framework Mode - Stub objects

Folder Structure

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── (application source code)
│   └── test/
│       ├── java/
│       │   └── com/example/app/
│       │       ├── stubs/          <-- Stub objects here
│       │       │   └── UserServiceStub.java
│       │       ├── utils/          <-- Test utilities and helpers
│       │       ├── pages/          <-- Page objects if UI tests
│       │       └── tests/          <-- JUnit test classes
│       │           └── UserServiceTest.java
│       └── resources/              <-- Test data, config files
├── build.gradle or pom.xml          <-- Build and dependency management
    

Test Framework Layers

• Stub Layer: Contains stub classes that simulate behavior of real dependencies with fixed responses.
• Test Layer: JUnit test classes that use stubs to isolate the unit under test.
• Utility Layer: Helper methods for common test setup or assertions.
• Configuration Layer: Environment and test settings loaded from resources or system properties.
• Application Layer: The real application code under test.

Configuration Patterns

Use src/test/resources to store environment-specific config files like test.properties or stub-config.yaml.

Use system properties or environment variables to switch between real and stub implementations if needed.

Example: In JUnit tests, inject stub objects directly or via dependency injection frameworks configured for test scope.

Test Reporting and CI/CD Integration

JUnit generates XML and HTML reports by default when run via build tools like Maven or Gradle.

Integrate these reports into CI/CD pipelines (Jenkins, GitHub Actions) to show pass/fail status and test coverage.

Stub usage helps tests run fast and reliably, improving CI feedback speed.

Best Practices for Stub Objects Framework

• Keep stubs simple: Return fixed data only, avoid complex logic to keep tests predictable.
• Isolate tests: Use stubs to isolate the unit under test from external dependencies.
• Place stubs in a dedicated package: Helps maintain clear separation from real code and test classes.
• Use descriptive names: Name stub classes clearly to indicate their purpose (e.g., UserServiceStub).
• Document stub behavior: Comment what fixed responses the stub provides to help future maintainers.

Self Check

Where in this folder structure would you add a new stub object for a PaymentService?

Key Result

Use stub objects in a dedicated test package to isolate units and simulate dependencies with fixed responses.