Custom argument providers in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Custom Argument Provider in JUnit?

A Custom Argument Provider is a way to supply test method parameters dynamically by implementing the ArgumentsProvider interface. It allows you to control the test data for parameterized tests beyond simple static values.

beginner

Which interface must you implement to create a Custom Argument Provider in JUnit?

You must implement the org.junit.jupiter.params.provider.ArgumentsProvider interface and override the provideArguments(ExtensionContext context) method.

intermediate

How do you link a Custom Argument Provider to a parameterized test method?

You create a custom annotation annotated with @ArgumentsSource(YourCustomProvider.class) and then use that annotation on the test method.

intermediate

What type of object does the provideArguments method return?

It returns a Stream<Arguments>, where each Arguments instance represents a set of parameters for one test invocation.

advanced

Why use a Custom Argument Provider instead of @ValueSource or @CsvSource?

Custom Argument Providers allow complex, dynamic, or external data sources for test parameters, such as reading from files, databases, or generating data programmatically, which static sources cannot handle.

Which method must be overridden when creating a Custom Argument Provider in JUnit?

A generateArguments()

B getArguments()

C provideParameters()

D provideArguments(ExtensionContext context)

The ArgumentsProvider interface requires overriding provideArguments(ExtensionContext context) to supply test arguments.

What does the Arguments class represent in JUnit parameterized tests?

A A single set of parameters for one test run

B A test method

C A test result

D A test annotation

Arguments holds the parameters passed to a single invocation of a parameterized test.

How do you connect a Custom Argument Provider to a test method parameter?

A Using @ArgumentsSource with the provider class

B Using @ValueSource

C Using @Test

D Using @BeforeEach

You use @ArgumentsSource(YourProvider.class) to link the custom provider to the test parameter.

Which Java type does the provideArguments method return?

A Set<Object>

B List<String>

C Stream<Arguments>

D Map<String, Object>

The method returns a Stream<Arguments> to supply multiple argument sets.

Why might you prefer a Custom Argument Provider over @CsvSource?

A Because @CsvSource is deprecated

B To generate or fetch complex or dynamic test data

C To write less code

D To avoid using annotations

Custom providers allow dynamic or external data sources, unlike static @CsvSource.

Explain how to create and use a Custom Argument Provider in JUnit parameterized tests.

Think about the interface, method, return type, and how to connect it to the test.

Describe scenarios where a Custom Argument Provider is more useful than built-in sources like @ValueSource or @CsvSource.

Consider limitations of static data sources.

Practice

1. What is the main purpose of a custom argument provider in JUnit?

easy

A. To generate test reports

B. To create new test methods automatically

C. To supply test data to parameterized tests in a custom way

D. To replace the @Test annotation

Solution

1. Step 1: Understand the role of argument providers

   Argument providers supply data to parameterized tests, allowing tests to run multiple times with different inputs.

2. Step 2: Identify the purpose of custom argument providers

   Custom argument providers let you define your own way to supply test data beyond built-in sources.

3. Final Answer:

   To supply test data to parameterized tests in a custom way -> Option C

4. Quick Check:

   Custom argument providers = supply test data [OK]

Hint: Custom providers supply test data uniquely for parameterized tests [OK]

Common Mistakes:

• Confusing argument providers with test method creators
• Thinking they replace @Test annotation
• Assuming they generate reports

2. Which interface must you implement to create a custom argument provider in JUnit?

easy

A. ArgumentsSource

B. ArgumentsProvider

C. TestTemplateInvocationContextProvider

D. TestInstancePostProcessor

Solution

1. Step 1: Recall JUnit interfaces for argument providers

   The interface to implement for custom argument providers is ArgumentsProvider.

2. Step 2: Differentiate from other interfaces

   ArgumentsSource is an annotation, not an interface. The others serve different purposes.

3. Final Answer:

   ArgumentsProvider -> Option B

4. Quick Check:

   Implement ArgumentsProvider for custom data [OK]

Hint: Implement ArgumentsProvider interface for custom data supply [OK]

Common Mistakes:

• Confusing ArgumentsSource annotation with interface
• Choosing unrelated interfaces
• Not overriding provideArguments method

3. Given this custom argument provider code snippet, what will be the output when the parameterized test runs?

public class MyProvider implements ArgumentsProvider {
    @Override
    public Stream<Arguments> provideArguments(ExtensionContext context) {
        return Stream.of(Arguments.of("apple"), Arguments.of("banana"));
    }
}

@ParameterizedTest
@ArgumentsSource(MyProvider.class)
void testFruits(String fruit) {
    System.out.println(fruit);
}

medium

A. apple\nbanana (each on separate lines)

B. apple banana

C. Compilation error due to missing imports

D. Runtime error due to wrong method signature

Solution

1. Step 1: Analyze the provideArguments method

   The method returns a stream with two Arguments: "apple" and "banana".

2. Step 2: Understand parameterized test execution

   The test runs twice, once with "apple" and once with "banana", printing each on its own line.

3. Final Answer:

   apple\nbanana (each on separate lines) -> Option A

4. Quick Check:

   Stream of Arguments runs test twice [OK]

Hint: Each argument runs test once, prints on separate lines [OK]

Common Mistakes:

• Assuming output is on one line
• Thinking code has syntax errors without imports
• Confusing method signature correctness

4. Identify the error in this custom argument provider implementation:

public class BadProvider implements ArgumentsProvider {
    public Stream<Arguments> provideArguments() {
        return Stream.of(Arguments.of(1), Arguments.of(2));
    }
}

medium

A. Method provideArguments must have ExtensionContext parameter

B. Missing @Override annotation

C. Arguments.of() cannot take integers

D. Class must extend ArgumentsSource

Solution

1. Step 1: Check method signature requirements

   The provideArguments method must override the interface method and accept ExtensionContext as a parameter.

2. Step 2: Identify the missing parameter

   The code's provideArguments method lacks the ExtensionContext parameter, causing a signature mismatch.

3. Final Answer:

   Method provideArguments must have ExtensionContext parameter -> Option A

4. Quick Check:

   Correct method signature requires ExtensionContext [OK]

Hint: provideArguments must accept ExtensionContext parameter [OK]

Common Mistakes:

• Ignoring method signature parameters
• Thinking @Override is mandatory but not fixing signature
• Confusing Arguments.of() usage

5. You want to create a custom argument provider that supplies pairs of integers where the second is always double the first. Which implementation correctly achieves this?

public class DoubleProvider implements ArgumentsProvider {
    @Override
    public Stream<Arguments> provideArguments(ExtensionContext context) {
        // Fill in the blank
    }
}

hard

A. return Stream.of(Arguments.of(1, 3), Arguments.of(2, 5), Arguments.of(3, 7));

B. return Stream.of(Arguments.of(1, 1), Arguments.of(2, 2), Arguments.of(3, 3));

C. return Stream.empty();

D. return Stream.of(Arguments.of(1, 2), Arguments.of(2, 4), Arguments.of(3, 6));

Solution

1. Step 1: Understand the requirement

   Each pair must have the second integer double the first.

2. Step 2: Evaluate each option

   return Stream.of(Arguments.of(1, 2), Arguments.of(2, 4), Arguments.of(3, 6)); correctly pairs (1,2), (2,4), (3,6). Other options provide pairs like (1,3),(2,5),(3,7) or equal numbers (1,1),(2,2),(3,3), or an empty stream.

3. Final Answer:

   return Stream.of(Arguments.of(1, 2), Arguments.of(2, 4), Arguments.of(3, 6)); -> Option D

4. Quick Check:

   Second integer = 2 * first integer [OK]

Hint: Check if second number is double the first in pairs [OK]

Common Mistakes:

• Providing pairs where second is not double
• Returning empty stream by mistake
• Confusing argument order