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.

Practice

1. What is the main purpose of publishing test reports in a Continuous Integration (CI) pipeline?

easy

A. To increase the speed of test execution

B. To automatically fix failed tests

C. To reduce the number of test cases

D. To quickly show test results after code changes

Solution

1. Step 1: Understand CI pipeline goals

   CI pipelines aim to integrate code changes frequently and provide feedback quickly.

2. Step 2: Role of test reports in CI

   Publishing test reports helps teams see if tests passed or failed right after changes.

3. Final Answer:

   To quickly show test results after code changes -> Option D

4. Quick Check:

   Test reports in CI = Quick feedback [OK]

Hint: Test reports in CI = fast feedback on code changes [OK]

Common Mistakes:

• Confusing report publishing with speeding up tests
• Thinking reports reduce test cases
• Believing reports fix tests automatically

2. Which of the following is the correct way to configure a Jenkins pipeline to publish JUnit test reports generated by Selenium Java tests?

easy

A. Use the junit '**/target/surefire-reports/*.xml' step in the pipeline script

B. Add publishJUnitReports() in the Java test code

C. Call driver.publishReports() in Selenium test methods

D. Use archiveArtifacts('**/*.html') to publish XML reports

Solution

1. Step 1: Identify Jenkins syntax for JUnit reports

   Jenkins uses the junit step with a file pattern to locate XML reports.

2. Step 2: Match correct usage

   junit '**/target/surefire-reports/*.xml' correctly points to JUnit XML files generated by Maven Surefire plugin.

3. Final Answer:

   Use the junit '**/target/surefire-reports/*.xml' step in the pipeline script -> Option A

4. Quick Check:

   Jenkins pipeline uses junit step with XML path [OK]

Hint: Jenkins publishes JUnit XML with junit('path') step [OK]

Common Mistakes:

• Trying to publish reports from Java code directly
• Using wrong Jenkins steps for report publishing
• Archiving HTML instead of XML for JUnit reports

3. Given the following Jenkins pipeline snippet, what will be the result of the junit '**/target/surefire-reports/*.xml' step if no XML files are found?

pipeline {
  agent any
  stages {
    stage('Test') {
      steps {
        sh 'mvn test'
        junit '**/target/surefire-reports/*.xml'
      }
    }
  }
}

medium

A. The build will fail with an error about missing reports

B. The build will pass with no test results recorded

C. The build will retry the test stage automatically

D. The build will pass but mark tests as skipped

Solution

1. Step 1: Understand junit step behavior with missing files

   If no XML files match, Jenkins does not fail the build but records no test results.

2. Step 2: Confirm build status

   Since no test results are found, the build passes but shows zero tests executed.

3. Final Answer:

   The build will pass with no test results recorded -> Option B

4. Quick Check:

   No XML files = build passes, no tests recorded [OK]

Hint: No XML files found means no tests recorded, build still passes [OK]

Common Mistakes:

• Assuming build fails if reports missing
• Thinking tests are marked skipped automatically
• Expecting automatic retries on missing reports

4. You configured your CI pipeline to publish Selenium test reports, but the reports are not visible in the CI dashboard. Which of the following is the most likely cause?

medium

A. The CI server does not support publishing reports

B. The Selenium tests did not run any assertions

C. The test report files are generated in a different directory than specified in the CI config

D. The test code uses deprecated Selenium APIs

Solution

1. Step 1: Check report file paths in CI config

   If the CI pipeline looks for reports in the wrong folder, it won't find or display them.

2. Step 2: Verify report generation location

   Ensure test reports are generated where the CI expects them, matching the configured path.

3. Final Answer:

   The test report files are generated in a different directory than specified in the CI config -> Option C

4. Quick Check:

   Report path mismatch = no reports shown [OK]

Hint: Check report file paths match between test and CI config [OK]

Common Mistakes:

• Blaming test assertions for missing reports
• Assuming CI server cannot publish reports
• Thinking deprecated APIs affect report visibility

5. You want to publish Selenium Java test reports in a CI pipeline that uses GitHub Actions. Which combination of steps correctly collects and publishes the test results?

hard

A. Run tests with Maven, then use actions/upload-artifact to save reports, and configure actions/junit-report to display them

B. Run tests with Maven, then use actions/download-artifact to save reports, and actions/junit-report to display them

C. Run tests with Maven, then use actions/upload-artifact to save reports, and actions/upload-test-report to display them

D. Run tests with Maven, then use actions/upload-artifact to save reports, and no further steps are needed to display reports

Solution

1. Step 1: Save test reports as artifacts

   Use actions/upload-artifact to store test report files after running tests.

2. Step 2: Use a report action to display results

   Configure actions/junit-report or similar to parse and show test results in GitHub UI.

3. Final Answer:

   Run tests with Maven, then use actions/upload-artifact to save reports, and configure actions/junit-report to display them -> Option A

4. Quick Check:

   Upload artifact + report action = published test results [OK]

Hint: Upload reports artifact then use report action to display [OK]

Common Mistakes:

• Using upload-test-report action which does not exist
• Downloading artifacts instead of uploading
• Skipping report display step after upload