Extension model overview in JUnit - Framework Patterns

Framework Mode - Extension model overview

Folder Structure

src/
└── test/
    └── java/
        ├── extensions/       # Custom JUnit extensions
        │   ├── RetryExtension.java
        │   ├── TimingExtension.java
        │   └── LoggingExtension.java
        ├── tests/            # Test classes using extensions
        │   ├── LoginTest.java
        │   └── PaymentTest.java
        ├── utils/            # Helper classes
        │   └── TestUtils.java
        └── config/           # Configuration classes
            └── TestConfig.java

Test Framework Layers

• Extension Layer: Custom JUnit extensions implementing interfaces like BeforeEachCallback, AfterEachCallback, TestExecutionExceptionHandler to add reusable behaviors (e.g., retry, timing, logging).
• Test Layer: Test classes annotated with @ExtendWith to apply extensions and write test methods.
• Utility Layer: Helper classes for common test operations, data setup, or assertions.
• Configuration Layer: Classes or files managing environment settings, test parameters, or global constants.

Configuration Patterns

• Use Java Properties or YAML files to store environment variables like URLs, credentials, and browser settings.
• Load configuration in a dedicated class (e.g., TestConfig.java) to provide easy access to config values.
• Pass configuration to extensions via constructor injection or static access to customize behavior (e.g., retry count).
• Use system properties or Maven profiles to switch environments or enable/disable extensions during test runs.

Test Reporting and CI/CD Integration

• JUnit generates XML reports by default, which CI tools like Jenkins or GitHub Actions can consume.
• Use listeners or extensions to add custom logging or capture screenshots on failures.
• Integrate with build tools (Maven/Gradle) to run tests and publish reports automatically.
• Configure CI pipelines to run tests on code push, merge requests, or scheduled times.

Best Practices

• Keep extensions small and focused: Each extension should do one thing well (e.g., retry, timing).
• Reuse extensions across tests: Apply extensions globally or selectively with @ExtendWith.
• Use explicit extension registration: Avoid implicit behavior to keep tests clear and maintainable.
• Handle exceptions gracefully: Extensions should not hide test failures but provide helpful context.
• Document extension usage: Explain what each extension does and when to use it.

Self Check

Where in this folder structure would you add a new extension that logs test start and end times?

Key Result

JUnit extension model organizes reusable test behaviors in a dedicated extensions layer applied via annotations for clean, maintainable tests.

Practice

1. What is the main purpose of the JUnit extension model?

easy

A. To add extra behavior to tests without changing the test code

B. To write test cases faster using templates

C. To automatically generate test data

D. To replace assertions with custom logic

Solution

1. Step 1: Understand the extension model concept

   The extension model allows adding extra behavior to tests without modifying the original test code.

2. Step 2: Compare options with the concept

   Only To add extra behavior to tests without changing the test code correctly describes this purpose. Other options describe unrelated features.

3. Final Answer:

   To add extra behavior to tests without changing the test code -> Option A

4. Quick Check:

   Extension model purpose = add behavior without code change [OK]

Hint: Extension model = add behavior without changing tests [OK]

Common Mistakes:

• Confusing extension model with test data generation
• Thinking it replaces assertions
• Assuming it speeds up test writing

2. Which annotation is used to apply an extension to a JUnit test class?

easy

A. @ExtendWith

B. @TestExtension

C. @UseExtension

D. @EnableExtension

Solution

1. Step 1: Recall the correct annotation for extensions

   JUnit uses @ExtendWith to apply extensions to test classes or methods.

2. Step 2: Verify other options

   Options B, C, and D are not valid JUnit annotations for extensions.

3. Final Answer:

   @ExtendWith -> Option A

4. Quick Check:

   Extension annotation = @ExtendWith [OK]

Hint: Remember extension annotation is @ExtendWith [OK]

Common Mistakes:

• Using @TestExtension which does not exist
• Confusing with @UseExtension or @EnableExtension
• Forgetting the '@' symbol

3. Given the following code snippet, what will be printed when the test runs?

@ExtendWith(MyExtension.class)
class MyTest {
  @Test
  void testMethod() {
    System.out.println("Test running");
  }
}

class MyExtension implements BeforeTestExecutionCallback {
  public void beforeTestExecution(ExtensionContext context) {
    System.out.println("Before test");
  }
}

medium

A. Test running
Before test

B. Before test
Test running

C. Test running

D. Before test

Solution

1. Step 1: Understand the extension callback

   The BeforeTestExecutionCallback runs its method before the test method executes, printing "Before test" first.

2. Step 2: Order of print statements

   First "Before test" prints, then the test method prints "Test running".

3. Final Answer:

   Before test\nTest running -> Option B

4. Quick Check:

   BeforeTestExecutionCallback runs before test method [OK]

Hint: BeforeTestExecutionCallback runs before test method [OK]

Common Mistakes:

• Assuming test method prints first
• Confusing callback timing
• Ignoring extension execution order

4. Identify the error in this extension implementation:

public class MyExtension implements BeforeTestExecutionCallback {
  public void beforeTestExecution() {
    System.out.println("Before test");
  }
}

medium

A. Method beforeTestExecution should return boolean

B. Method name should be beforeTestStart

C. Class must extend AbstractExtension instead of implementing interface

D. Missing parameter ExtensionContext in beforeTestExecution method

Solution

1. Step 1: Check method signature for interface implementation

   The interface BeforeTestExecutionCallback requires beforeTestExecution(ExtensionContext context) method with one parameter.

2. Step 2: Identify missing parameter

   The method in the code has no parameters, so it does not correctly implement the interface.

3. Final Answer:

   Missing parameter ExtensionContext in beforeTestExecution method -> Option D

4. Quick Check:

   Interface method requires ExtensionContext parameter [OK]

Hint: Check method parameters match interface exactly [OK]

Common Mistakes:

• Omitting required method parameters
• Changing method return type incorrectly
• Using wrong method names

5. You want to create a JUnit extension that logs a message before and after each test method runs. Which combination of interfaces should your extension implement?

hard

A. BeforeTestExecutionCallback and AfterTestExecutionCallback

B. BeforeAllCallback and AfterAllCallback

C. BeforeEachCallback and AfterEachCallback

D. TestExecutionExceptionHandler and BeforeEachCallback

Solution

1. Step 1: Understand callback interfaces for test methods

   BeforeEachCallback runs before each test method, and AfterEachCallback runs after each test method.

2. Step 2: Match requirement to interfaces

   To log before and after each test method, implement both BeforeEachCallback and AfterEachCallback.

3. Final Answer:

   BeforeEachCallback and AfterEachCallback -> Option C

4. Quick Check:

   Before/After each test = BeforeEachCallback + AfterEachCallback [OK]

Hint: Before/After each test = BeforeEachCallback + AfterEachCallback [OK]

Common Mistakes:

• Using BeforeAllCallback which runs once per class
• Confusing AfterTestExecutionCallback with AfterEachCallback
• Choosing exception handler interfaces incorrectly