Report publishing in CI in Selenium Java - Framework Patterns

Framework Mode - Report publishing in CI

Folder Structure of Selenium Java Test Framework

src/
 └── test/
      └── java/
           ├── pages/           # Page Object classes
           ├── tests/           # Test classes
           ├── utils/           # Utility classes (e.g., WebDriverFactory, WaitHelpers)
           └── config/          # Configuration classes (e.g., TestConfig.java)

resources/
 ├── testdata/                # Test data files (CSV, JSON)
 └── config.properties        # Environment and browser settings

reports/                      # Generated test reports

pom.xml                      # Maven build file

.gitlab-ci.yml or Jenkinsfile # CI pipeline configuration

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown, browser selection, and driver options.
• Page Objects: Encapsulate UI elements and actions for each page, promoting reusability and maintainability.
• Tests: Test classes using TestNG or JUnit that call page objects and assert expected behavior.
• Utilities: Helper classes for waits, logging, data reading, and WebDriver factory methods.
• Configuration: Centralized management of environment URLs, browser types, credentials, and other settings.

Configuration Patterns

• Properties File: Use config.properties to store environment URLs, browser names, and credentials.
• Environment Profiles: Use Maven profiles or system properties to switch between environments (e.g., dev, staging, prod).
• Browser Selection: Pass browser type as a system property or environment variable to run tests on different browsers.
• Secure Credentials: Store sensitive data encrypted or use environment variables injected by CI tools.
• Example: mvn test -Dbrowser=chrome -Denvironment=staging to run tests on Chrome in staging environment.

Test Reporting and CI/CD Integration

• TestNG Reports: Generate HTML and XML reports automatically after test execution.
• Allure Reports: Integrate Allure for rich, interactive test reports with screenshots and logs.
• Report Storage: Configure CI pipelines to archive and publish reports as build artifacts.
• CI Pipeline: Use Jenkins, GitLab CI, or GitHub Actions to run tests on code commits or pull requests.
• Notification: Configure email or Slack notifications with test results and report links.
• Example Jenkinsfile snippet:

  stage('Test') {
    steps {
      sh 'mvn clean test'
    }
    post {
      always {
        junit 'target/surefire-reports/*.xml'
        allure includeProperties: false, jdk: '', results: [[path: 'target/allure-results']]
      }
    }
  }

Best Practices for Report Publishing in CI

1. Automate Report Generation: Ensure reports are generated automatically after every test run without manual steps.
2. Use Standard Formats: Use widely supported report formats like JUnit XML and Allure for compatibility with CI tools.
3. Archive Reports: Save reports as build artifacts in CI to allow historical access and debugging.
4. Integrate Notifications: Send test results and report links to team communication channels to keep everyone informed.
5. Keep Reports Lightweight: Avoid embedding large files; use screenshots and logs selectively to keep reports fast to load.

Self Check Question

Where in this folder structure would you add a new configuration file to define a new test environment URL?

Key Result

Organize Selenium Java tests with clear layers and automate report publishing in CI for visibility.