Logging test steps in Selenium Java - Framework Patterns

Framework Mode - Logging test steps

Folder Structure

src/
└── test/
    └── java/
        └── com/
            └── example/
                ├── pages/
                │   └── LoginPage.java
                ├── tests/
                │   └── LoginTest.java
                ├── utils/
                │   └── LoggerUtil.java
                └── config/
                    └── TestConfig.java

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown (e.g., WebDriverFactory).
• Page Objects: Classes representing UI pages with methods to interact with elements.
• Tests: Test classes containing test methods using page objects and assertions.
• Utilities: Helper classes like LoggerUtil to log test steps clearly.
• Configuration: Holds environment settings, browser types, and credentials.

Configuration Patterns

• Use TestConfig.java to store environment URLs, browser types, and credentials as constants or load from .properties files.
• Use system properties or Maven profiles to switch environments (e.g., dev, staging, prod).
• Configure logging level and output file location in LoggerUtil or log4j2.xml for flexible logging.

Test Reporting and CI/CD Integration

• Integrate logging with test reports (e.g., TestNG reports) to show detailed test steps.
• Use logging frameworks like Log4j2 or SLF4J for structured logs.
• Configure CI/CD pipelines (Jenkins, GitHub Actions) to run tests and collect logs and reports automatically.
• Store logs as artifacts for debugging failed tests.

Best Practices for Logging Test Steps

1. Log meaningful messages before and after important actions (e.g., clicking a button, entering text).
2. Use a centralized logging utility to keep logging consistent across tests.
3. Include timestamps and log levels (INFO, ERROR) for clarity.
4. Avoid logging sensitive information like passwords.
5. Keep logs readable and concise to help debugging without noise.

Self Check

Where in this folder structure would you add a new utility class to log test steps for a new feature?

Key Result

Use a centralized logging utility in the utils layer to log clear, meaningful test steps for better debugging and reporting.