@EnumSource supplies constants of an enum to a @ParameterizedTest.

Java source and doc

EnumSource definition

package org.junit.jupiter.params.provider;

// Simplified EnumSource annotation (structure only)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Repeatable(EnumSources.class)
@ArgumentsSource(EnumArgumentsProvider.class)
public @interface EnumSource {

    // Enum type
    Class<? extends Enum<?>> value() default NullEnum.class;

    // Names or regular expressions of enum to be provided
    String[] names() default {};

    // Range start
    String from() default "";

    // Range end
    String to() default "";

    // Mode for interpreting names
    Mode mode() default Mode.INCLUDE;

    // Enum selection modes (definitions only)
    enum Mode {
        INCLUDE,
        EXCLUDE,
        MATCH_ALL,
        MATCH_ANY,
        MATCH_NONE;
    }
}

Example

package com.logicbig.example;

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;

import static org.junit.jupiter.api.Assertions.assertTrue;

public class ParameterizedEnumSourceTest {

    enum Direction {NORTH, SOUTH, EAST, WEST}

    @ParameterizedTest(name = "#{index} enum value: {0}")
    @EnumSource(Direction.class)
    void allEnumConstantsShouldHaveName(Direction dir) {
        assertTrue(dir.name().length() > 0);
    }

    @ParameterizedTest(name = "#{index} included: {0}")
    @EnumSource(value = Direction.class, names = {"NORTH", "SOUTH"})
    void includeSpecificConstants(Direction dir) {
        assertTrue(dir == Direction.NORTH || dir == Direction.SOUTH);
    }

    @ParameterizedTest(name = "#{index} excluded: {0}")
    @EnumSource(value = Direction.class, names = {"EAST", "WEST"}, mode = EnumSource.Mode.EXCLUDE)
    void excludeSomeConstants(Direction dir) {
        assertTrue(dir == Direction.NORTH || dir == Direction.SOUTH);
    }
}

mvn test -Dtest=ParameterizedEnumSourceTest

Output

D:\example-projects\junit-5\junit-5-parameterized-tests\junit-5-parameterized-enumsource>mvn test -Dtest=ParameterizedEnumSourceTest
[INFO] Scanning for projects...
[INFO] 
[INFO] -------< com.logicbig.example:junit-5-parameterized-enumsource >--------
[INFO] Building junit-5-parameterized-enumsource 1.0-SNAPSHOT
[INFO]   from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- resources:3.3.1:resources (default-resources) @ junit-5-parameterized-enumsource ---
[INFO] skip non existing resourceDirectory D:\example-projects\junit-5\junit-5-parameterized-tests\junit-5-parameterized-enumsource\src\main\resources
[INFO] 
[INFO] --- compiler:3.14.1:compile (default-compile) @ junit-5-parameterized-enumsource ---
[INFO] No sources to compile
[INFO] 
[INFO] --- resources:3.3.1:testResources (default-testResources) @ junit-5-parameterized-enumsource ---
[INFO] skip non existing resourceDirectory D:\example-projects\junit-5\junit-5-parameterized-tests\junit-5-parameterized-enumsource\src\test\resources
[INFO] 
[INFO] --- compiler:3.14.1:testCompile (default-testCompile) @ junit-5-parameterized-enumsource ---
[INFO] Recompiling the module because of changed source code.
[INFO] Compiling 1 source file with javac [debug target 25] to target\test-classes
[INFO] 
[INFO] --- surefire:3.5.0:test (default-test) @ junit-5-parameterized-enumsource ---
[INFO] Using auto detected provider org.apache.maven.surefire.junitplatform.JUnitPlatformProvider
[INFO] 
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] +--com.logicbig.example.ParameterizedEnumSourceTest - 0.148 ss
[INFO] |  +-- [OK] includeSpecificConstants(Direction) #1 included: NORTH - 0.031 ss
[INFO] |  +-- [OK] includeSpecificConstants(Direction) #2 included: SOUTH - 0 ss
[INFO] |  +-- [OK] allEnumConstantsShouldHaveName(Direction) #1 enum value: NORTH - 0 ss
[INFO] |  +-- [OK] allEnumConstantsShouldHaveName(Direction) #2 enum value: SOUTH - 0 ss
[INFO] |  +-- [OK] allEnumConstantsShouldHaveName(Direction) #3 enum value: EAST - 0.001 ss
[INFO] |  +-- [OK] allEnumConstantsShouldHaveName(Direction) #4 enum value: WEST - 0.002 ss
[INFO] |  +-- [OK] excludeSomeConstants(Direction) #1 excluded: NORTH - 0.003 ss
[INFO] |  '-- [OK] excludeSomeConstants(Direction) #2 excluded: SOUTH - 0 ss
[INFO] 
[INFO] Results:
[INFO] 
[INFO] Tests run: 8, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  3.767 s
[INFO] Finished at: 2025-12-04T14:39:47+08:00
[INFO] ------------------------------------------------------------------------

Example Project

Dependencies and Technologies Used:

• junit-jupiter-engine 6.0.1 (Module "junit-jupiter-engine" of JUnit)
   Version Compatibility: 5.0.0 - 6.0.1Version List
  ×

  Version compatibilities of junit-jupiter-engine with this example:

  • 5.0.0
  • 5.0.1
  • 5.0.2
  • 5.0.3
  • 5.1.0
  • 5.1.1
  • 5.2.0
  • 5.3.0
  • 5.3.1
  • 5.3.2
  • 5.4.0
  • 5.4.1
  • 5.4.2
  • 5.5.0
  • 5.5.1
  • 5.5.2
  • 5.6.0
  • 5.6.1
  • 5.6.2
  • 5.6.3
  • 5.7.0
  • 5.7.1
  • 5.7.2
  • 5.8.0
  • 5.8.1
  • 5.8.2
  • 5.9.0
  • 5.9.1
  • 5.9.2
  • 5.9.3
  • 5.10.0
  • 5.10.1
  • 5.10.2
  • 5.10.3
  • 5.10.4
  • 5.10.5
  • 5.11.0
  • 5.11.1
  • 5.11.2
  • 5.11.3
  • 5.11.4
  • 5.12.0
  • 5.12.1
  • 5.12.2
  • 5.13.0
  • 5.13.1
  • 5.13.2
  • 5.13.3
  • 5.13.4
  • 5.14.0
  • 5.14.1
  • 6.0.0
  • 6.0.1

  Versions in green have been tested.

• junit-jupiter-params 6.0.1 (Module "junit-jupiter-params" of JUnit)
  
• JDK 25
• Maven 3.9.11