This plugin allows you to capture code coverage report from Cobertura. Hudson will generate the trend report of coverage.

Configuring the Cobertura Plugin

Install the cobertura plugin
Configure your project's build script to generate cobertura XML reports (See below for examples with Ant and Maven2)
Enable the "Publish Cobertura Coverage Report" publisher
Specify the directory where the coverage.xml report is generated.
(Optional) Configure the coverage metric targets to reflect your goals.

Configuring build tools

Here are the configuration details for common build tools. Please feel free to update this with corrections or additions.

Maven 2

Single Project

If you are using a single module configuration, add the following into your pom.xml

<project ...>
    ...
    <build>
        ...
        <plugins>
            ...
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>cobertura-maven-plugin</artifactId>
                <version>2.2</version> <!-- This version is needed to allow generating the xml reports AFAIK -->
                <configuration>
                    <formats>
                        <format>xml</format>
                        <!-- if you still want the HTML reports just add another format entry with html as the value -->
                    </formats>
                </configuration>
            </plugin>
            ...
        </plugins>
        ...
    </build>
    ...
</project>

Project hierarchie

If you are using a common parent for all Maven2 modules you can move the plugin configuration to the pluginManagement section of the common parent...

<project ...>
    ...
    <build>
        ...
        <pluginManagement>
            <plugins>
                ...
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>cobertura-maven-plugin</artifactId>
                    <version>2.2</version> <!-- This version is needed to allow generating the xml reports AFAIK -->
                    <configuration>
                        <formats>
                            <format>xml</format>
                            <!-- if you still want the HTML reports just add another format entry with html as the value -->
                        </formats>
                    </configuration>
                </plugin>
                ...
            </plugins>
        </pluginManagement>
        ...
    </build>
    ...
</project>

And add the plugin group and artifact to the children

<project ...>
    ...
    <build>
        ...
        <plugins>
            ...
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>cobertura-maven-plugin</artifactId>
            </plugin>
            ...
        </plugins>
        ...
    </build>
    ...
</project>

Ant

Note these instructions are untested as I use Maven2. If somebody can check and either fix them or remove this bolded text!
You must first tell Ant about the Cobertura Ant tasks using a taskdef statement. The best place to do this is near the top of your build.xml script, before any target statements.

<property name="cobertura.dir" value="C:/javastuff/cobertura" />

<path id="cobertura.classpath">
    <fileset dir="${cobertura.dir}">
        <include name="cobertura.jar" />
        <include name="lib/**/*.jar" />
    </fileset>
</path>

<taskdef classpathref="cobertura.classpath" resource="tasks.properties" />

You'll need to instrument the classes, e.g.

<cobertura-instrument todir="${instrumented.dir}">
    <ignore regex="org.apache.log4j.*" />
    <fileset dir="${classes.dir}">
        <include name="**/*.class" />
        <exclude name="**/*Test.class" />
    </fileset>
    <fileset dir="${guiclasses.dir}">
        <include name="**/*.class" />
        <exclude name="**/*Test.class" />
    </fileset>
    <fileset dir="${jars.dir}">
        <include name="my-simple-plugin.jar" />
    </fileset>
</cobertura-instrument>

Here's an example call to the JUnit ant task that has been modified to work with Cobertura.

<junit fork="yes" dir="${basedir}" failureProperty="test.failed">
	<!--
		Specify the name of the coverage data file to use.
		The value specified below is the default.
	-->
	<sysproperty key="net.sourceforge.cobertura.datafile"
		file="${basedir}/cobertura.ser" />

	<!--
		Note the classpath order: instrumented classes are before the
		original (uninstrumented) classes.  This is important.
	-->
	<classpath location="${instrumented.dir}" />
	<classpath location="${classes.dir}" />

	<!--
		The instrumented classes reference classes used by the
		Cobertura runtime, so Cobertura and its dependencies
		must be on your classpath.
	-->
	<classpath refid="cobertura.classpath" />

	<formatter type="xml" />
	<test name="${testcase}" todir="${reports.xml.dir}" if="testcase" />
	<batchtest todir="${reports.xml.dir}" unless="testcase">
		<fileset dir="${src.dir}">
			<include name="**/*Test.java" />
		</fileset>
	</batchtest>
</junit>

Finally, you need a task to generate the xml report:

<cobertura-report format="xml" destdir="${coveragereport.dir}" srcdir="${src.dir}" />

Version History

Upcoming Version

The plugin runs before notifications are sent out, to avoid inconsistency in build status reporting (issue #1285)

Version 0.8.4 (21/10/2007)

???

Version 0.8.3 (12/10/2007)

Fixes issue 915 for SubversionSCM only

Version 0.8.2 (4/10/2007)

Hopefully fixed issue 846

Version 0.8.1 (28/09/2007)

Fixes issues running under JDK 1.5
Fixes some issues with finding source code

Version 0.8 (20/09/2007)

Works with JDK 5 as well as JDK 6 (removing JDK dependency introduced during regression fixing)

Version 0.7 (20/09/2007)

Better fix of regressions introduced in 0.5

Version 0.6 (20/09/2007)

Fix of regressions introduced in 0.5

Version 0.5 (20/09/2007)

Now with built in source code painting! (Source code is available at the file level for the latest stable build only).

Note that the conditional coverage is the highest coverage from all the cobertura reports aggregated in each build. Thus if you have two reports and one covers only 50% of a conditional and the other covers a different 25%, conditional coverage will be reported as 50% and not the 75% that you could argue it should be!

The trend graph now works when there are broken builds in the build history.

Version 0.4 (29/08/2007)

Initial support for multi-report aggregation (may get totals incorrect if reports overlap for individual classes - I'll need to get source file painting support implemented to remove that issue. However, this is just how the files are parsed. This version will archive the files correctly so when it is fixed your history should report correctly)

Version 0.3 (28/08/2007)

Fixed NPE parsing some cobertura reports generated by Cobertura version 1.8.
Project level report should now work (except possibly when a build is in progress)

Version 0.2 (28/08/2007)

Fixed problem with configuration (was not persisting configuration details)

Changed health reporting configuration (now handles the more generic code)

Tidy-up of reports

Known issues:
- Project level report does not work in all cases
- Class and Method level reports should display source code with coverage if source code is available (in workspace)

Version 0.1 (27/08/2007)

Initial release. Only parses xml report. Some rough edges in the UI.

Add Labels
Enter labels to add to this page: Looking for a label? Just start typing.

Cobertura Plugin

Configuring the Cobertura Plugin

Configuring build tools

Maven 2

Single Project

Project hierarchie

Ant

Version History

Upcoming Version

Version 0.8.4 (21/10/2007)

Version 0.8.3 (12/10/2007)

Version 0.8.2 (4/10/2007)

Version 0.8.1 (28/09/2007)

Version 0.8 (20/09/2007)

Version 0.7 (20/09/2007)

Version 0.6 (20/09/2007)

Version 0.5 (20/09/2007)

Version 0.4 (29/08/2007)

Version 0.3 (28/08/2007)

Version 0.2 (28/08/2007)

Version 0.1 (27/08/2007)

Labels

Comments (29)

Anonymous says:

Stephen Connolly says:

Jessica-Aileen says:

Anonymous says:

Anonymous says:

Stephen Connolly says:

Stephen Connolly says:

Anonymous says:

Anonymous says:

Stephen Connolly says:

Anonymous says:

Stephen Connolly says:

Jessica-Aileen says:

Anonymous says:

Anonymous says:

Anonymous says:

Status Code: 500

Anonymous says:

Anonymous says:

Anonymous says:

Stephen Connolly says:

Mike Haller says:

Mike Caron says:

fabrice says:

Jose Muanis says:

fabrice says:

Jose Muanis says:

fabrice says:

truong van nga says:

Nicolas Ruffel says: