Page class design in Selenium Java - Framework Patterns

Framework Mode - Page class design

Folder Structure

src/
  test/
    java/
      com/
        example/
          tests/
            LoginTest.java
            CheckoutTest.java
          pages/
            LoginPage.java
            HomePage.java
            CheckoutPage.java
          utils/
            DriverFactory.java
            WaitUtils.java
          config/
            ConfigReader.java
            TestData.java

Test Framework Layers

• Driver Layer: Manages browser setup and teardown (e.g., DriverFactory.java).
• Page Objects: Classes representing web pages (e.g., LoginPage.java) with locators and methods to interact with page elements.
• Tests: Test classes that use page objects to perform test scenarios (e.g., LoginTest.java).
• Utilities: Helper classes for waits, logging, or common actions (e.g., WaitUtils.java).
• Configuration: Classes or files to manage environment settings, test data, and credentials (e.g., ConfigReader.java).

Configuration Patterns

• Environment Properties: Use property files or environment variables to store URLs, browser types, and credentials.
• ConfigReader.java: Reads configuration values at runtime to allow easy switching between environments (dev, test, prod).
• DriverFactory.java: Uses config to initialize the correct browser driver (Chrome, Firefox, etc.).
• Test Data: Store test data separately in files or classes (e.g., TestData.java) to keep tests clean and maintainable.

Test Reporting and CI/CD Integration

• TestNG Reports: Use TestNG framework for running tests and generating HTML reports.
• Logging: Add logs in page methods and tests for easier debugging.
• CI/CD: Integrate with Jenkins or GitHub Actions to run tests automatically on code changes.
• Failure Screenshots: Capture screenshots on test failure for better analysis.

Best Practices for Page Class Design

• Single Responsibility: Each page class should represent one page and contain only its elements and actions.
• Encapsulation: Keep locators private and expose only meaningful methods to interact with the page.
• Readable Methods: Use clear method names like login(String user, String pass) instead of exposing low-level clicks.
• Reusability: Avoid duplicating code by creating common methods in base page classes or utilities.
• Explicit Waits: Use waits inside page methods to handle dynamic page elements reliably.

Self Check

Where in this folder structure would you add a new page object class for the "Profile" page?

Answer: Add ProfilePage.java inside the src/test/java/com/example/pages/ folder.

Key Result

Use page classes to encapsulate web page elements and actions for clean, maintainable Selenium tests in Java.

Practice

1. What is the main purpose of a page class in Selenium Java?

easy

A. To handle API requests

B. To write test assertions directly

C. To group web page elements and actions in one place

D. To manage database connections

Solution

1. Step 1: Understand the role of page classes

   Page classes organize locators and actions related to a specific web page.

2. Step 2: Identify the main purpose

   This organization improves code readability and reuse by keeping page details in one place.

3. Final Answer:

   To group web page elements and actions in one place -> Option C

4. Quick Check:

   Page class purpose = Group elements and actions [OK]

Hint: Page classes group elements and actions per page [OK]

Common Mistakes:

• Confusing page classes with test classes
• Using page classes for database or API logic
• Writing assertions inside page classes

2. Which of the following is the correct way to declare a locator in a Selenium page class using Java?

easy

A. public void submitButton = driver.findElement(By.id("submit"));

B. public String submitButton = "submit";

C. private WebElement submitButton = driver.findElement(By.id("submit"));

D. private By submitButton = By.id("submit");

Solution

1. Step 1: Recall best practice for locators

   Locators should be stored as By objects, not WebElement, to delay element lookup.

2. Step 2: Check each option

   private By submitButton = By.id("submit"); correctly declares a private By locator with By.id("submit").

3. Final Answer:

   private By submitButton = By.id("submit"); -> Option D

4. Quick Check:

   Locators = By objects [OK]

Hint: Use By for locators, not WebElement directly [OK]

Common Mistakes:

• Declaring locators as WebElement fields
• Using public visibility for locators
• Assigning void type to variables

3. Given the following page class snippet, what will loginPage.getTitle() return if the page title is "Welcome Page"?

public class LoginPage {
  private WebDriver driver;
  public LoginPage(WebDriver driver) {
    this.driver = driver;
  }
  public String getTitle() {
    return driver.getTitle();
  }
}

medium

A. "Welcome Page"

B. "Login Page"

C. null

D. Throws NullPointerException

Solution

1. Step 1: Understand getTitle() method

   The method calls driver.getTitle(), which returns the current page title.

2. Step 2: Match with given page title

   The page title is "Welcome Page", so getTitle() returns this string.

3. Final Answer:

   "Welcome Page" -> Option A

4. Quick Check:

   driver.getTitle() = "Welcome Page" [OK]

Hint: driver.getTitle() returns current page title string [OK]

Common Mistakes:

• Assuming getTitle() returns page class name
• Expecting null if not set explicitly
• Confusing with element text retrieval

4. Identify the error in this page class method:

public void clickLogin() {
  WebElement loginBtn = driver.findElement(By.id("login"));
  loginBtn.click();
}

medium

A. No error, method is correct

B. Should store locator as a By field, not find element inside method

C. Missing exception handling for element not found

D. Method should return WebElement instead of void

Solution

1. Step 1: Review locator usage best practice

   Locators should be stored as By fields in the page class, not found inside methods.

2. Step 2: Identify the problem

   Finding element inside method reduces reuse and violates page class design principles.

3. Final Answer:

   Should store locator as a By field, not find element inside method -> Option B

4. Quick Check:

   Locators as By fields = best practice [OK]

Hint: Keep locators as fields, find elements in methods [OK]

Common Mistakes:

• Finding elements repeatedly inside methods
• Ignoring locator reuse
• Assuming exception handling is mandatory here

5. You want to design a page class for a login page with username, password fields, and a login button. Which design approach is best to follow?

hard

A. Store locators as private By fields; create public methods to enter username, enter password, and click login

B. Store WebElement fields publicly and access them directly in tests

C. Write all test steps inside the page class constructor

D. Use static methods only without storing any locators

Solution

1. Step 1: Recall page class design principles

   Locators should be private By fields; actions should be public methods for reuse and encapsulation.

2. Step 2: Evaluate options

   Store locators as private By fields; create public methods to enter username, enter password, and click login follows best practice by separating locators and actions clearly.

3. Final Answer:

   Store locators as private By fields; create public methods to enter username, enter password, and click login -> Option A

4. Quick Check:

   Private locators + public methods = best design [OK]

Hint: Private locators + public action methods = good page class [OK]

Common Mistakes:

• Making locators public and exposing WebElements
• Putting test logic in constructors
• Using static methods without instance context