@EnabledIfEnvironmentVariable in JUnit - Build an Automation Script

Verify test execution only when environment variable is set

Preconditions (1)

Step 1: Check the environment variable TEST_ENV value

Step 2: If TEST_ENV is 'true', run the test method

Step 3: If TEST_ENV is not 'true', skip the test method

Step 4: Inside the test method, assert that 2 + 2 equals 4

✅ Expected Result: The test runs and passes only if TEST_ENV is 'true'. Otherwise, the test is skipped.

Automation Requirements - JUnit 5

Assertions Needed:

Assert that 2 + 2 equals 4

Best Practices:

Use @EnabledIfEnvironmentVariable annotation to conditionally enable test

Use Assertions.assertEquals for validation

Keep test method simple and focused

Include clear test method name describing the condition

Automated Solution

JUnit

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class EnvironmentVariableTest {

    @Test
    @EnabledIfEnvironmentVariable(named = "TEST_ENV", matches = "true")
    void testRunsOnlyIfEnvVarIsTrue() {
        assertEquals(4, 2 + 2, "2 + 2 should equal 4");
    }
}

This test class uses JUnit 5's @EnabledIfEnvironmentVariable annotation to run the test method only when the environment variable TEST_ENV is set to the string "true".

The test method testRunsOnlyIfEnvVarIsTrue asserts that 2 + 2 equals 4 using assertEquals. If the environment variable does not match, JUnit will skip this test automatically.

This approach keeps the test simple and clear, and uses JUnit's built-in conditional test execution feature.

Common Mistakes - 4 Pitfalls

Using @EnabledIfEnvironmentVariable with incorrect environment variable name

Using @EnabledIfEnvironmentVariable with a wrong regex pattern in matches attribute

Not setting the environment variable before running the test

Using @EnabledIfEnvironmentVariable on a class without understanding it applies to all tests

Bonus Challenge

Now add two more test methods that run only when TEST_ENV is 'false' and when TEST_ENV is unset, respectively.

Show Hint

Practice

1. What is the main purpose of the @EnabledIfEnvironmentVariable annotation in JUnit?

easy

A. To set environment variables before running tests

B. To disable all tests in a test class

C. To run a test only if a specific environment variable has a certain value

D. To run tests in parallel threads

Solution

1. Step 1: Understand the annotation's role

   <code>@EnabledIfEnvironmentVariable

2. Step 2: Identify its effect on tests

   It enables tests only when the environment variable matches the given value, skipping otherwise.

3. Final Answer:

   To run a test only if a specific environment variable has a certain value -> Option C

4. Quick Check:

   Runs test if env var matches = A [OK]

Hint: Think: runs test only if env var matches value [OK]

Common Mistakes:

• Confusing it with disabling tests
• Assuming it sets environment variables
• Thinking it controls test parallelism

2. Which of the following is the correct syntax to enable a test only when the environment variable ENV equals prod using @EnabledIfEnvironmentVariable?

easy

A. @EnabledIfEnvironmentVariable(named = "ENV", matches = "prod")

B. @EnabledIfEnvironmentVariable(name = "ENV", value = "prod")

C. @EnabledIfEnvironmentVariable(variable = "ENV", equals = "prod")

D. @EnabledIfEnvironmentVariable(env = "ENV", match = "prod")

Solution

1. Step 1: Recall correct attribute names

   The annotation uses named for the environment variable name and matches for the expected value.

2. Step 2: Match syntax with options

   @EnabledIfEnvironmentVariable(named = "ENV", matches = "prod") correctly uses named = "ENV" and matches = "prod".

3. Final Answer:

   @EnabledIfEnvironmentVariable(named = "ENV", matches = "prod") -> Option A

4. Quick Check:

   Correct attribute names = A [OK]

Hint: Remember: named and matches are correct attributes [OK]

Common Mistakes:

• Using incorrect attribute names like name or value
• Mixing attribute names with variable or env
• Using equals or match instead of matches

3. Given the following test code snippet, what will happen if the environment variable MODE is set to test?

@EnabledIfEnvironmentVariable(named = "MODE", matches = "prod")
void runOnlyInProd() {
    System.out.println("Running in prod mode");
}

medium

A. The test will be skipped and not run

B. The test will run and print "Running in prod mode"

C. The test will fail with an exception

D. The test will run but print nothing

Solution

1. Step 1: Check environment variable value

   The environment variable MODE is set to test, but the annotation requires prod.

2. Step 2: Understand annotation behavior

   Since the value does not match, the test is skipped and does not run.

3. Final Answer:

   The test will be skipped and not run -> Option A

4. Quick Check:

   Env var mismatch skips test = B [OK]

Hint: If env var value differs, test is skipped [OK]

Common Mistakes:

• Assuming test runs regardless of env var
• Expecting an exception on mismatch
• Thinking test runs but prints nothing

4. Identify the error in the following JUnit test code using @EnabledIfEnvironmentVariable:

@EnabledIfEnvironmentVariable(named = "APP_ENV", match = "dev")
void testInDev() {
    // test code
}

medium

A. The annotation must be placed on the class, not the method

B. The attribute name should be 'matches' instead of 'match'

C. The method must be static

D. The environment variable name cannot be 'APP_ENV'

Solution

1. Step 1: Check attribute names in annotation

   The correct attribute for matching value is matches, not match.

2. Step 2: Verify other code aspects

   Environment variable name can be any string, method need not be static, and annotation can be on method.

3. Final Answer:

   The attribute name should be 'matches' instead of 'match' -> Option B

4. Quick Check:

   Correct attribute is matches, not match [OK]

Hint: Use 'matches' attribute, not 'match' [OK]

Common Mistakes:

• Using 'match' instead of 'matches'
• Thinking method must be static
• Believing annotation only works on class

5. You want to run a test only if the environment variable DEPLOY_ENV is set to either staging or production. How can you achieve this using @EnabledIfEnvironmentVariable in JUnit?

hard

A. Use @EnabledIfEnvironmentVariable(named = "DEPLOY_ENV", matches = "staging,production") with comma-separated values

B. Use two test methods each annotated with @EnabledIfEnvironmentVariable(named = "DEPLOY_ENV", matches = "staging") and @EnabledIfEnvironmentVariable(named = "DEPLOY_ENV", matches = "production") respectively

C. Use @EnabledIfEnvironmentVariable(named = "DEPLOY_ENV", matches = "staging") and add an OR condition inside the test method

D. Use @EnabledIfEnvironmentVariable(named = "DEPLOY_ENV", matches = "staging|production") with regex matching

Solution

1. Step 1: Understand annotation supports regex

   The matches attribute supports regular expressions to match multiple values.

2. Step 2: Use regex for multiple values

   Using staging|production matches either value in one annotation.

3. Final Answer:

   Use @EnabledIfEnvironmentVariable(named = "DEPLOY_ENV", matches = "staging|production") with regex matching -> Option D

4. Quick Check:

   Regex in matches handles multiple values = B [OK]

Hint: Use regex in matches to cover multiple values [OK]

Common Mistakes:

• Trying to list multiple values with commas
• Splitting into multiple test methods unnecessarily
• Adding logic inside test instead of annotation