@ExtendWith annotation in JUnit - Deep Dive

Overview - @ExtendWith annotation

What is it?

The @ExtendWith annotation in JUnit 5 allows you to add extra behavior to your test classes or methods by registering extensions. Extensions can modify how tests run, add setup or teardown logic, or provide additional features like mocking or parameter injection. This annotation tells JUnit to use specific extension classes when running the tests.

Why it matters

Without @ExtendWith, tests would be limited to basic setup and assertions, making it hard to reuse common test logic or integrate advanced features. It solves the problem of adding flexible, reusable behaviors to tests without cluttering test code. Without it, test code would be repetitive, harder to maintain, and less powerful.

Where it fits

Before learning @ExtendWith, you should understand basic JUnit 5 test structure and annotations like @Test and lifecycle methods. After mastering @ExtendWith, you can explore writing custom extensions, using built-in extensions like MockitoExtension, and advanced test configuration.

Mental Model

Core Idea

@ExtendWith tells JUnit to add extra helpers that change or enhance how tests run by plugging in extension classes.

Think of it like...

It's like adding special tools to a toolbox before starting a project; these tools help you do extra tasks easily without changing your main work.

┌─────────────────────────────┐
│        Test Class           │
│  ┌───────────────────────┐  │
│  │ @ExtendWith(Extension)│  │
│  └────────────┬──────────┘  │
│               │             │
│       ┌───────▼────────┐    │
│       │ Extension Code │    │
│       └────────────────┘    │
└─────────────────────────────┘

Build-Up - 7 Steps

1

Foundation

Basics of JUnit 5 Tests

Concept: Learn how to write simple test methods using JUnit 5's @Test annotation.

In JUnit 5, you write test methods by annotating them with @Test. These methods run automatically when you run your test suite. Example: import org.junit.jupiter.api.Test; class CalculatorTest { @Test void addition() { int sum = 2 + 3; assert sum == 5; } }

Result

The test runs and passes if the assertion is true; otherwise, it fails.

Understanding the basic test structure is essential before adding any extensions or extra behaviors.

2

Foundation

What Are JUnit Extensions?

Concept: Extensions add extra behavior to tests, like setup, teardown, or modifying test execution.

JUnit 5 supports extensions that can do things like initialize resources before tests, inject parameters, or handle exceptions. Extensions are classes that implement specific interfaces from JUnit's extension API.

Result

Extensions can run code before or after tests, change test behavior, or provide extra features.

Knowing that extensions exist helps you see why @ExtendWith is needed to connect them to your tests.

3

Intermediate

Using @ExtendWith to Register Extensions

🤔Before reading on: do you think @ExtendWith can be applied to both classes and methods? Commit to your answer.

Concept: @ExtendWith registers one or more extension classes to a test class or method to add behavior.

You add @ExtendWith on a test class or method and pass the extension class name. For example: import org.junit.jupiter.api.extension.ExtendWith; @ExtendWith(MyExtension.class) class MyTest { @Test void test() { // test code } } This tells JUnit to run MyExtension's code around the tests.

Result

JUnit runs the extension code along with the test, enabling extra features or setup.

Understanding that @ExtendWith connects extensions to tests clarifies how JUnit becomes flexible and powerful.

4

Intermediate

Common Built-in Extensions with @ExtendWith

🤔Before reading on: do you think built-in extensions like MockitoExtension require @ExtendWith to work? Commit to your answer.

Concept: JUnit 5 provides built-in extensions like MockitoExtension for mocking, which you enable using @ExtendWith.

For example, to use Mockito's mocking features, you add: @ExtendWith(MockitoExtension.class) class ServiceTest { @Mock Service service; @Test void testService() { // test using mock } } This activates Mockito's extension to initialize mocks automatically.

Result

Mocks are created and injected automatically, simplifying test setup.

Knowing built-in extensions exist and how to enable them saves time and avoids boilerplate code.

5

Intermediate

Applying @ExtendWith at Method Level

Concept: You can apply @ExtendWith on individual test methods to add extensions only for those tests.

Instead of adding @ExtendWith on the whole class, you can add it on a single test method: class MyTest { @Test @ExtendWith(MyExtension.class) void specialTest() { // test with extension } @Test void normalTest() { // test without extension } } This limits the extension's effect to just one test.

Result

Only the annotated test method runs with the extension behavior.

Knowing you can scope extensions narrowly helps keep tests clean and focused.

6

Advanced

Creating Custom Extensions for @ExtendWith

🤔Before reading on: do you think custom extensions must implement a specific interface? Commit to your answer.

Concept: You can write your own extension classes by implementing JUnit's Extension interfaces and register them with @ExtendWith.

For example, create a simple extension that prints before and after each test: import org.junit.jupiter.api.extension.*; public class LoggingExtension implements BeforeTestExecutionCallback, AfterTestExecutionCallback { @Override public void beforeTestExecution(ExtensionContext context) { System.out.println("Starting " + context.getDisplayName()); } @Override public void afterTestExecution(ExtensionContext context) { System.out.println("Finished " + context.getDisplayName()); } } Use it: @ExtendWith(LoggingExtension.class) class MyTest { @Test void test() {} } This prints messages around each test execution.

Result

Custom code runs before and after tests, enabling tailored behaviors.

Understanding how to create extensions unlocks powerful customization of test execution.

7

Expert

Extension Execution Order and Interaction

🤔Before reading on: do you think multiple extensions run in the order they are declared or in reverse? Commit to your answer.

Concept: When multiple extensions are registered, JUnit runs them in a specific order, which affects how they interact and wrap test execution.

If you register multiple extensions: @ExtendWith({ExtA.class, ExtB.class}) class TestClass {} JUnit runs ExtA before ExtB before the test, and after the test, ExtB finishes before ExtA. This nesting means ExtA wraps ExtB and the test. Understanding this helps avoid conflicts and design extensions that cooperate well.

Result

Extensions wrap each other in a stack-like manner, affecting setup and teardown order.

Knowing extension order prevents subtle bugs and helps design complex test behaviors.

Under the Hood

JUnit 5 uses a modular extension model where @ExtendWith registers extension classes implementing callback interfaces. At runtime, JUnit creates instances of these extensions and calls their methods at defined lifecycle points (before test, after test, parameter resolution, etc.). Extensions form a chain or stack, wrapping test execution to add or modify behavior dynamically.

Why designed this way?

JUnit 5 was designed to be flexible and extensible, unlike JUnit 4's rigid runners. The extension model allows multiple independent behaviors to be composed cleanly. This design avoids inheritance-based complexity and supports modern testing needs like dependency injection and mocking.

┌───────────────────────────────┐
│          Test Runner           │
├───────────────┬───────────────┤
│ @ExtendWith   │               │
│ registers     │               │
│ extensions    │               │
│               ▼               │
│   ┌───────────────────────┐   │
│   │ Extension 1           │   │
│   │ (Before/After hooks)  │   │
│   └──────────┬────────────┘   │
│              │                │
│   ┌──────────▼────────────┐   │
│   │ Extension 2           │   │
│   │ (Parameter Resolver)  │   │
│   └──────────┬────────────┘   │
│              │                │
│       ┌──────▼───────┐        │
│       │ Test Method  │        │
│       └──────────────┘        │
└───────────────────────────────┘

Myth Busters - 4 Common Misconceptions

Quick: Does @ExtendWith automatically apply extensions to all tests in the project? Commit to yes or no.

Common Belief: Many think @ExtendWith applies globally to all tests once declared anywhere.

Reality: @ExtendWith only applies to the test class or method it annotates. It does not apply globally unless used in a meta-annotation or test framework configuration.

Why it matters: Assuming global effect can cause confusion when extensions don't run where expected, leading to wasted debugging time.

Quick: Do you think @ExtendWith can register multiple extensions by listing them comma-separated inside a single annotation? Commit to yes or no.

Common Belief: Some believe you can write @ExtendWith(Ext1.class, Ext2.class) to register multiple extensions.

Reality: You must use the array syntax: @ExtendWith({Ext1.class, Ext2.class}). Comma-separated arguments without braces cause syntax errors.

Why it matters: Incorrect syntax leads to compilation errors, blocking test runs and frustrating beginners.

Quick: Does applying @ExtendWith on a test method override class-level extensions? Commit to yes or no.

Common Belief: Some think method-level @ExtendWith replaces class-level extensions for that method.

Reality: Method-level @ExtendWith adds extensions in addition to class-level ones; it does not replace them.

Why it matters: Misunderstanding this can cause unexpected extension behavior or duplicated effects.

Quick: Do you think extensions registered with @ExtendWith can modify test method parameters? Commit to yes or no.

Common Belief: Many believe extensions only run before or after tests and cannot inject parameters.

Reality: Extensions can implement ParameterResolver to inject parameters into test methods dynamically.

Why it matters: Knowing this unlocks powerful test designs with dependency injection, improving test clarity and reuse.

Expert Zone

1

Extensions can be combined to form complex behaviors, but their order affects how they wrap tests, so careful ordering is crucial.

2

Custom extensions can access the test context, including test method details and annotations, enabling context-aware behavior.

3

Extensions can be registered globally via the ServiceLoader mechanism, allowing project-wide behaviors without @ExtendWith on every class.

When NOT to use

Avoid using @ExtendWith for simple setup or teardown that can be done with @BeforeEach or @AfterEach. For global behaviors, prefer registering extensions via configuration files or ServiceLoader to reduce annotation clutter.

Production Patterns

In real projects, @ExtendWith is used to enable mocking frameworks, manage database transactions, inject test data, or handle environment setup. Teams often create reusable custom extensions for common test patterns to keep tests clean and consistent.

Connections

Dependency Injection

Builds-on

Understanding how @ExtendWith enables parameter injection in tests helps grasp dependency injection principles used widely in software design.

Aspect-Oriented Programming (AOP)

Similar pattern

Extensions in JUnit act like aspects that wrap and modify behavior around test execution, similar to how AOP adds cross-cutting concerns in applications.

Plugin Systems in Software

Same pattern

JUnit's extension model with @ExtendWith is a plugin system allowing external code to extend core functionality, a pattern common in many software platforms.

Common Pitfalls

#1 Forgetting to use braces when registering multiple extensions.

Wrong approach:

@ExtendWith(Ext1.class, Ext2.class)
class TestClass {}

Correct approach:

@ExtendWith({Ext1.class, Ext2.class})
class TestClass {}

Root cause:

Misunderstanding Java annotation syntax for arrays causes compilation errors.

#2 Assuming @ExtendWith applies globally without explicit registration.

Wrong approach:

Adding @ExtendWith only on one test class and expecting all tests to use the extension.

Correct approach:

Add @ExtendWith on each test class or register the extension globally via configuration.

Root cause:

Confusing annotation scope with global configuration leads to missing extension behavior.

#3 Using @ExtendWith on a test method expecting it to replace class-level extensions.

Wrong approach:

class TestClass {
@ExtendWith(ExtA.class)
@Test
void test1() {}

@ExtendWith(ExtB.class)
@Test
void test2() {}
}

Correct approach:

Understand that both ExtA and ExtB run for their respective methods along with any class-level extensions; to isolate, avoid class-level @ExtendWith or design extensions accordingly.

Root cause:

Misunderstanding how method-level and class-level extensions combine causes unexpected extension stacking.

Key Takeaways

@ExtendWith is the key to adding flexible, reusable behaviors to JUnit 5 tests by registering extension classes.

Extensions can modify test execution, inject parameters, or add setup and teardown logic without cluttering test code.

You can apply @ExtendWith at class or method level, and multiple extensions can be combined using array syntax.

Creating custom extensions unlocks powerful test customization beyond built-in features.

Understanding extension order and scope prevents subtle bugs and helps design maintainable test suites.

Practice

1. What is the primary purpose of the @ExtendWith annotation in JUnit 5?

easy

A. To mark a method as a test case

B. To disable a test method temporarily

C. To register extensions that add extra behavior to tests

D. To specify the order of test execution

Solution

1. Step 1: Understand the role of @ExtendWith

   This annotation is used to register extensions that can add behavior before, after, or around tests.

2. Step 2: Compare with other annotations

   Other annotations like @Test mark test methods, but @ExtendWith is specifically for extensions.

3. Final Answer:

   To register extensions that add extra behavior to tests -> Option C

4. Quick Check:

   @ExtendWith = register extensions [OK]

Hint: Remember: @ExtendWith adds extra test behavior [OK]

Common Mistakes:

• Confusing @ExtendWith with @Test
• Thinking it disables tests
• Assuming it controls test order

2. Which of the following is the correct syntax to use @ExtendWith to register a custom extension named MyExtension.class on a test class?

easy

A. @ExtendWith(MyExtension.class) public class TestClass {}

B. @ExtendWith{MyExtension.class} public class TestClass {}

C. @ExtendWith[MyExtension.class] public class TestClass {}

D. @ExtendWith public class TestClass {}

Solution

1. Step 1: Recall correct annotation syntax

   Annotations use parentheses with class references, like @ExtendWith(MyExtension.class).

2. Step 2: Identify invalid syntax

   Curly braces, square brackets, or angle brackets are not valid for this annotation.

3. Final Answer:

   @ExtendWith(MyExtension.class) public class TestClass {} -> Option A

4. Quick Check:

   Annotation syntax uses parentheses () [OK]

Hint: Use parentheses () with class name for annotations [OK]

Common Mistakes:

• Using curly braces {} instead of parentheses
• Using square brackets [] or angle brackets <>
• Omitting .class after the class name

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

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

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

medium

A. Before test

B. Test running\nBefore test

C. Test running

D. Before test\nTest running

Solution

1. Step 1: Understand extension behavior

   The MyExtension implements BeforeTestExecutionCallback, so it runs code before the test method.

2. Step 2: Trace output order

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

3. Final Answer:

   Before test\nTest running -> Option D

4. Quick Check:

   Extension beforeTestExecution runs before test method [OK]

Hint: BeforeTestExecutionCallback runs before test method [OK]

Common Mistakes:

• Assuming extension runs after test
• Ignoring extension output
• Confusing output order

4. Identify the error in the following JUnit 5 test class using @ExtendWith:

@ExtendWith
public class FaultyTest {
    @Test
    void testSomething() {}
}

medium

A. @ExtendWith cannot be used on classes

B. @ExtendWith is missing the extension class argument

C. The test method must be static

D. The test method must return a value

Solution

1. Step 1: Check @ExtendWith usage

   The annotation requires specifying which extension class to use, e.g., @ExtendWith(MyExtension.class).

2. Step 2: Validate other options

   It is valid on classes, test methods do not need to be static or return values.

3. Final Answer:

   @ExtendWith is missing the extension class argument -> Option B

4. Quick Check:

   @ExtendWith needs extension class specified [OK]

Hint: Always specify extension class inside @ExtendWith() [OK]

Common Mistakes:

• Omitting the extension class argument
• Thinking @ExtendWith can't be on classes
• Believing test methods must be static

5. You want to reuse a setup logic that prints "Setup done" before each test method in multiple test classes. How should you apply @ExtendWith to achieve this cleanly?

hard

A. Create a custom extension class implementing BeforeEachCallback and annotate each test class with @ExtendWith(YourExtension.class)

B. Add a static method printing "Setup done" and call it manually in each test method

C. Use @BeforeAll annotation in each test class to print "Setup done"

D. Annotate each test method with @ExtendWith(YourExtension.class) instead of the class

Solution

1. Step 1: Identify reusable setup approach

   Implementing a custom extension with BeforeEachCallback allows running code before each test method.

2. Step 2: Apply @ExtendWith on test classes

   Annotating test classes with @ExtendWith(YourExtension.class) reuses the setup logic cleanly across classes.

3. Step 3: Evaluate other options

   Manually calling methods or using @BeforeAll is less reusable or runs only once per class. Annotating methods individually is repetitive.

4. Final Answer:

   Create a custom extension class implementing BeforeEachCallback and annotate each test class with @ExtendWith(YourExtension.class) -> Option A

5. Quick Check:

   Custom extension + @ExtendWith on class = reusable setup [OK]

Hint: Use custom extension + @ExtendWith on class for reusable setup [OK]

Common Mistakes:

• Calling setup manually in each test
• Using @BeforeAll for per-test setup
• Annotating each test method instead of class