Why extensions customize JUnit behavior

Introduction

Extensions let you add or change how JUnit runs tests. This helps make tests easier and more powerful without changing JUnit itself.

You want to run some code before or after every test automatically.

You need to add special setup or cleanup steps for certain tests.

You want to change how test results are reported or logged.

You want to add custom rules like retrying failed tests.

You want to inject extra data or objects into your test methods.

Syntax

JUnit

@ExtendWith(MyExtension.class)
public class MyTest {
    // test methods
}

Use @ExtendWith to tell JUnit to use your extension.

Extensions are classes that implement JUnit extension interfaces.

Examples

This example uses a timing extension to measure how long tests take.

JUnit

@ExtendWith(TimingExtension.class)
public class MyTest {
    @Test
    void testSomething() {
        // test code
    }
}

This example shows a retry extension that can rerun a test if it fails.

JUnit

import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.TestExecutionExceptionHandler;

public class RetryExtension implements TestExecutionExceptionHandler {
    @Override
    public void handleTestExecutionException(ExtensionContext context, Throwable throwable) throws Throwable {
        // retry logic here
    }
}

@ExtendWith(RetryExtension.class)
public class MyTest {
    @Test
    void testWithRetry() {
        // test code
    }
}

Sample Program

This test class uses a simple extension that prints a message before each test runs.

JUnit

import org.junit.jupiter.api.extension.*;
import org.junit.jupiter.api.*;

class SimpleExtension implements BeforeEachCallback {
    @Override
    public void beforeEach(ExtensionContext context) {
        System.out.println("Before each test: " + context.getDisplayName());
    }
}

@ExtendWith(SimpleExtension.class)
public class MyTest {
    @Test
    void testOne() {
        System.out.println("Running testOne");
        Assertions.assertTrue(true);
    }

    @Test
    void testTwo() {
        System.out.println("Running testTwo");
        Assertions.assertEquals(2, 1 + 1);
    }
}

Important Notes

Extensions help keep your test code clean by moving repeated setup or checks outside test methods.

You can combine multiple extensions on one test class.

JUnit provides many built-in extension points to customize behavior.

Summary

Extensions let you add extra behavior to JUnit tests without changing test code.

Use @ExtendWith to apply extensions to test classes or methods.

Extensions can run code before/after tests, handle exceptions, or change test data.

Practice

1. What is the main reason to use extensions in JUnit tests?

easy

A. To add extra behavior without changing the test code

B. To write test cases faster

C. To replace the JUnit framework

D. To create user interfaces for tests

Solution

1. Step 1: Understand the purpose of extensions

   Extensions allow adding extra behavior like setup or cleanup without modifying test methods.

2. Step 2: Compare options with this purpose

   Only To add extra behavior without changing the test code matches this purpose; others describe unrelated goals.

3. Final Answer:

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

4. Quick Check:

   Extensions add behavior = D [OK]

Hint: Extensions add behavior without changing tests [OK]

Common Mistakes:

• Thinking extensions speed up writing tests
• Confusing extensions with replacing JUnit
• Assuming extensions create UI

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

easy

A. @TestExtension

B. @UseExtension

C. @ExtendWith

D. @EnableExtension

Solution

1. Step 1: Recall the correct annotation for extensions

   The standard JUnit annotation to apply extensions is @ExtendWith.

2. Step 2: Verify other options

   Other options are not valid JUnit annotations for extensions.

3. Final Answer:

   @ExtendWith -> Option C

4. Quick Check:

   @ExtendWith = C [OK]

Hint: Remember '@ExtendWith' applies extensions [OK]

Common Mistakes:

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

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

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

Assuming MyExtension prints "Before test" before the test and "After test" after the test.

medium

A. Test running\nBefore test\nAfter test

B. Before test\nTest running\nAfter test

C. After test\nTest running\nBefore test

D. Test running only

Solution

1. Step 1: Understand extension behavior

   MyExtension runs code before and after the test method, printing "Before test" and "After test" respectively.

2. Step 2: Order of output

   Output order is: before test message, test method message, after test message.

3. Final Answer:

   Before test\nTest running\nAfter test -> Option B

4. Quick Check:

   Extension runs before/after test = A [OK]

Hint: Extensions run code before and after tests [OK]

Common Mistakes:

• Assuming extension runs after test only
• Mixing order of printed lines
• Ignoring extension output

4. Identify the error in this JUnit test using an extension:

@ExtendWith(MyExtension.class)
class TestClass {
  @Test
  void test() {
    System.out.println("Running test");
  }

  void helper() {
    System.out.println("Helper method");
  }
}

Why might helper() not be called during test execution?

medium

A. Extension disables helper methods

B. Helper method must be private

C. Helper method must be static

D. Helper method is not annotated with @Test

Solution

1. Step 1: Check method annotations

   Only methods annotated with @Test run as tests; helper() lacks this annotation.

2. Step 2: Understand extension role

   Extensions do not disable helper methods; they only affect test lifecycle.

3. Final Answer:

   Helper method is not annotated with @Test -> Option D

4. Quick Check:

   Missing @Test means no run = B [OK]

Hint: Only @Test methods run automatically [OK]

Common Mistakes:

• Thinking extensions disable helper methods
• Believing helper must be static or private
• Assuming all methods run as tests

5. You want to create a JUnit extension that changes test data before each test runs. Which approach best uses extensions to achieve this?

hard

A. Implement BeforeEachCallback and modify test data in beforeEach()

B. Override the test method and change data inside it

C. Use @Test annotation with parameters to change data

D. Create a separate test class for each data variation

Solution

1. Step 1: Identify extension interface for pre-test actions

   The BeforeEachCallback interface allows running code before each test method.

2. Step 2: Apply this to modify test data

   Modifying test data in beforeEach() method is the correct way to customize data before tests.

3. Final Answer:

   Implement BeforeEachCallback and modify test data in beforeEach() -> Option A

4. Quick Check:

   BeforeEachCallback modifies data before tests = A [OK]

Hint: Use BeforeEachCallback to run code before tests [OK]

Common Mistakes:

• Trying to override test methods directly
• Misusing @Test parameters for data changes
• Creating many classes instead of using extensions