@EnabledOnOs for OS-specific tests in JUnit

Introduction

Sometimes tests should run only on certain operating systems. @EnabledOnOs helps run tests only on the OS you want.

You want to test a feature that works only on Windows.

You have code that behaves differently on MacOS and want to test it there.

You want to skip tests on Linux because they fail due to OS differences.

You are testing OS-specific file paths or commands.

You want to avoid running tests on unsupported OS to save time.

Syntax

JUnit

@EnabledOnOs(OS.WINDOWS)
void testMethod() {
    // test code
}

You can specify one or more OS values inside @EnabledOnOs.

This annotation is part of JUnit 5 and helps control test execution based on OS.

Examples

This test runs only on Windows OS.

JUnit

@EnabledOnOs(OS.WINDOWS)
void testWindowsOnly() {
    // test code for Windows
}

This test runs only on MacOS and Linux.

JUnit

@EnabledOnOs({OS.MAC, OS.LINUX})
void testUnixLike() {
    // test code for Mac and Linux
}

This test runs only on Linux OS.

JUnit

@EnabledOnOs(OS.LINUX)
void testLinuxOnly() {
    // test code for Linux
}

Sample Program

This class has two tests. One runs only on Windows, the other runs only on Mac and Linux. When you run the tests on your OS, only the matching tests run.

JUnit

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledOnOs;
import org.junit.jupiter.api.condition.OS;

public class OsSpecificTest {

    @Test
    @EnabledOnOs(OS.WINDOWS)
    void testRunsOnlyOnWindows() {
        System.out.println("Running Windows-specific test");
        // Imagine some Windows-only logic tested here
    }

    @Test
    @EnabledOnOs({OS.MAC, OS.LINUX})
    void testRunsOnMacAndLinux() {
        System.out.println("Running Mac/Linux-specific test");
        // Imagine some Unix-like OS logic tested here
    }
}

Important Notes

If you run the sample on Windows, only the Windows test prints its message.

On Mac or Linux, only the Mac/Linux test prints its message.

Tests skipped by @EnabledOnOs are marked as skipped in the test report.

Summary

@EnabledOnOs runs tests only on specified operating systems.

Use it to avoid running tests where they don't apply or would fail.

It helps keep test runs fast and relevant to the environment.

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 &