Skip to main content

Java code coverage using cobertura

Code coverage is important as it gives developers confidence in the code that they are checking in. And for a startup automated test and measuring code coverage is equally important to be able to Ship early and be nimble.  I recently automated unit testing in jenkins and wanted to measure how much code coverage we have. So I integrated cobertura in the build framework. Cobertura is a build time instrumentation plugin so the steps are:

1) compile the code
2) Instrument the classes to generate instrumented classes with cobertura hooks.
3) modify junit class path to put instrumented classes before real classes
4) add a system property in junit ant task, so that cobertura knows where to write its statistics.
5) generate a coverage report in html to be used by developers
6) generate a coverage report in xml so that it can be published to sonar so we can do trends on code coverage release after release.

Here is how a typical code coverage report looks like http://cobertura.sourceforge.net/sample/



Here are some more details on the steps:

    <target name="instrument" description="Run Tests">
        <delete file="${basedir}/cobertura.ser" />
        <delete dir="${basedir}/build/instrumented-classes" />
        <cobertura-instrument todir="${basedir}/build/instrumented-classes">
            <ignore regex="org.apache.log4j.*" />
            <fileset dir="${basedir}/build/classes">
                <include name="**/*.class" />
                <exclude name="**/*Test.class" />
            </fileset>
        </cobertura-instrument>
    </target>


        <junit tempdir="${basedir}/build" printsummary="on"
               fork="yes"
               forkmode="perBatch"
               haltonfailure="true"
               failureproperty="tests.failed"
               showoutput="false">
            <jvmarg value="-Djava.awt.headless=true"/>
              <jvmarg value="-Djava.io.tmpdir=${basedir}/build/jenkinstest"/>
            <jvmarg value="-Dnet.sourceforge.cobertura.datafile=${basedir}/cobertura.ser" />           
            <classpath location="build/instrumented-classes" />
            <classpath refid="${testClasspathRefId}"/>
            <classpath refid="cobertura.classpath" />
            <formatter type="plain" usefile="false"/>
            <batchtest todir="${basedir}/${testReportsDir}">
                <fileset dir="${basedir}/${build}/classes">
                    <include name="**/*${testClassPattern}.*"/>
                    <exclude name="**/*$*.*"/>
                </fileset>
                <formatter type="xml"/>           
            </batchtest>
        </junit>


    <target name="coverage">
        <delete file="build/cobertura.ser" quiet="true" />
        <delete dir="build/coverage"  quiet="true"/>

        <cobertura-merge datafile= "build/cobertura.ser">
            <fileset dir="${basedir}/">
              <include name="**/cobertura.ser"/>
            </fileset>
        </cobertura-merge>   
        <cobertura-report format="html" destdir="build/coverage" datafile= "build/cobertura.ser">
            <fileset dir="${basedir}" includes="**/*.java"/>
        </cobertura-report>   
        <cobertura-report format="xml" destdir="build/coverage" datafile= "build/cobertura.ser">
            <fileset dir="${basedir}" includes="**/*.java"/>
        </cobertura-report>
        <cobertura-check haltonfailure="false" />
    </target>


Comments

Post a Comment

Popular posts from this blog

RabbitMQ java clients for beginners

Here is a sample of a consumer and producer example for RabbitMQ. The steps are Download Erlang Download Rabbit MQ Server Download Rabbit MQ Java client jars Compile and run the below two class and you are done. This sample create a Durable Exchange, Queue and a Message. You will have to start the consumer first before you start the for the first time. For more information on AMQP, Exchanges, Queues, read this excellent tutorial http://blogs.digitar.com/jjww/2009/01/rabbits-and-warrens/ +++++++++++++++++RabbitMQProducer.java+++++++++++++++++++++++++++ import com.rabbitmq.client.Connection; import com.rabbitmq.client.Channel; import com.rabbitmq.client.*; public class RabbitMQProducer { public static void main(String []args) throws Exception { ConnectionFactory factory = new ConnectionFactory(); factory.setUsername("guest"); factory.setPassword("guest"); factory.setVirtualHost("/"); factory.setHost("127.0.0.1"); factory.se...
23 comments
Read more

Spring 3.2 quartz 2.1 Jobs added with no trigger must be durable.

I am trying to enable HA on nodes and in that process I found that in a two test node setup a job that has a frequency of 10 sec was running into deadlock. So I tried upgrading from Quartz 1.8 to 2.1 by following the migration guide but I ran into an exception that says "Jobs added with no trigger must be durable.". After looking into spring and Quartz code I figured out that now Quartz is more strict and earlier the scheduler.addJob had a replace parameter which if passed to true would skip the durable check, in latest quartz this is fixed but spring hasnt caught up to this. So what do you do, well I jsut inherited the factory and set durability to true and use that public class DurableJobDetailFactoryBean extends JobDetailFactoryBean {     public DurableJobDetailFactoryBean() {         setDurability(true);     } } and used this instead of JobDetailFactoryBean in the spring bean definition     <bean i...
7 comments
Read more

Killing a particular Tomcat thread

Update: This JSP does not work on a thread that is inside some native code.  On many occasions I had a thread stuck in JNI code and it wont work. Also in some cases thread.stop can cause jvm to hang. According to javadocs " This method is inherently unsafe. Stopping a thread with Thread.stop causes it to unlock all of the monitors that it has locked". I have used it only in some rare occasions where I wanted to avoid a system shutdown and in some cases we ended up doing system shutdown as jvm was hung so I had a 70-80% success with it.   -------------------------------------------------------------------------------------------------------------------------- We had an interesting requirement. A tomcat thread that was spawned from an ExecutorService ThreadPool had gone Rogue and was causing lots of disk churning issues. We cant bring down the production server as that would involve downtime. Killing this thread was harmless but how to kill i...
6 comments
Read more