@EnabledIfEnvironmentVariable in JUnit - Framework Patterns

Framework Mode - @EnabledIfEnvironmentVariable

Folder Structure

src/
└── test/
    └── java/
        └── com/
            └── example/
                ├── pages/
                │   └── LoginPage.java
                ├── tests/
                │   └── LoginTests.java
                ├── utils/
                │   └── EnvironmentUtils.java
                └── config/
                    └── TestConfig.java
    

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown for browser automation.
• Page Objects: Encapsulate UI elements and actions for each page (e.g., LoginPage.java).
• Tests: Contains test classes using JUnit with annotations like @EnabledIfEnvironmentVariable to conditionally run tests.
• Utilities: Helper classes such as EnvironmentUtils to read environment variables or provide common methods.
• Configuration: Central place for test settings, environment URLs, credentials (e.g., TestConfig.java).

Configuration Patterns

Use environment variables to control test execution dynamically. For example, set RUN_SMOKE_TESTS=true in your environment.

In JUnit 5, @EnabledIfEnvironmentVariable(named = "RUN_SMOKE_TESTS", matches = "true") enables tests only if the variable matches.

Store environment-specific data in TestConfig.java or external files, and load them based on environment variables like TEST_ENV=staging.

Test Reporting and CI/CD Integration

• Use JUnit's built-in reports or integrate with tools like Surefire or Gradle test reports.
• Configure CI pipelines (Jenkins, GitHub Actions) to set environment variables before running tests.
• Conditional test execution via @EnabledIfEnvironmentVariable helps run only relevant tests per environment or build type.
• Reports clearly show skipped tests when environment variables do not match, aiding test result analysis.

Best Practices

1. Use environment variables for flexible test control: Avoid hardcoding test execution conditions.
2. Keep environment variable names consistent and documented: Makes it easy for team members to understand and use.
3. Combine @EnabledIfEnvironmentVariable with other JUnit conditions: For fine-grained control over test runs.
4. Provide default values or fallback logic in utilities: To handle missing environment variables gracefully.
5. Log environment variable values at test start: Helps debugging why tests ran or skipped.

Self Check

Where in this folder structure would you add a new test class that should only run when the environment variable RUN_INTEGRATION_TESTS is set to true?

Key Result

Use @EnabledIfEnvironmentVariable in JUnit tests to conditionally run tests based on environment variables for flexible and environment-aware test execution.

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