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.

Practice

1. What is the main purpose of running Selenium tests in headless mode?

easy

A. To run tests without opening the browser window

B. To slow down the test execution for debugging

C. To enable visual testing with screenshots

D. To run tests only on mobile devices

Solution

1. Step 1: Understand headless mode concept

   Headless mode means running browser tests without showing the browser window on screen.

2. Step 2: Identify the main purpose

   This mode is mainly used to run tests faster and on servers where no display is available.

3. Final Answer:

   To run tests without opening the browser window -> Option A

4. Quick Check:

   Headless mode = No browser window [OK]

Hint: Headless means no visible browser window during tests [OK]

Common Mistakes:

• Thinking headless slows down tests
• Confusing headless with mobile testing
• Assuming headless always shows screenshots

2. Which of the following is the correct way to enable headless mode for ChromeDriver in Selenium Java?

easy

A. ChromeOptions options = new ChromeOptions(); options.setHeadless(true);

B. ChromeOptions options = new ChromeOptions(); options.addArguments("--headless");

C. ChromeOptions options = new ChromeOptions(); options.addArguments("headless-mode");

D. ChromeOptions options = new ChromeOptions(); options.enableHeadless();

Solution

1. Step 1: Recall correct syntax for headless mode

   In Selenium Java, headless mode is enabled by adding the argument "--headless" to ChromeOptions.

2. Step 2: Check each option

   Only ChromeOptions options = new ChromeOptions(); options.addArguments("--headless"); uses the correct method and argument syntax.

3. Final Answer:

   ChromeOptions options = new ChromeOptions(); options.addArguments("--headless"); -> Option B

4. Quick Check:

   Use addArguments("--headless") to enable headless [OK]

Hint: Use addArguments("--headless") to enable headless mode [OK]

Common Mistakes:

• Using incorrect argument names like "headless-mode"
• Trying to call non-existent methods like enableHeadless()
• Assuming setHeadless(true) exists in ChromeOptions

3. What will be the output when running the following Selenium Java code snippet?

ChromeOptions options = new ChromeOptions();
options.addArguments("--headless");
WebDriver driver = new ChromeDriver(options);
driver.get("https://example.com");
System.out.println(driver.getTitle());
driver.quit();

medium

A. Prints an empty string because page did not load

B. Throws an error because headless mode cannot get page titles

C. Prints the page title of https://example.com without opening a browser window

D. Opens a visible browser window and prints the title

Solution

1. Step 1: Understand headless mode behavior

   Headless mode runs browser without UI but still loads pages and executes scripts normally.

2. Step 2: Analyze code output

   The code loads example.com and prints its title. This works fine in headless mode.

3. Final Answer:

   Prints the page title of https://example.com without opening a browser window -> Option C

4. Quick Check:

   Headless loads page and gets title correctly [OK]

Hint: Headless runs full browser logic but no UI shown [OK]

Common Mistakes:

• Assuming headless mode disables page loading
• Thinking getTitle() returns empty in headless
• Expecting visible browser window in headless mode

4. Identify the error in the following Selenium Java code snippet intended to run Chrome in headless mode:

ChromeOptions options = new ChromeOptions();
options.addArguments("headless");
WebDriver driver = new ChromeDriver(options);
driver.get("https://example.com");

medium

A. The argument should be "--headless" with two dashes

B. ChromeOptions cannot be used with ChromeDriver

C. WebDriver must be cast to ChromeDriver explicitly

D. The get() method cannot be called in headless mode

Solution

1. Step 1: Check argument syntax for headless mode

   The correct argument to enable headless mode is "--headless" with two dashes, not "headless".

2. Step 2: Verify other code parts

   Using ChromeOptions with ChromeDriver and calling get() is valid. No casting needed.

3. Final Answer:

   The argument should be "--headless" with two dashes -> Option A

4. Quick Check:

   Use "--headless" argument exactly [OK]

Hint: Headless argument needs two dashes: "--headless" [OK]

Common Mistakes:

• Using single dash or no dash in headless argument
• Thinking ChromeOptions can't be passed to ChromeDriver
• Believing get() is disabled in headless mode

5. You want to run Selenium tests in headless mode on both Chrome and Firefox browsers using Java. Which approach correctly sets headless mode for both browsers?

hard

A. Use ChromeOptions.setHeadless(true) for Chrome and FirefoxOptions.addArguments("--headless") for Firefox

B. Use ChromeOptions.setHeadless(true) for Chrome and FirefoxOptions.setHeadless(true) for Firefox

C. Use ChromeOptions.addArguments("--headless") for Chrome and FirefoxOptions.addArguments("headless") for Firefox

D. Use ChromeOptions.addArguments("--headless") for Chrome and FirefoxOptions.setHeadless(true) for Firefox

Solution

1. Step 1: Recall how to enable headless mode in Chrome and Firefox

   In Selenium Java, Chrome uses addArguments("--headless") to enable headless mode. FirefoxOptions has a setHeadless(true) method.

2. Step 2: Match correct methods for each browser

   Use ChromeOptions.addArguments("--headless") for Chrome and FirefoxOptions.setHeadless(true) for Firefox correctly uses addArguments for Chrome and setHeadless for Firefox.

3. Final Answer:

   Use ChromeOptions.addArguments("--headless") for Chrome and FirefoxOptions.setHeadless(true) for Firefox -> Option D

4. Quick Check:

   Chrome uses addArguments, Firefox uses setHeadless [OK]

Hint: Chrome uses addArguments, Firefox uses setHeadless(true) [OK]

Common Mistakes:

• Using setHeadless(true) for Chrome which does not exist
• Using incorrect argument like "headless" without dashes for Firefox
• Mixing methods between browsers incorrectly