XML and HTML reports in JUnit - Build an Automation Script

Generate and verify JUnit XML and HTML test reports

Preconditions (2)

Step 1: Create a simple JUnit test class with one passing and one failing test method

Step 2: Run the tests using Maven or Gradle command

Step 3: Locate the generated XML report file in the target/surefire-reports directory

Step 4: Open the XML report and verify it contains test results with correct test names and statuses

Step 5: Generate an HTML report using a reporting plugin or tool (e.g., Maven Surefire Report Plugin)

Step 6: Open the HTML report in a browser

Step 7: Verify the HTML report shows the test results summary with passed and failed tests clearly indicated

✅ Expected Result: JUnit XML report file is created with correct test results; HTML report displays a clear summary of test outcomes including passed and failed tests

Automation Requirements - JUnit 5 with Maven Surefire Plugin

Assertions Needed:

Verify test methods pass or fail as expected

Verify XML report file exists after test run

Verify XML report content includes test names and statuses

Verify HTML report file exists after report generation

Verify HTML report content includes summary of test results

Best Practices:

Use descriptive test method names

Use Maven Surefire Plugin for consistent report generation

Use assertions to validate test outcomes

Check file existence and parse XML report for validation

Keep reports in standard directories for easy access

Automated Solution

JUnit

package com.example;

import static org.junit.jupiter.api.Assertions.*;

import org.junit.jupiter.api.Test;

public class SampleTest {

    @Test
    void testThatPasses() {
        assertTrue(5 > 1, "5 is greater than 1");
    }

    @Test
    void testThatFails() {
        assertEquals(2, 1 + 1, "1 + 1 should equal 2");
        fail("Intentional failure for demonstration");
    }
}

/*
To run and generate reports:
1. Run tests with Maven:
   mvn clean test

2. XML reports will be in target/surefire-reports/*.xml

3. To generate HTML report, add to pom.xml:

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-report-plugin</artifactId>
      <version>3.0.0-M7</version>
      <executions>
        <execution>
          <phase>verify</phase>
          <goals>
            <goal>report</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

4. Run:
   mvn verify

5. HTML report will be in target/site/surefire-report.html

6. Open the HTML report in a browser to see test summary.
*/

This JUnit 5 test class has two test methods: one that passes and one that fails intentionally.

Running mvn clean test executes the tests and generates XML reports in the target/surefire-reports directory.

The Maven Surefire Report Plugin is configured to generate an HTML report during the verify phase, which you run with mvn verify. The HTML report is saved in target/site/surefire-report.html.

Opening the HTML report in a browser shows a clear summary of passed and failed tests, making it easy to understand test results.

This setup follows best practices by using descriptive test names, standard Maven directories, and built-in plugins for report generation.

Common Mistakes - 4 Pitfalls

Not configuring the Maven Surefire Plugin to generate reports

Using vague or non-descriptive test method names

Ignoring the location of generated reports

Not verifying the content of XML or HTML reports

Bonus Challenge

Now add data-driven testing with 3 different input values and verify reports reflect all test cases

Show Hint

Practice

1. What is the main purpose of XML reports in JUnit testing?

easy

A. To store test results in a structured format for tools to read

B. To display test results directly in a web browser

C. To run tests faster by using XML files

D. To write test cases in XML syntax

Solution

1. Step 1: Understand XML report role

   XML reports save test results in a structured way that other tools can process.

2. Step 2: Compare with other options

   HTML reports display results in browsers, not XML. XML does not speed tests or write test cases.

3. Final Answer:

   To store test results in a structured format for tools to read -> Option A

4. Quick Check:

   XML reports = structured data storage [OK]

Hint: XML = structured data for tools, not direct display [OK]

Common Mistakes:

• Confusing XML reports with HTML display
• Thinking XML speeds up test execution
• Assuming tests are written in XML

2. Which Maven command generates both XML and HTML reports for JUnit tests?

easy

A. mvn test -DreportFormat=xml,html

B. mvn generate-reports

C. mvn surefire-report:report

D. mvn clean install

Solution

1. Step 1: Identify Maven reporting plugin

   The Surefire Report plugin generates XML and HTML reports after tests run.

2. Step 2: Check other commands

   "mvn clean install" runs build and tests but does not generate reports alone. Others are invalid commands.

3. Final Answer:

   mvn surefire-report:report -> Option C

4. Quick Check:

   Surefire report plugin = XML + HTML reports [OK]

Hint: Surefire plugin command generates reports, not just test run [OK]

Common Mistakes:

• Using 'mvn clean install' expecting reports
• Trying invalid Maven commands
• Confusing report generation with test execution

3. Given this snippet from a JUnit XML report:

<testcase classname="CalculatorTest" name="testAdd" time="0.005"/>

What does the attribute time="0.005" represent?

medium

A. The time in seconds the test took to run

B. The timeout limit for the test

C. The number of assertions in the test

D. The priority level of the test

Solution

1. Step 1: Understand XML attribute 'time'

   The 'time' attribute records how long the test took to execute, in seconds.

2. Step 2: Eliminate other meanings

   Timeout is set elsewhere, assertions count is not stored here, and priority is unrelated.

3. Final Answer:

   The time in seconds the test took to run -> Option A

4. Quick Check:

   time attribute = execution duration [OK]

Hint: time attribute always means test duration in seconds [OK]

Common Mistakes:

• Confusing time with timeout limit
• Thinking time counts assertions
• Assuming time is test priority

4. You run JUnit tests with Maven but the HTML report is missing. Which is the most likely cause?

medium

A. The tests did not run due to compilation errors

B. The Surefire plugin is not configured to generate reports

C. The XML report file is corrupted

D. The HTML report is generated only for failed tests

Solution

1. Step 1: Check report generation setup

   If Surefire plugin is not configured properly, no reports are created.

2. Step 2: Analyze other options

   Compilation errors stop tests but usually show errors; corrupted XML won't prevent HTML generation if configured; HTML reports show all tests, not just failures.

3. Final Answer:

   The Surefire plugin is not configured to generate reports -> Option B

4. Quick Check:

   Missing HTML report = plugin config issue [OK]

Hint: Check Surefire plugin config if reports are missing [OK]

Common Mistakes:

• Assuming HTML reports only for failed tests
• Ignoring plugin configuration
• Blaming XML corruption without evidence

5. You want to customize the JUnit HTML report to include test categories and better styling. Which approach is best?

hard

A. Edit the XML report files directly before viewing

B. Use a different testing framework that supports HTML styling

C. Change the test method names to include categories

D. Modify the XSLT files used to transform XML to HTML

Solution

1. Step 1: Understand report generation process

   JUnit XML reports are transformed to HTML using XSLT stylesheets, which control layout and content.

2. Step 2: Evaluate customization options

   Editing XML directly is impractical; changing test names is limited; switching frameworks is unnecessary if customization is possible.

3. Final Answer:

   Modify the XSLT files used to transform XML to HTML -> Option D

4. Quick Check:

   Customize HTML via XSLT transformation [OK]

Hint: Edit XSLT to customize HTML report content and style [OK]

Common Mistakes:

• Trying to edit XML reports directly
• Relying on test names for report styling
• Switching frameworks unnecessarily