Is there a decent HTML Junit report plugin for Maven?

Question

I find the surefire-report plug-in very unsuitable to my working style. I clean the project all the time and I don't want to spend 5 min to rebuild the whole site every time I want to look at the test report in my browser.

If I type mvn surefire-report:report-only, the generated report is too ugly and barely readable.

What I'm looking for is something like ant's JUnitReport task. Is there one available out there already?

Solution 1

Indeed, generating the whole site at each build is clearly not an option. But the problem is that mvn surefire-report:report-only doesn't create the the css/*.css files, hence the ugly result. This is logged in SUREFIRE-616 (doesn't mean something will happen though). Personally, I don't use HTML reports that much so I can live with that but that's not a good answer so here is a workaround based on the ant task (*sigh*):

  <plugin>
    <artifactId>maven-antrun-plugin</artifactId>
    <executions>
      <execution>
        <id>test-reports</id>
        <phase>test</phase>
        <configuration>
          <tasks>
            <junitreport todir="target/surefire-reports">
              <fileset dir="target/surefire-reports">
                <include name="**/*.xml"/>
              </fileset>
              <report format="noframes" todir="target/surefire-reports"/>
            </junitreport>
          </tasks>
        </configuration>
        <goals>
          <goal>run</goal>
        </goals>
      </execution>
    </executions>
    <dependencies>
      <dependency>
        <groupId>ant</groupId>
        <artifactId>ant-junit</artifactId>
        <version>1.6.2</version>
      </dependency>
    </dependencies>
  </plugin>

Update: My initial idea was to run the Maven AntRun plugin "on demand" to generate the reports... but that's not what I posted, I bound it to the test phase... But I didn't think about the case of failed tests (that would stop the build and prevent the execution of the AntRun plugin). So, either:

1. Don't bind the AntRun plugin to the test phase, move the configuration outside the execution and call mvn antrun:run on the command line to generate the reports when wanted.

2. or use the testFailureIgnore option of the test mojo and set it to true in the surefire plugin configuration:

   <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-surefire-plugin</artifactId>
     <configuration>
       <testFailureIgnore>true</testFailureIgnore>
     </configuration>
   </plugin>
   

3. or set this expression from the command line using the -D parameter:

   $ mvn test -Dmaven.test.failure.ignore=true
   

I think that Option #1 is the best option, you don't necessarily want to generate the reports (especially when the test passes) and generate them systematically may slow down the build on the long term. I'd generate them "on demand".

Solution 2

This is what I do:

# Run tests and generate .xml reports
mvn test

# Convert .xml reports into .html report, but without the CSS or images
mvn surefire-report:report-only

# Put the CSS and images where they need to be without the rest of the
# time-consuming stuff
mvn site -DgenerateReports=false

go to target/site/surefire-report.html for the report.

After tests run, the rest of the two run in about 3.5 seconds for me.

Hope that helps. Enjoy!

Solution 3

Create a new maven run configuration and with goal =>

surefire-report:report site -DgenerateReports=false

This can help you to have a better report view with css.

Solution 4

Thanks for Pascal, I've found an improved solution to do what I want to do:

<plugin>
    <!-- Extended Maven antrun plugin -->
    <!-- https://maven-antrun-extended-plugin.dev.java.net/ -->
    <groupId>org.jvnet.maven-antrun-extended-plugin</groupId>
    <artifactId>maven-antrun-extended-plugin</artifactId>
    <executions>
      <execution>
        <id>test-reports</id>
        <phase>test</phase>
        <configuration>
          <tasks>
            <junitreport todir="target/surefire-reports">
              <fileset dir="target/surefire-reports">
                <include name="**/*.xml"/>
              </fileset>
              <report format="noframes" todir="target/surefire-reports"/>
            </junitreport>
          </tasks>
        </configuration>
        <goals>
          <goal>run</goal>
        </goals>
      </execution>
    </executions>
    <dependencies>
      <dependency>
        <groupId>org.apache.ant</groupId>
        <artifactId>ant-junit</artifactId>
        <version>1.8.0</version>
      </dependency>
      <dependency>
        <groupId>org.apache.ant</groupId>
        <artifactId>ant-trax</artifactId>
        <version>1.8.0</version>
      </dependency>
    </dependencies>
  </plugin>

This version uses a newer version of ant and best of all. However, I still haven't found a way to generate a test report when tests fail. How should I do that?

Solution 5

You can set -Dmaven.test.failure.ignore=true to generate the test report when tests fail.

View more solutions

Comments

[Y.H Wong]

Does it open a subprocess or just runs ant embedded? If this just embeds ant and it's task, this is exactly what I need.

[Devanshu Mevada]

@jimmy It runs the ant task in the same process.

[Y.H Wong]

Thanks this is exactly what I need to know!

[masT]

Did you get the way to generate report after test failure.?

[Tinman]

Take a look at the maven.apache.org/surefire/maven-failsafe-plugin. Build to the 'verify' phase, and it will fail at that point, after the report has been generated.

[Jugi]

is it possible to change the html report name ? all the html reports are generated with the name as "junit-noframes".

[vikramvi]

This should have been accepted as easiest way to achieve results and the answer.

[royki]

@PascalThivent Hello, Following this configuration of ANT in MAVEN, Surefire report is generating duplicate tests in the html report. How can I avoid that ?

[royki]

Hello, Following this configuration of ANT in MAVEN, Surefire report is generating duplicate tests in the html report. How can I avoid that ?

[Julio Villane]

wich version are you using? because with the 2.22.0 the css and images files are missing when you run that command

[seanf]

Thanks! For failsafe: mvn surefire-report:failsafe-report-only site -DgenerateReports=false