@EnabledOnOs for OS-specific tests in JUnit - Framework Patterns

Framework Mode - @EnabledOnOs for OS-specific tests

Folder Structure

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── Application.java
│   └── test/
│       └── java/
│           └── com/example/app/
│               ├── pages/
│               │   └── LoginPage.java
│               ├── tests/
│               │   ├── LoginTests.java
│               │   └── OsSpecificTests.java  <-- OS-specific tests here
│               ├── utils/
│               │   └── TestUtils.java
│               └── config/
│                   └── TestConfig.java
└── pom.xml

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown for browser control.
• Page Objects: Classes representing UI pages with methods for user actions.
• Tests: Contains test classes, including OS-specific tests using @EnabledOnOs.
• Utilities: Helper methods for common tasks like waits, data generation.
• Configuration: Central place for environment variables, browser settings, credentials.

OS-specific tests use JUnit 5's @EnabledOnOs annotation to run tests only on certain operating systems.

Configuration Patterns

• Environment Profiles: Use Maven profiles or system properties to switch environments (dev, test, prod).
• Browser Selection: Pass browser type as a system property or config file value.
• Credentials: Store securely in environment variables or encrypted files, accessed via config classes.
• OS Detection: JUnit 5 @EnabledOnOs handles OS detection internally, no extra config needed.

Test Reporting and CI/CD Integration

• Use JUnit 5 built-in reports or integrate with tools like Surefire or Gradle test reports.
• Generate HTML or XML reports for easy viewing.
• Integrate with CI/CD pipelines (Jenkins, GitHub Actions) to run tests on multiple OS agents.
• OS-specific tests run only on matching OS agents, avoiding false failures.

Best Practices

1. Use @EnabledOnOs to isolate OS-dependent tests: This keeps tests clean and avoids failures on unsupported OS.
2. Keep OS-specific tests separate: Place them in dedicated test classes or packages for clarity.
3. Use descriptive test names: Indicate OS dependency in test method names or class names.
4. Run tests on real OS environments: Use CI agents or VMs matching target OS for reliable results.
5. Fail fast on unsupported OS: Use @DisabledOnOs if needed to skip tests on certain OS.

Self Check

Where in this folder structure would you add a new test class that runs only on Windows OS using @EnabledOnOs?

Key Result

Use @EnabledOnOs in dedicated test classes under src/test/java to run OS-specific tests cleanly.