@EnabledOnOs for OS-specific tests in JUnit - Build an Automation Script

Verify feature behavior only on Windows OS

Preconditions (2)

Step 1: Create a test method annotated with @EnabledOnOs(OS.WINDOWS)

Step 2: Inside the test method, perform a simple assertion like checking a string equals 'Windows'

Step 3: Run the test on Windows OS and observe it runs

Step 4: Run the test on a non-Windows OS and observe it is skipped

✅ Expected Result: The test runs and passes only on Windows OS. On other OS, the test is skipped and does not fail.

Automation Requirements - JUnit 5

Assertions Needed:

Assert that a string equals 'Windows' inside the test method

Best Practices:

Use @EnabledOnOs annotation to restrict test execution by OS

Keep test methods simple and focused

Use descriptive test method names

Avoid hardcoding OS checks inside test logic

Automated Solution

JUnit

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

public class OperatingSystemTest {

    @Test
    @EnabledOnOs(OS.WINDOWS)
    void testRunsOnlyOnWindows() {
        String osName = "Windows";
        assertEquals("Windows", osName, "Test should run only on Windows OS");
    }
}

The test class OperatingSystemTest contains one test method testRunsOnlyOnWindows.

This method is annotated with @EnabledOnOs(OS.WINDOWS), which means JUnit will run this test only if the OS is Windows.

Inside the test, we assert that the string osName equals "Windows". This simple assertion confirms the test logic.

If you run this test on Windows, it will execute and pass. On other OS like Linux or Mac, JUnit will skip this test without failing it.

This approach keeps OS-specific tests clean and avoids manual OS checks inside the test code.

Common Mistakes - 3 Pitfalls

{'mistake': 'Not importing the correct JUnit 5 annotations', 'why_bad': "The test will not compile or the annotations won't work as expected", 'correct_approach': 'Import org.junit.jupiter.api.condition.EnabledOnOs and org.junit.jupiter.api.condition.OS'}

Using @EnabledOnOs on a test method but running on unsupported OS expecting it to fail

Hardcoding OS checks inside test logic instead of using @EnabledOnOs

Bonus Challenge

Now add tests that run only on Linux and Mac OS using @EnabledOnOs with multiple OS values

Show Hint

Practice

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

easy

A. To specify the Java version for a test

B. To disable a test permanently

C. To run tests in parallel

D. To run a test only on specified operating systems

Solution

1. Step 1: Understand the role of @EnabledOnOs

   This annotation controls on which operating systems a test should run.

2. Step 2: Compare with other options

   Options B, C, and D describe different functionalities unrelated to OS-specific test execution.

3. Final Answer:

   To run a test only on specified operating systems -> Option D

4. Quick Check:

   @EnabledOnOs = Run test on specific OS [OK]

Hint: Think: runs tests only on chosen OS platforms [OK]

Common Mistakes:

• Confusing @EnabledOnOs with disabling tests
• Assuming it controls Java version
• Thinking it manages test parallelism

2. Which of the following is the correct syntax to enable a test only on Windows OS using @EnabledOnOs?

easy

A. @EnabledOnOs(OS.WINDOWS)

B. @EnabledOnOs(OS.WIN)

C. @EnabledOnOs("Windows")

D. @EnabledOnOs(os = "Windows")

Solution

1. Step 1: Recall the correct enum usage

   The @EnabledOnOs annotation uses the enum OS with constants like WINDOWS.

2. Step 2: Check each option's syntax

   @EnabledOnOs(OS.WINDOWS) uses the correct enum constant OS.WINDOWS. Options A, B, and C use invalid syntax or strings instead of enum constants.

3. Final Answer:

   @EnabledOnOs(OS.WINDOWS) -> Option A

4. Quick Check:

   Use enum OS.WINDOWS for Windows [OK]

Hint: Use enum OS constants, not strings or wrong names [OK]

Common Mistakes:

• Using string literals instead of enum constants
• Using incorrect enum names like OS.WIN
• Adding parameters incorrectly

3. Given the following test code snippet, what will happen when running on Linux OS?

@Test
@EnabledOnOs(OS.WINDOWS)
void testOnlyOnWindows() {
    System.out.println("Running Windows test");
}

medium

A. The test will run and print "Running Windows test"

B. The test will be skipped and not run

C. The test will fail with an exception

D. The test will run but print nothing

Solution

1. Step 1: Understand the annotation effect on Linux

   The test is enabled only on Windows OS, so on Linux it should not run.

2. Step 2: Determine test behavior on unsupported OS

   JUnit skips tests annotated with @EnabledOnOs if the current OS does not match.

3. Final Answer:

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

4. Quick Check:

   Test runs only on Windows, skipped on Linux [OK]

Hint: If OS doesn't match, test is skipped automatically [OK]

Common Mistakes:

• Assuming test runs but prints nothing
• Expecting a failure or exception
• Thinking test runs on all OS by default

4. Identify the error in this test code snippet:

@Test
@EnabledOnOs(OS.LINUX, OS.MAC)
void testOnUnix() {
    // test code
}

medium

A. OS.LINUX and OS.MAC are invalid enum constants

B. The annotation should be @DisabledOnOs instead

C. Multiple OS values must be inside an array

D. The method must be static to use @EnabledOnOs

Solution

1. Step 1: Check annotation parameter format

   The @EnabledOnOs annotation expects an array of OS enums when specifying multiple OSes.

2. Step 2: Identify correct syntax

   Correct syntax is @EnabledOnOs({OS.LINUX, OS.MAC}). The code misses curly braces for the array. Thus, Multiple OS values must be inside an array correctly identifies that multiple OS values must be inside an array.

3. Final Answer:

   Multiple OS values must be inside an array -> Option C

4. Quick Check:

   Use curly braces for multiple OS enums [OK]

Hint: Use curly braces {} for multiple OS enums [OK]

Common Mistakes:

• Omitting curly braces for multiple OS values
• Confusing @EnabledOnOs with @DisabledOnOs
• Thinking method must be static

5. You want a test to run only on Windows and Mac OS but skip on Linux. Which is the correct way to write the @EnabledOnOs annotation for this requirement?

hard

A. @EnabledOnOs({OS.WINDOWS, OS.MAC})

B. @EnabledOnOs(OS.WINDOWS, OS.MAC, OS.LINUX)

C. @EnabledOnOs(OS.WINDOWS) @EnabledOnOs(OS.MAC)

D. @EnabledOnOs(OS.WINDOWS & OS.MAC)

Solution

1. Step 1: Understand how to specify multiple OSes

   Multiple OSes must be provided as an array inside curly braces in @EnabledOnOs.

2. Step 2: Evaluate each option

   @EnabledOnOs({OS.WINDOWS, OS.MAC}) correctly uses an array with OS.WINDOWS and OS.MAC. @EnabledOnOs(OS.WINDOWS, OS.MAC, OS.LINUX) includes Linux, which should be excluded. @EnabledOnOs(OS.WINDOWS) @EnabledOnOs(OS.MAC) uses multiple annotations, which is invalid. @EnabledOnOs(OS.WINDOWS & OS.MAC) uses an invalid bitwise operator.

3. Final Answer:

   @EnabledOnOs({OS.WINDOWS, OS.MAC}) -> Option A

4. Quick Check:

   Use array with OS enums to include multiple OSes [OK]

Hint: Use curly braces with OS enums for multiple OSes [OK]

Common Mistakes:

• Including unwanted OS like Linux
• Using multiple @EnabledOnOs annotations
• Using invalid operators like &