https://github.com/bischoffdev/sandboy

Maven plugin for beautiful and clean reports for Surefire and Failsafe XML files.
https://github.com/bischoffdev/sandboy

failsafe junit maven-plugin reporting-tool surefire

Last synced: 6 months ago
JSON representation

Maven plugin for beautiful and clean reports for Surefire and Failsafe XML files.

• Host: GitHub
• URL: https://github.com/bischoffdev/sandboy
• Owner: bischoffdev
• Created: 2022-03-08T10:15:21.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-09T09:57:06.000Z (over 2 years ago)
• Last Synced: 2025-07-20T08:59:21.900Z (6 months ago)
• Topics: failsafe, junit, maven-plugin, reporting-tool, surefire
• Language: Java
• Homepage:
• Size: 729 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/benjamin-bischoff/)

[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

[![Maven Central](https://img.shields.io/maven-central/v/blog.softwaretester/sandboy-maven.svg)](https://repo1.maven.org/maven2/blog/softwaretester/sandboy-maven/)

![logo.png](doc/logo.png)

# 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](https://maven.apache.org/surefire/maven-surefire-plugin/)

and [Maven Failsafe](https://maven.apache.org/surefire/maven-failsafe-plugin/) when running unit or integration tests.

- [Sandboy Surefire Reporting](#sandboy-surefire-reporting)

- [Changelog](#changelog)

- [Maven usage](#maven-usage)

    - [Plugin dependency](#plugin-dependency)

    - [Report generation](#report-generation)

        - [surefireSourcePath](#surefiresourcepath)

        - [generatedReportPath](#generatedreportpath)

- [Sample Report](#sample-report)

Usually, these reports are generated by the [Maven Site Plugin](https://maven.apache.org/plugins/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](https://github.com/trivago/cluecumber).

# Changelog

All changes can be seen in the linked [changelog](CHANGELOG.md).

## 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:

```xml

    

        

            blog.softwaretester

            sandboy-maven

            ${project.version}

            

                

                    Generate_Report

                    none

                    

                        report

                    

                

            

            

                ${project.basedir}/surefire/real.xml

                ${project.build.directory}/sandboy-report

            

        

    

```

### 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 `` 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

![report.png](doc/report.png)