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

Popular posts from this blog

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 it, t

Adding Jitter to cache layer

Thundering herd is an issue common to webapp that rely on heavy caching where if lots of items expire at the same time due to a server restart or temporal event, then suddenly lots of calls will go to database at same time. This can even bring down the database in extreme cases. I wont go into much detail but the app need to do two things solve this issue. 1) Add consistent hashing to cache layer : This way when a memcache server is added/removed from the pool, entire cache is not invalidated.  We use memcahe from both python and Java layer and I still have to find a consistent caching solution that is portable across both languages. hash_ring and spymemcached both use different points for server so need to read/test more. 2) Add a jitter to cache or randomise the expiry time: We expire long term cache  records every 8 hours after that key was added and short term cache expiry is 2 hours. As our customers usually comes to work in morning and access the cloud file server it can happe

Preparing for an interview after being employed 11 years at a startup

I would say I didn't prepared a hell lot but  I did 2 hours in night every day and every weekend around 8 hours for 2-3 months. I did 20-30 leetcode medium problems from this list https://leetcode.com/explore/interview/card/top-interview-questions-medium/.  I watched the first 12 videos of Lecture Videos | Introduction to Algorithms | Electrical Engineering and Computer Science | MIT OpenCourseWare I did this course https://www.educative.io/courses/grokking-the-system-design-interview I researched on topics from https://www.educative.io/courses/java-multithreading-for-senior-engineering-interviews and leetcode had around 10 multithreading questions so I did those I watched some 10-20 videos from this channel https://www.youtube.com/channel/UCn1XnDWhsLS5URXTi5wtFTA