Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>Starting with v1.8, Cobertura will create detailed reports for Groovy source.  It can be download from <a class="external-link" href="http://cobertura.sourceforge.net/download.html" rel="nofollow">http://cobertura.sourceforge.net/download.html</a><br />
Below is an example build file for using Cobertura in your project.</p>

<p>Notice that you must compile your groovy source into .class files so that Cobertura can add instrumentation to those .class files.</p>

<hr />
<p>build.xml</p>

<hr />
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;?xml version="1.0"?>
&lt;project name="sample" default="coverage-report" basedir=".">
  &lt;!-- properties for project directory structure -->
  &lt;property name="dir.src" value="."/>
  &lt;property name="dir.build" value="build"/>
  &lt;property name="dir.dist" value="dist"/>
  &lt;property name="dir.lib" value="lib"/>
  &lt;property name="dir.report" value="report"/>

&lt;!-- setup a project classpath that includes the external libs -->
  &lt;path id="project.classpath">
    &lt;!-- include the classes in this project -->
    &lt;pathelement location="${dir.build}"/>
    &lt;!-- include external libraries -->
    &lt;fileset dir="${dir.lib}" includes="**/*.jar"/>
  &lt;/path>

&lt;!-- add external tasks -->
  &lt;taskdef name="groovyc"  classpathref="project.classpath" classname="org.codehaus.groovy.ant.Groovyc"/>
  &lt;taskdef name="groovy" classpathref="project.classpath" classname="org.codehaus.groovy.ant.Groovy"/>

&lt;!-- create output directories -->
  &lt;target name="prepare" depends="clean">
    &lt;mkdir dir="${dir.build}"/>
  &lt;/target>

&lt;!-- clean -->
  &lt;target name="clean" description="Remove all generated files.">
    &lt;delete dir="${dir.build}"/>
    &lt;delete dir="${dir.report}"/>
    &lt;delete dir="target/instrumented-classes"/>
	&lt;delete file="cobertura.ser"/>
  &lt;/target>

&lt;!-- compile java (if you have any) and groovy source -->
  &lt;target name="runGroovyC" depends="prepare">
    &lt;groovyc srcdir="${dir.src}" destdir="${dir.build}" stacktrace="true">
      &lt;classpath refid="project.classpath"/>
		&lt;javac debug="on" />
    &lt;/groovyc>

&lt;/target>

&lt;!--============================================-->
  &lt;!-- Cobertura Test Coverage Tool -->
  &lt;!--============================================-->
  &lt;path id="cobertura.classpath">
    &lt;fileset dir="${dir.lib}/cobertura" includes="**/*.jar"/>
    &lt;pathelement location="target/instrumented-classes"/>
    &lt;pathelement location="${dir.src}"/>
  &lt;/path>

&lt;taskdef classpath="${dir.lib}/cobertura/cobertura.jar" resource="tasks.properties"
    classpathref="cobertura.classpath"/>

&lt;!-- adds the logging code to the already compiled class files -->
  &lt;target name="instrument" depends="runGroovyC">
    &lt;delete quiet="false" failonerror="false">
      &lt;fileset dir="target/instrumented-classes" includes="**/*.class"/>
    &lt;/delete>
    &lt;cobertura-instrument todir="target/instrumented-classes">
      &lt;fileset dir="${dir.build}">
          &lt;include name="**/*.class"/>
          &lt;exclude name="**/*Test.class"/>
      &lt;/fileset>
    &lt;/cobertura-instrument>
  &lt;/target>

&lt;!-- setup class path to include instrumented classes before non-instrumented ones -->
  &lt;path id="cover-test.classpath">
    &lt;fileset dir="${dir.lib}" includes="**/*.jar"/>
    &lt;pathelement location="target/instrumented-classes"/>
    &lt;pathelement location="${dir.build}"/>
  &lt;/path>

&lt;!-- run all my junit tests using the instrumented classes -->
  &lt;target name="cover-test" depends="instrument">
    &lt;mkdir dir="${dir.report}/cobertura" />
    &lt;junit printsummary="yes" haltonerror="no" haltonfailure="no" fork="yes">
      &lt;formatter type="plain" usefile="true"/>
      &lt;batchtest>
        &lt;fileset dir="${dir.build}" includes="**/*Test.class" />
      &lt;/batchtest>
      &lt;classpath refid="cover-test.classpath"/>
    &lt;/junit>
  &lt;/target>

&lt;!-- create the html reports -->
  &lt;target name="coverage-report" depends="cover-test">
    &lt;cobertura-report srcdir="${dir.src}" destdir="${dir.report}"/>
  &lt;/target>
&lt;/project>
</pre></td></tr></table>

<p>See also: <a class="confluence-link" href="/display/GROOVY/Test+Coverage" data-linked-resource-id="59167" data-linked-resource-type="page" data-linked-resource-default-alias="Test Coverage" data-base-url="http://docs.codehaus.org">Test Coverage</a></p>