@EnabledOnJre for JRE-specific tests in JUnit - Build an Automation Script

Verify method behavior only on Java 17 runtime

Preconditions (2)

Step 1: Create a test method annotated with @EnabledOnJre(JRE.JAVA_17)

Step 2: Inside the test method, call the method that behaves differently on Java 17

Step 3: Assert the expected output or behavior specific to Java 17

✅ Expected Result: The test runs and passes only if the runtime is Java 17; otherwise, it is skipped.

Automation Requirements - JUnit 5

Assertions Needed:

Assert that the method returns the expected value on Java 17

Best Practices:

Use @EnabledOnJre annotation to restrict test execution to specific JRE versions

Use assertions from org.junit.jupiter.api.Assertions

Keep test methods small and focused

Avoid hardcoding JRE version checks inside test logic

Automated Solution

JUnit

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

public class JreSpecificTest {

    // Method that behaves differently on Java 17
    public String getFeatureMessage() {
        // Simulate behavior
        return "Feature available on Java 17";
    }

    @Test
    @EnabledOnJre(JRE.JAVA_17)
    void testFeatureMessageOnJava17() {
        String message = getFeatureMessage();
        assertEquals("Feature available on Java 17", message, "Message should match on Java 17");
    }
}

This test class uses @EnabledOnJre(JRE.JAVA_17) to run the test only when the runtime is Java 17. The getFeatureMessage() method simulates a feature that is specific to Java 17. The test asserts that the returned message matches the expected string. If the test runs on any other JRE version, it will be skipped automatically by JUnit 5.

This approach keeps the test clean and focused on the Java 17 environment without manual version checks inside the test code.

Common Mistakes - 3 Pitfalls

{'mistake': 'Not using @EnabledOnJre and instead checking System.getProperty("java.version") inside the test', 'why_bad': 'This mixes test logic with environment checks and makes tests harder to read and maintain.', 'correct_approach': 'Use @EnabledOnJre annotation to let JUnit handle version-based test execution cleanly.'}

Using @EnabledOnJre but specifying an unsupported or misspelled JRE version

Writing large tests that combine multiple JRE-specific behaviors in one method

Bonus Challenge

Now add tests for Java 11 and Java 17 using @EnabledOnJre with different expected messages

Show Hint

Practice

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

easy

A. To run a test only on specified Java Runtime Environment versions

B. To disable a test permanently

C. To run a test on all Java versions except specified ones

D. To enable tests only on the latest Java version

Solution

1. Step 1: Understand the annotation purpose

   <code>@EnabledOnJre

2. Step 2: Match purpose with options

   To run a test only on specified Java Runtime Environment versions correctly states it runs tests only on specified JRE versions, while others describe different behaviors.

3. Final Answer:

   To run a test only on specified Java Runtime Environment versions -> Option A

4. Quick Check:

   @EnabledOnJre = run test on chosen JRE versions [OK]

Hint: Think: runs tests only on chosen Java versions [OK]

Common Mistakes:

• Confusing @EnabledOnJre with disabling tests
• Assuming it runs tests on all versions except specified
• Thinking it only enables tests on the latest Java version

2. Which of the following is the correct syntax to enable a test only on Java 17 using @EnabledOnJre?

easy

A. @EnabledOnJre(javaVersion = "17")

B. @EnabledOnJre(version = 17)

C. @EnabledOnJre(JRE.JAVA_17)

D. @EnabledOnJre(value = "JAVA_17")

Solution

1. Step 1: Recall correct annotation usage

   The correct syntax uses the enum constant from JRE, like @EnabledOnJre(JRE.JAVA_17).

2. Step 2: Compare options

   Only @EnabledOnJre(JRE.JAVA_17) uses the correct enum constant syntax. Others use invalid or incorrect attribute names or formats.

3. Final Answer:

   @EnabledOnJre(JRE.JAVA_17) -> Option C

4. Quick Check:

   Use enum JRE.JAVA_17 inside @EnabledOnJre [OK]

Hint: Use enum JRE.JAVA_17 inside parentheses [OK]

Common Mistakes:

• Using string values instead of enum constants
• Using incorrect attribute names like version or javaVersion
• Missing the enum prefix JRE.

3. Given the test annotated with @EnabledOnJre({JRE.JAVA_11, JRE.JAVA_17}), what happens when running on Java 15?

medium

A. The test runs normally

B. The test is skipped

C. The test fails with an error

D. The test runs but logs a warning

Solution

1. Step 1: Understand the annotation behavior

   The test runs only on Java 11 or Java 17 as specified.

2. Step 2: Check Java 15 behavior

   Since Java 15 is not in the list, the test is skipped automatically.

3. Final Answer:

   The test is skipped -> Option B

4. Quick Check:

   Test runs only on specified JREs, else skipped [OK]

Hint: Test runs only on listed JREs; others skip [OK]

Common Mistakes:

• Assuming test runs on any Java version
• Expecting test to fail instead of skip
• Thinking test logs a warning when skipped

4. Identify the error in this test annotation: @EnabledOnJre(JRE.JAVA_8, JRE.JAVA_11)

medium

A. JRE.JAVA_8 is not a valid enum constant

B. The annotation cannot be used with more than one JRE

C. The annotation requires a string, not enum constants

D. Multiple JREs must be inside curly braces {}

Solution

1. Step 1: Check annotation syntax for multiple JREs

   When specifying multiple JREs, they must be enclosed in curly braces as an array.

2. Step 2: Analyze given annotation

   The annotation uses parentheses with multiple enum constants without braces, which is invalid syntax.

3. Final Answer:

   Multiple JREs must be inside curly braces {} -> Option D

4. Quick Check:

   Multiple JREs need braces: {@code @EnabledOnJre({JRE.JAVA_8, JRE.JAVA_11})} [OK]

Hint: Use curly braces for multiple JREs inside @EnabledOnJre [OK]

Common Mistakes:

• Omitting curly braces for multiple JREs
• Using strings instead of enum constants
• Thinking multiple JREs are not allowed

5. You want to write a test that runs only on Java 8, 11, and 17, but skips on all other versions. Which is the correct way to annotate the test?

hard

A. @EnabledOnJre({JRE.JAVA_8, JRE.JAVA_11, JRE.JAVA_17})

B. @EnabledOnJre(JRE.JAVA_8, JRE.JAVA_11, JRE.JAVA_17)

C. @EnabledOnJre(value = {"JAVA_8", "JAVA_11", "JAVA_17"})

D. @EnabledOnJre(versions = {JRE.JAVA_8, JRE.JAVA_11, JRE.JAVA_17})

Solution

1. Step 1: Recall correct syntax for multiple JREs

   Multiple JREs must be passed as an array inside curly braces using enum constants.

2. Step 2: Evaluate options

   @EnabledOnJre({JRE.JAVA_8, JRE.JAVA_11, JRE.JAVA_17}) correctly uses @EnabledOnJre({JRE.JAVA_8, JRE.JAVA_11, JRE.JAVA_17}). @EnabledOnJre(JRE.JAVA_8, JRE.JAVA_11, JRE.JAVA_17) misses braces, C uses strings instead of enums, D uses a wrong attribute name.

3. Final Answer:

   @EnabledOnJre({JRE.JAVA_8, JRE.JAVA_11, JRE.JAVA_17}) -> Option A

4. Quick Check:

   Use enum array with braces for multiple JREs [OK]

Hint: Use enum array with braces for multiple JREs [OK]

Common Mistakes:

• Missing curly braces for multiple JREs
• Using strings instead of enum constants
• Using incorrect attribute names like versions or value