Headless execution in Selenium Java - Framework Patterns

Framework Mode - Headless execution

Folder Structure

selenium-java-project/
├── src/
│   └── test/
│       └── java/
│           ├── pages/           # Page Object classes
│           │   └── LoginPage.java
│           ├── tests/           # Test classes
│           │   └── LoginTest.java
│           ├── utils/           # Utility classes (e.g., WebDriverFactory)
│           │   └── WebDriverFactory.java
│           └── config/          # Configuration classes
│               └── ConfigManager.java
├── testng.xml                  # TestNG suite configuration
├── pom.xml                     # Maven dependencies and build
└── resources/
    └── config.properties       # Environment and browser settings

Test Framework Layers

• Driver Layer: WebDriverFactory.java manages WebDriver instances, including headless mode setup.
• Page Objects: Classes representing web pages with locators and actions (e.g., LoginPage.java).
• Tests: Test classes using TestNG that call page objects and WebDriverFactory.
• Utilities: Helper classes for common tasks like waits, logging, and reading configs.
• Configuration: ConfigManager.java reads properties like browser type and headless flag from config.properties.

Configuration Patterns

Use a config.properties file to store environment variables:

• browser=chrome
• headless=true
• baseUrl=https://example.com

ConfigManager.java reads these properties and provides getters.

WebDriverFactory.java uses these settings to create WebDriver instances. For headless execution, it sets ChromeOptions or FirefoxOptions with the headless argument.

This allows switching between headless and headed modes without code changes, just by editing config.properties.

Test Reporting and CI/CD Integration

• Use TestNG reports for test execution results (pass/fail).
• Integrate with CI tools like Jenkins or GitHub Actions to run tests in headless mode on build servers.
• Headless mode is essential for CI environments without GUI.
• Use plugins like Allure or ExtentReports for enhanced HTML reports.
• Configure CI pipelines to read config.properties or override headless flag via environment variables.

Best Practices for Headless Execution Framework

1. Centralize WebDriver creation: Use a factory class to manage driver setup including headless options.
2. Use configuration files: Control headless mode and browser choice externally to avoid code changes.
3. Explicit waits: Use waits to handle dynamic content since headless browsers may behave faster.
4. Validate headless runs: Regularly run tests in headed mode locally to catch UI issues not visible headlessly.
5. Logging and screenshots: Capture logs and screenshots on failure to debug headless runs.

Self Check

Where in this folder structure would you add a new utility class to handle screenshots during headless test failures?

Key Result

Use a WebDriver factory with configuration files to enable easy switching between headless and headed browser execution.