Sandboy Surefire Reporting

Clear and concise Surefire reporting!

Sandboy is a very clear and concise alternative report generator for Surefire XML files. These are generated by Maven Surefire and Maven Failsafe when running unit or integration tests.

• Sandboy Surefire Reporting
• Changelog
• Maven usage
  • Plugin dependency
  • Report generation
    • surefireSourcePath
    • generatedReportPath
• Sample Report

Usually, these reports are generated by the Maven Site Plugin but the resulting reports are usually ugly and not very clear.

This project was inspired by my Cluecumber reporting project for Cucumber JSON.

Changelog

All changes can be seen in the linked changelog.

Maven usage

For now, Sandboy comes as a Maven plugin. In the future, it might also be implemented as a CLI utility or other flavors.

Plugin dependency

You can add this plugin dependency to your Maven project's build section like so:

<build>
    <plugins>
        <plugin>
            <groupId>blog.softwaretester</groupId>
            <artifactId>sandboy-maven</artifactId>
            <version>${project.version}</version>
            <executions>
                <execution>
                    <id>Generate_Report</id>
                    <phase>none</phase>
                    <goals>
                        <goal>report</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <surefireSourcePath>${project.basedir}/surefire/real.xml</surefireSourcePath>
                <generatedReportPath>${project.build.directory}/sandboy-report</generatedReportPath>
            </configuration>
        </plugin>
    </plugins>
</build>

Report generation

Report generation can be triggered by mvn sandboy:report.

Note: It is important not to call mvn clean sandboy:report if the Surefire XML files are inside the target directory - otherwise these would be wiped by the clean command!

You only need to provide two parameters (as seen in the <configuration> section above): surefireSourcePath and generatedReportPath.

surefireSourcePath

This parameter specifies the location of the Surefire XML files. It can be a directory or the path to one specific Surefire XML file.

In case of a directory, Sandboy will only process Surefire XML files and skip all others.

generatedReportPath

This is the path to store the generated report in.

Sample Report