Argument conversion in JUnit - Framework Patterns

Framework Mode - Argument conversion

Folder Structure

src/
└── test/
    └── java/
        └── com/
            └── example/
                ├── converters/
                │   └── CustomArgumentConverter.java
                ├── tests/
                │   └── SampleTest.java
                └── utils/
                    └── TestUtils.java

Test Framework Layers

• Argument Converters Layer: Contains classes implementing ArgumentConverter or SimpleArgumentConverter to convert input strings to custom objects.
• Test Classes Layer: Contains JUnit test classes using @ParameterizedTest and @ConvertWith annotations to apply argument converters.
• Utilities Layer: Helper classes for common test utilities, data builders, or validation methods.
• Configuration Layer: Handles test configuration such as test profiles or environment variables (if needed).

Configuration Patterns

• Environment Variables: Use system properties or environment variables to configure test behavior if argument conversion depends on environment.
• Test Profiles: Use JUnit tags or profiles to run tests with different converters if needed.
• Centralized Converter Registration: Although JUnit 5 uses annotations to specify converters, keep converters in a dedicated package for easy maintenance.

Test Reporting and CI/CD Integration

• Use JUnit 5's built-in reporting with IDEs and build tools like Maven or Gradle.
• Integrate with CI/CD pipelines (e.g., Jenkins, GitHub Actions) to run parameterized tests automatically.
• Ensure test reports clearly show parameterized test inputs and results, including converted argument values.
• Use plugins or tools (e.g., Surefire, Allure) for enhanced reporting if needed.

Best Practices

• Keep Converters Simple: Argument converters should be focused on converting input strings to target types without side effects.
• Reuse Converters: Place converters in a common package to reuse across multiple tests.
• Use Annotations Clearly: Use @ConvertWith annotation explicitly on parameters to improve readability.
• Validate Conversion: Include validation inside converters to fail fast if input is invalid.
• Document Converters: Add comments to explain conversion logic for maintainability.

Self Check

Where in this folder structure would you add a new argument converter for a custom data type used in your tests?

Key Result

Organize argument converters in a dedicated package and apply them via annotations for clean, reusable parameterized tests.

Practice

1. What is the main purpose of using @ConvertWith in JUnit parameterized tests?

easy

A. To generate random test data automatically

B. To skip certain test cases during execution

C. To convert input arguments to the required test method parameter types

D. To log test execution details

Solution

1. Step 1: Understand the role of argument conversion

   Argument conversion changes input data into the type needed by the test method parameters.

2. Step 2: Identify the purpose of @ConvertWith

   The @ConvertWith annotation tells JUnit which converter class to use to transform the input argument.

3. Final Answer:

   To convert input arguments to the required test method parameter types -> Option C

4. Quick Check:

   Argument conversion = convert input arguments [OK]

Hint: Remember: @ConvertWith changes input type for tests [OK]

Common Mistakes:

• Thinking @ConvertWith skips tests
• Confusing conversion with logging
• Assuming it generates test data

2. Which of the following is the correct way to declare a custom argument converter class in JUnit?

easy

A. public class MyConverter extends SimpleArgumentConverter { ... }

B. public class MyConverter implements ConverterInterface { ... }

C. public class MyConverter extends ConverterBase { ... }

D. public class MyConverter implements ArgumentConverter { ... }

Solution

1. Step 1: Recall JUnit's recommended base class for converters

   JUnit provides SimpleArgumentConverter as a base class to extend for custom converters.

2. Step 2: Match the correct class declaration

   The correct syntax is to extend SimpleArgumentConverter, not implement interfaces or extend unknown classes.

3. Final Answer:

   public class MyConverter extends SimpleArgumentConverter { ... } -> Option A

4. Quick Check:

   Extend SimpleArgumentConverter = correct converter class [OK]

Hint: Custom converters extend SimpleArgumentConverter class [OK]

Common Mistakes:

• Implementing ArgumentConverter interface directly
• Extending non-existent base classes
• Using wrong interface names

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

@ParameterizedTest
@ValueSource(strings = {"42"})
void testWithConversion(@ConvertWith(MyConverter.class) Integer number) {
    System.out.println(number + 8);
}

public class MyConverter extends SimpleArgumentConverter {
    @Override
    protected Object convert(Object source, Class targetType) {
        return Integer.parseInt(source.toString());
    }
}

medium

A. 50

B. 42

C. Compilation error

D. Runtime exception

Solution

1. Step 1: Understand the conversion process

   The string "42" is converted to Integer 42 by MyConverter using Integer.parseInt.

2. Step 2: Calculate the printed output

   The test method adds 8 to the converted Integer 42, resulting in 50 printed.

3. Final Answer:

   50 -> Option A

4. Quick Check:

   42 + 8 = 50 [OK]

Hint: Convert string to int, then add 8 for output [OK]

Common Mistakes:

• Assuming no conversion happens
• Expecting string concatenation instead of addition
• Thinking code causes errors

4. Identify the error in this custom converter code:

public class MyConverter extends SimpleArgumentConverter {
    @Override
    protected Object convert(Object source, Class targetType) {
        if (targetType != Integer.class) {
            throw new IllegalArgumentException("Conversion only supports Integer");
        }
        return source;
    }
}

medium

A. The method should return Integer, not Object

B. The source is returned without converting to Integer

C. The targetType check should use equals() method

D. The class should implement ArgumentConverter interface

Solution

1. Step 1: Analyze the convert method's return value

   The method returns source directly, which is a String, not converted to Integer.

2. Step 2: Identify the missing conversion

   It should parse the source string to Integer before returning, e.g., Integer.parseInt(source.toString()).

3. Final Answer:

   The source is returned without converting to Integer -> Option B

4. Quick Check:

   Return value must be converted type [OK]

Hint: Always convert source to target type before returning [OK]

Common Mistakes:

• Returning source without conversion
• Using != instead of equals() for class check (less critical)
• Confusing return type requirements

5. You want to write a parameterized test that accepts a CSV string like "John,25,true" and converts it into a custom Person object with fields name (String), age (int), and active (boolean). Which approach correctly uses argument conversion in JUnit?

hard

A. Use @ValueSource(strings = {"John,25,true"}) and parse CSV inside the test method manually

B. Use @CsvSource with three separate parameters and no converter

C. Create a converter implementing ArgumentProvider and use @ArgumentsSource annotation

D. Create a converter extending SimpleArgumentConverter that splits the CSV and constructs Person; annotate parameter with @ConvertWith using this converter

Solution

1. Step 1: Understand the need for custom conversion

   The input is a single CSV string that must be converted into a Person object before the test runs.

2. Step 2: Identify the correct use of @ConvertWith

   Creating a converter extending SimpleArgumentConverter that parses the CSV and returns a Person object, then annotating the test parameter with @ConvertWith, is the proper approach.

3. Final Answer:

   Create a converter extending SimpleArgumentConverter that splits the CSV and constructs Person; annotate parameter with @ConvertWith using this converter -> Option D

4. Quick Check:

   Custom converter + @ConvertWith = correct approach [OK]

Hint: Use @ConvertWith with a converter that builds Person from CSV [OK]

Common Mistakes:

• Parsing CSV inside test method instead of converter
• Using wrong annotation like @ArgumentsSource
• Passing multiple parameters without conversion