{"id":420,"date":"2006-03-30T17:12:21","date_gmt":"2006-03-30T16:12:21","guid":{"rendered":"http:\/\/thekua.com\/rant\/?p=420"},"modified":"2006-03-31T09:46:06","modified_gmt":"2006-03-31T08:46:06","slug":"ask-emma-if-you-are-covered","status":"publish","type":"post","link":"https:\/\/thekua.com\/rant\/2006\/03\/ask-emma-if-you-are-covered\/","title":{"rendered":"Ask EMMA If You Are Covered"},"content":{"rendered":"

Code coverage is a useful tool for helping you work out how well you are testing your code. On most projects I have been on, I have found Clover to be the most well known and most popular but there are other alternatives, and this one in particular I am going to demonstrate how to use it.<\/p>\n

On our current project, I used EMMA<\/a>, an open source code coverage tool, to monitor how well we were testing various aspects of the code base. Results highlighted areas that were not test driven or areas that the team had neglected to deal with at the time (such as certain exception handling). This library is not specifically design to work only with JUnit, so I thought it might be useful to show you how we use it in our normal build that does use JUnit. <\/p>\n

Steps to generate code coverage using EMMA<\/strong><\/p>\n

    \n
  1. Compile your classes<\/li>\n
  2. Instrument your classes<\/li>\n
  3. Execute your tests<\/li>\n
  4. Generate the report<\/li>\n<\/ol>\n

    Compile Your Classes<\/strong>
    \nWith EMMA there is no change to the way that you can compile your classes as it allows you to instrument them post-compilation.<\/p>\n

    Instrument Your Classes<\/strong>
    \nThe distribution comes with a class that you can run against a set of classes that automatically generates the instrumented classes as shown below:<\/p>\n

    java \u00e2\u20ac\u201ccp emma.jar emma instr \u00e2\u20ac\u201cm overwrite \u00e2\u20ac\u201ccp build\/classes<\/code><\/p><\/blockquote>\n

    where:
    \n[emma<\/code>] Is the executable java class for easily running all the features from this library.
    \n[instr<\/code>] Is the command for executing the instrumentation that weaves in all the monitoring features for generate code coverage information.
    \n[-m overwrite<\/code>] Is the output mode and states to overwrite the original classes. You can also output a copy if you want but you will have to specify the output directory using the \u00e2\u20ac\u201cd\/-dir\/-outputdir option
    \n[-cp build\/classes<\/code>] tells EMMA where it should be looking for the files to instrument.<\/p>\n

    Execute Your Tests<\/strong>
    \nAfter instrumenting your classes with the features that monitor code coverage, you only need to run your tests as normal, only ensuring that you include the EMMA’s library jar in the classpath.<\/p>\n

    After running your tests you will see two output files including coverage.em<\/code> and coverage.ec<\/code> that are both used as inputs into the report.<\/p>\n

    Generate The Report<\/strong>
    \nWe will reuse the same executable class for generating the report as below:<\/p>\n

    java \u00e2\u20ac\u201ccp emma.jar emma report \u00e2\u20ac\u201cr html \u00e2\u20ac\u201cin ..\/coverage.em,..\/coverage.ec -sp ..\/src<\/code><\/p><\/blockquote>\n

    where:
    \n[emma<\/code>] Is the executable java class for easily running all the features from this library.
    \n[report<\/code>] tells emma that you want to generate a report from the coverage readings
    \n[-r html<\/code>] tells what format the report should be in
    \n[\u00e2\u20ac\u201cin ..\/coverage.em,..\/coverage.ec<\/code>] tells emma where to find the code coverage data
    \n[-sp ..\/src<\/code>] links the java source files to the results so that you can get some nice graphical reports.<\/p>\n

    Your should end up with a HTML report that outputs something like the following:<\/p>\n

    \n\"Summary<\/a>
    \nSummary Report
    \n    \"Code<\/a>
    \nAn example output file with source attached\n<\/div>\n

    Ant Build Integration<\/strong>
    \nYou can use     this build file<\/a> (substituting appropriate values) if you want to get up and running quickly. It assumes:<\/p>\n