Why Custom argument providers in JUnit? - Purpose & Use Cases

The Big Idea

What if you could run hundreds of tests with different data by writing just one smart provider?

The Scenario

Imagine you have a test that needs to run many times with different sets of data. You write each test case by hand, copying and changing values over and over.

This feels like filling out a long form again and again without any help.

The Problem

Manually writing each test case is slow and boring. It's easy to make mistakes like typos or forgetting a case.

When data changes, you must update every test by hand, which wastes time and causes errors.

The Solution

Custom argument providers let you write one smart piece of code that feeds many test cases automatically.

This means your tests run with all needed data without repeating yourself or risking mistakes.

Before vs After

✗ Before

@Test
void testAdd() {
  assertEquals(3, add(1, 2));
  assertEquals(5, add(2, 3));
  assertEquals(7, add(3, 4));
}

✓ After

@ParameterizedTest
@ArgumentsSource(MyProvider.class)
void testAdd(int a, int b, int expected) {
  assertEquals(expected, add(a, b));
}

What It Enables

You can easily run many test cases with complex or changing data, all managed in one place.

Real Life Example

Testing a calculator app with many input combinations, like positive, negative, zero, and large numbers, without writing separate tests for each.

Key Takeaways

Manual test data writing is slow and error-prone.

Custom argument providers automate feeding data to tests.

This saves time and reduces mistakes in testing.

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