Utility classes in Selenium Java - Framework Patterns

Framework Mode - Utility classes

Folder Structure

src/
├── main/
│   └── java/
│       └── com/example/project/
│           ├── pages/           # Page Object classes
│           ├── utils/           # Utility classes (e.g., WebDriverUtils, WaitUtils)
│           └── config/          # Configuration classes
└── test/
    └── java/
        └── com/example/project/
            ├── tests/           # Test classes
            └── data/            # Test data classes or files

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown.
• Page Objects: Represent web pages with methods to interact with UI elements.
• Utility Classes: Provide reusable helper methods like waits, screenshots, logging, and common WebDriver actions.
• Tests: Contain test cases using page objects and utilities.
• Configuration: Manage environment settings, browser types, and credentials.

Configuration Patterns

• Properties Files: Store environment URLs, browser names, timeouts.
• Config Classes: Load properties and provide access methods.
• Environment Profiles: Use different property files for dev, test, prod.
• Browser Setup: Utility class reads config and initializes correct WebDriver.
• Credentials: Store securely outside code (e.g., encrypted files or environment variables).

Test Reporting and CI/CD Integration

• TestNG Reports: Use built-in TestNG HTML reports for test results.
• Logging: Utility classes handle logging for debugging and traceability.
• Screenshot Utility: Capture screenshots on test failure for reports.
• CI/CD: Integrate with Jenkins or GitHub Actions to run tests automatically on code changes.
• Report Aggregation: Use plugins like Allure or ExtentReports for enhanced reports.

Best Practices for Utility Classes

1. Single Responsibility: Each utility class should have one clear purpose (e.g., WaitUtils only handles waits).
2. Reusability: Write generic methods that can be used across different tests and pages.
3. Static Methods: Use static methods for stateless utilities to avoid unnecessary object creation.
4. Exception Handling: Handle exceptions inside utilities to keep test code clean.
5. Documentation: Comment utility methods clearly to explain their use.

Self Check

Where in this folder structure would you add a new utility class for handling explicit waits?

Key Result

Utility classes provide reusable helper methods to keep test code clean and maintainable.

Practice

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

easy

A. To define test case steps in detail

B. To store test data in variables

C. To create WebDriver instances for each test

D. To provide reusable static methods for common tasks

Solution

1. Step 1: Understand utility class role

   Utility classes contain static methods to reuse code easily across tests.

2. Step 2: Compare options with utility class purpose

   Only To provide reusable static methods for common tasks describes reusable static methods, which is the utility class purpose.

3. Final Answer:

   To provide reusable static methods for common tasks -> Option D

4. Quick Check:

   Utility class = reusable static methods [OK]

Hint: Utility classes hold static helpers for reuse [OK]

Common Mistakes:

• Confusing utility class with test data storage
• Thinking utility class creates WebDriver instances
• Mixing utility class with test step definitions

2. Which of the following is the correct way to declare a utility method in Java?

easy

A. public static void openBrowser() {}

B. public void openBrowser() {}

C. void openBrowser() {}

D. static openBrowser() {}

Solution

1. Step 1: Recall utility method syntax

   Utility methods are static so they can be called without creating an object.

2. Step 2: Check each option's syntax

   public static void openBrowser() {} correctly declares a public static method with return type void.

3. Final Answer:

   public static void openBrowser() {} -> Option A

4. Quick Check:

   Utility method = public static method [OK]

Hint: Utility methods must be static for easy access [OK]

Common Mistakes:

• Omitting static keyword
• Missing return type
• Incorrect method declaration syntax

3. Given this utility method:

public static String getPageTitle(WebDriver driver) {
    return driver.getTitle();
}

What will be the output if the current page title is "Home Page"?

medium

A. Compilation error

B. null

C. "Home Page"

D. driver.getTitle()

Solution

1. Step 1: Understand method behavior

   The method returns the page title by calling driver.getTitle().

2. Step 2: Check given page title

   The page title is "Home Page", so the method returns this string.

3. Final Answer:

   "Home Page" -> Option C

4. Quick Check:

   Method returns page title string [OK]

Hint: Method returns driver.getTitle() string [OK]

Common Mistakes:

• Confusing method return with method name
• Expecting null instead of actual title
• Assuming syntax error without checking code

4. Identify the error in this utility class method:

public static void clickElement(WebElement element) {
    element.click;
}

medium

A. Missing parentheses after click method

B. WebElement cannot be passed as parameter

C. Method should return boolean

D. Static keyword is not allowed here

Solution

1. Step 1: Check method syntax

   The method calls element.click but misses parentheses, which is invalid syntax.

2. Step 2: Validate other options

   Passing WebElement is valid, return type void is fine, static allowed in utility methods.

3. Final Answer:

   Missing parentheses after click method -> Option A

4. Quick Check:

   Method call needs () after method name [OK]

Hint: Method calls need parentheses () [OK]

Common Mistakes:

• Forgetting parentheses on method calls
• Thinking WebElement can't be parameter
• Assuming static keyword causes error

5. You want to create a utility class method that waits for an element to be visible before clicking it. Which approach is best?

hard

A. Add wait logic inside each test instead of utility method

B. Create a static method that uses WebDriverWait and then clicks the element

C. Create a non-static method that clicks element immediately without wait

D. Use Thread.sleep() inside utility method before clicking

Solution

1. Step 1: Understand utility method purpose

   Utility methods should provide reusable, clean code for common tasks like waiting and clicking.

2. Step 2: Evaluate options for best practice

   Create a static method that uses WebDriverWait and then clicks the element uses static method with WebDriverWait, which is efficient and reusable. Others are less reliable or not reusable.

3. Final Answer:

   Create a static method that uses WebDriverWait and then clicks the element -> Option B

4. Quick Check:

   Use static method with explicit wait [OK]

Hint: Use static method with WebDriverWait for reliable clicks [OK]

Common Mistakes:

• Using Thread.sleep() causing slow tests
• Not using static method for utility
• Putting wait logic inside tests, not utility