Report publishing in CI in Selenium Java

Introduction

We publish test reports in Continuous Integration (CI) to see test results easily after every code change. It helps teams quickly find and fix problems.

After running automated Selenium tests in a CI pipeline like Jenkins or GitHub Actions.

When you want to share test results with your team automatically.

To keep a history of test runs and track test stability over time.

When you want to generate HTML or XML reports for better readability.

To fail the build if tests do not pass, ensuring code quality.

Syntax

Selenium Java

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

public class TestReportPublisher {
    @Test
    public void sampleTest() {
        // Your Selenium test code here
        Assertions.assertTrue(true);
    }

    @AfterAll
    public static void publishReport() {
        // Code to publish or archive test reports in CI
        // Usually handled by CI tool configuration
    }
}

Test report publishing is often configured in the CI tool, not fully in code.

Use test frameworks like JUnit or TestNG that generate reports automatically.

Examples

Maven Surefire plugin creates XML reports after tests run. CI tools read these reports to show results.

Selenium Java

/* Example: JUnit test with Maven Surefire plugin generates reports automatically */
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

public class SimpleTest {
    @Test
    public void testExample() {
        Assertions.assertEquals(5, 2 + 3);
    }
}

This Jenkinsfile runs tests and publishes JUnit XML reports so Jenkins shows test results in its UI.

Selenium Java

/* Jenkins pipeline snippet to publish JUnit reports */
pipeline {
    stages {
        stage('Test') {
            steps {
                sh 'mvn test'
                junit 'target/surefire-reports/*.xml'
            }
        }
    }
}

This uploads test reports as artifacts in GitHub Actions for later download and review.

Selenium Java

/* GitHub Actions step to publish test reports */
- name: Run tests
  run: mvn test

- name: Publish test report
  uses: actions/upload-artifact@v3
  with:
    name: test-report
    path: target/surefire-reports/

Sample Program

This simple JUnit test shows a passing test. The message after all tests reminds that report publishing is handled by CI tools.

Selenium Java

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

public class ReportPublishingTest {

    @Test
    public void simpleTest() {
        Assertions.assertTrue(3 > 1);
    }

    @AfterAll
    public static void publishReport() {
        // In real CI, reports are published by CI tool, not code
        System.out.println("Test completed. Reports are generated by the test framework and published by CI.");
    }
}

Important Notes

CI tools like Jenkins, GitHub Actions, or GitLab CI handle report publishing using plugins or built-in steps.

Test frameworks generate reports in formats like XML or HTML automatically during test runs.

Common mistake: expecting code to publish reports directly instead of configuring the CI tool properly.

Summary

Publishing test reports in CI helps teams see test results quickly after code changes.

Test frameworks generate reports; CI tools publish and display them.

Configure your CI pipeline to collect and show these reports for best results.

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