EnabledIfEnvironmentVariable and DisabledIfEnvironmentVariable can be used to run enable/disable tests based on environment-variables.
Java source and doc
Definition of EnabledIfEnvironmentVariable(Version: junit-5 6.0.1) package org.junit.jupiter.api.condition;
........
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(EnabledIfEnvironmentVariables.class)
@ExtendWith(EnabledIfEnvironmentVariableCondition.class)
@API(status = STABLE, since = "5.1")
@SuppressWarnings("exports")
public @interface EnabledIfEnvironmentVariable {
String named(); 1
String matches(); 2
@API(status = STABLE, since = "5.7")
String disabledReason() default ""; 3
}
Definition of DisabledIfEnvironmentVariable(Version: junit-5 6.0.1) package org.junit.jupiter.api.condition;
........
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(DisabledIfEnvironmentVariables.class)
@ExtendWith(DisabledIfEnvironmentVariableCondition.class)
@API(status = STABLE, since = "5.1")
@SuppressWarnings("exports")
public @interface DisabledIfEnvironmentVariable {
String named(); 1
String matches(); 2
@API(status = STABLE, since = "5.7")
String disabledReason() default ""; 3
}
Overview
@EnabledIfEnvironmentVariable runs tests only if the variable matches a regex.
@DisabledIfEnvironmentVariable skips tests when the variable matches.
Quick syntax
@EnabledIfEnvironmentVariable(named = "APP_ENV", matches = "dev|test")
void test() { /* ... */ }
Example
Environment variable conditions
package com.logicbig.example;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.DisabledIfEnvironmentVariable;
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
import static org.junit.jupiter.api.Assertions.assertTrue;
class EnvironmentVariableConditionExamplesTest {
@Test
@EnabledIfEnvironmentVariable(named = "APP_ENV", matches = "dev|test")
void runs_only_in_dev_or_test_env() {
assertTrue(true);
}
@Test
@DisabledIfEnvironmentVariable(named = "CI", matches = "true")
void skipped_on_ci_servers() {
assertTrue(true);
}
@Test
void always_runs_control() {
assertTrue(true);
}
}
set APP_ENV=dev && mvn test -Dtest=EnvironmentVariableConditionExamplesTest OutputD:\example-projects\junit-5\junit-5-enabling-disabling-tests\junit-5-enabled-disabled-for-environment-variable>set APP_ENV=dev && mvn test -Dtest=EnvironmentVariableConditionExamplesTest [INFO] Scanning for projects... [INFO] [INFO] --< com.logicbig.example:junit-5-enabled-disabled-for-environment-variable >-- [INFO] Building junit-5-enabled-disabled-for-environment-variable 1.0-SNAPSHOT [INFO] from pom.xml [INFO] --------------------------------[ jar ]--------------------------------- [INFO] [INFO] --- resources:3.3.1:resources (default-resources) @ junit-5-enabled-disabled-for-environment-variable --- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent! [INFO] skip non existing resourceDirectory D:\example-projects\junit-5\junit-5-enabling-disabling-tests\junit-5-enabled-disabled-for-environment-variable\src\main\resources [INFO] [INFO] --- compiler:3.14.1:compile (default-compile) @ junit-5-enabled-disabled-for-environment-variable --- [INFO] No sources to compile [INFO] [INFO] --- resources:3.3.1:testResources (default-testResources) @ junit-5-enabled-disabled-for-environment-variable --- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent! [INFO] skip non existing resourceDirectory D:\example-projects\junit-5\junit-5-enabling-disabling-tests\junit-5-enabled-disabled-for-environment-variable\src\test\resources [INFO] [INFO] --- compiler:3.14.1:testCompile (default-testCompile) @ junit-5-enabled-disabled-for-environment-variable --- [INFO] Nothing to compile - all classes are up to date. [INFO] [INFO] --- surefire:3.5.0:test (default-test) @ junit-5-enabled-disabled-for-environment-variable --- [INFO] Using auto detected provider org.apache.maven.surefire.junitplatform.JUnitPlatformProvider [INFO] [INFO] ------------------------------------------------------- [INFO] T E S T S [INFO] ------------------------------------------------------- [INFO] +--com.logicbig.example.EnvironmentVariableConditionExamplesTest - 0.088 ss [INFO] | +-- [OK] always_runs_control - 0.035 ss [INFO] | +-- [OK] skipped_on_ci_servers - 0.007 ss [INFO] | '-- [OK] runs_only_in_dev_or_test_env - 0.003 ss [INFO] [INFO] Results: [INFO] [INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0 [INFO] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 3.339 s [INFO] Finished at: 2025-12-03T23:11:15+08:00 [INFO] ------------------------------------------------------------------------
Running in IntelliJ
 Example ProjectDependencies and Technologies Used: - junit-jupiter-engine 6.0.1 (Module "junit-jupiter-engine" of JUnit)
Version Compatibility: 5.1.0 - 6.0.1 Version compatibilities of junit-jupiter-engine with this example:
- 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.
- JDK 25
- Maven 3.9.11
|