Configuration management in Selenium Java - Framework Patterns

Framework Mode - Configuration management

Folder Structure

  selenium-java-project/
  ├── src/
  │   ├── main/
  │   │   └── java/
  │   │       └── com/example/app/
  │   │           └── pages/           # Page Object classes
  │   └── test/
  │       └── java/
  │           └── com/example/tests/  # Test classes
  ├── config/
  │   ├── config.properties            # Environment and browser settings
  │   └── credentials.properties       # Secure credentials storage
  ├── utils/
  │   └── ConfigManager.java           # Configuration loader utility
  ├── testng.xml                      # TestNG suite configuration
  └── pom.xml                         # Maven build and dependency management
  

Test Framework Layers

• Configuration Layer: Reads environment, browser, and credentials from property files using ConfigManager utility.
• Page Object Layer: Contains page classes representing UI elements and actions.
• Test Layer: Contains test classes that use page objects and configuration to run tests.
• Utility Layer: Helper classes like ConfigManager to load and provide config data.
• Build & Test Runner: Maven and TestNG manage dependencies and test execution.

Configuration Patterns

• Property Files: Use config.properties for environment URLs, browser types, timeouts.
• Credentials File: Store usernames and passwords separately in credentials.properties (avoid hardcoding).
• ConfigManager Utility: Java class to load properties once and provide getters for config values.
• Profiles: Use Maven profiles or system properties to switch environments (e.g., dev, test, prod).
• Browser Selection: Read browser type from config to initialize correct WebDriver.

Test Reporting and CI/CD Integration

• TestNG Reports: Built-in HTML reports generated after test runs.
• Logging: Use logging frameworks (e.g., Log4j) to capture config loading and test execution details.
• CI/CD Integration: Use Jenkins or GitHub Actions to run tests with different config profiles automatically.
• Environment Variables: Override config properties in CI pipelines for flexibility.

Best Practices for Configuration Management

• Keep configuration separate from code to allow easy changes without recompiling.
• Use property files for simple key-value pairs and avoid hardcoding sensitive data.
• Use a dedicated utility class to load and cache configuration values for efficiency.
• Support multiple environments by using profiles or environment-specific config files.
• Secure credentials by storing them separately and avoid committing them to version control.

Self Check

Where in this folder structure would you add a new property for a timeout setting used by all tests?

Key Result

Separate configuration files and a utility class manage environment, browser, and credentials settings cleanly and securely.