Cobertura and EMMA plugins both really are designed to work with unit tests. So we have to work around the limitation.
- First we need to instrument the classes.
- Second we need to jar up the instrumented classes and have them used by the build later.
- Need to tell the Integration Tests to use the instrumented classes for it’s dependencies.
- Generate an XML report of the results.
I tried doing this without falling back to ant, but everytime I tried to use the maven-site-plugin and configure it to generate the reports, it would complain that cobertura:check wasn’t configured correctly. In our case I didn’t need check to run, I just needed the reports generated. So Ant and AntContrib to the rescue. The following is the complete maven profile I came up with:
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | <profile> <id>cobertura</id> <dependencies> <dependency> <groupId>net.sourceforge.cobertura</groupId> <artifactId>cobertura</artifactId> <optional>true</optional> <version>1.9.4.1</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <configuration> <instrumentation> <excludes> <exclude>org/ebayopensource/turmeric/test/**/*.class</exclude> <exclude>org/ebayopensource/turmeric/common/v1/**/*.class</exclude> </excludes> </instrumentation> </configuration> <executions> <execution> <id>cobertura-instrument</id> <phase>process-classes</phase> <goals> <goal>instrument</goal> </goals> </execution> </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <executions> <execution> <id>cobertura-jar</id> <phase>post-integration-test</phase> <goals> <goal>jar</goal> </goals> <configuration> <classifier>cobertura</classifier> <classesDirectory>${basedir}/target/generated-classes/cobertura</classesDirectory> </configuration> </execution> </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.3.1</version> <executions> <execution> <id>cobertura-install</id> <phase>install</phase> <goals> <goal>install</goal> </goals> <configuration> <classifier>cobertura</classifier> </configuration> </execution> </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-antrun-plugin</artifactId> <executions> <execution> <phase>verify</phase> <configuration> <tasks> <taskdef classpathref='maven.runtime.classpath' resource='tasks.properties' /> <taskdef classpathref='maven.runtime.classpath' resource='net/sf/antcontrib/antcontrib.properties' /> <available file='${project.build.directory}/cobertura/cobertura.ser' property='ser.file.exists' /> <if> <equals arg1='${ser.file.exists}' arg2='true' /> <then> <echo message='Executing cobertura report' /> <mkdir dir='${project.build.directory}/site/cobertura' /> <cobertura-report format='xml' destdir='${project.build.directory}/site/cobertura' datafile='${project.build.directory}/cobertura/cobertura.ser' /> </then> <else> <echo message='No SER file found.' /> </else> </if> </tasks> </configuration> <goals> <goal>run</goal> </goals> </execution> </executions> <dependencies> <dependency> <groupId>ant-contrib</groupId> <artifactId>ant-contrib</artifactId> <version>20020829</version> </dependency> </dependencies> </plugin> </plugins> </build> </profile> |
Note: Do not use the cobertura:cobertura goal with this profile. It will fail the build because it will try to instrument the classes twice.
The use of Ant and AntContrib was a necessity because there is no cobertura:report goal, as it expects to run during the site generation phase. However, this causes the check goal to run as well, and we didn’t need that. So maybe, I’ll work up a patch to add a reporting goal just to run the report without having to run the site goal as well. Hopefully, this helps some people, as I lost much hair working this out.
Happy coding and don’t forget to share!
Reference: Enable Code Coverage for Integration and Unit Tests using Cobertura and Maven from our JCG partner David Carver at the Intellectual Cramps blog.
