martes, julio 17, 2012

JaCoCo in Maven Multi-Module Projects

Can you blow my whistle baby, whistle baby, Let me know Girl I'm gonna show you how to do it And we start real slow You just put your lips together. (Whistle - Flo Rida)
Code coverage is an important measure used during our development that describes the degree to which source code is tested.

In this post I am going to explain how to run code coverage using Maven and JaCoCo plugin in multi-module projects.

JaCoCo is a code coverage library for Java, which has been created by the EclEmma team. It has a plugin for Eclipse, and can be run with Ant and Maven too.

Now we will focus only in Maven approach.

In a project with only one module is as easy as registering a build plugin:

And now running mvn package, in site/jacoco directory, a coverage report will be present in different formats.

But with multimodule projects a new problem arises. How to merge metrics of all subprojects into only one file, so we can have a quick overview of all subprojects? For now Maven JaCoCo Plugin does not support it.

There are many alternatives and I am going to cite the most common:

  • Sonar. It has the disadvantage that you need to install Sonar (maybe you are already using, but maybe not).
  • Jenkins. Plugin for JaCoCo is still under development. Moreover you need to run a build job to inspect your coverage. This is good in terms of continuous integration but could be a problem if you are trying to "catch" some piece of code that has not covered with already implemented tests.
  • Arquillian JaCoCo Extension. Arquillian is a container test framework that has an extension which during test execution can capture the coverage. Also a good option if you are using Arquillian. The disadvantage is that maybe your project does not require a container.
  • Ant. You can use Ant task with Maven. JaCoCo Ant task can merge results from multiple JaCoCo files result. Note that is the most generic solution, and this is the chosen approach that we are going to use.
First thing to do is add JaCoCo plugin to parent pom so all projects could generate coverage report. Of course if there are modules which does not require coverage, plugin definition should be changed from parent pom to specific projects.

Next step is creating a specific submodule for appending all results of JaCoCo plugin by using Ant task. I suggest  using something like project-name-coverage.

Then let's open generated pom.xml and we are going to insert required plugins to join all coverage information. To append them, as we have already written we are going to use a JaCoCo Ant task which has the ability to open all JaCoCo output files and append all their content into one. So first thing to do is download the jar which contains the JaCoCo Ant task. To automatize download process, we are going to use maven dependency plugin:

During process-test-resources phase Jacoco Ant artifact will be downloaded and copied to target directory, so can be registered into pom without worrying about jar location.

We also need a way to handle Ant tasks from Maven. And this is as simple as using maven antrun plugin, which you can specify any ant command in its configuration section. See next simple example:

Notice that into target tag we can specify any Ant task. And now we are ready to start configuring JaCoCo Ant task. JaCoCo report plugin requires you set the location of build directory, class directory, source directory or generated-source directory. For this purpose we are going set them as properties.

And now the Ant task part which will go into target tag of antrun plugin.

First we need to define report task.

See that org.jacoco.ant.jar file is downloaded by dependency plugin, you don't need to worry about copying it manually.

Then we are going to call report task as defined in taskdef section.

Within executiondata element, we specify locations where JaCoCo execution data files are stored. By default is target directory, and for each project we need to add one entry for each submodule.

Next element is structure. This element defines the report structure, and can be defined with hierarchy of group elements. Each group  should contain class files and source files of all projects that belongs to that group. In our example only one group is used.

And finally we are setting output format using html, xml and csv tags.

Complete Code:

And now simply run mvn clean verify and in my-project-coverage/target/coverage-report, a report with code coverage of all projects will be presented.

Hope you find this post useful.

We Keep Learning,

Download Code

13 comentarios:

Mickael Istria dijo...

I suggested a solution to this issue here: Unfortunately, it did not get a lot of interest. Maybe you could add your thoughts on this issue, hoping it will encourage developers to look at it with the priority it deserves.

Unknown dijo...

Hi. Can you give more information on how the coverage module pom should look like? Or even batter if you can give a small project example. I'm a bit new to maven, and right now I get an error that ${jacoco.version} is undefined and also I do not understand how the whole pom should look like and whether I should create any other files other then pom

Unknown dijo...

Hi Yury have you tried the example provided in the post that you can download from the bottom? It should work. Also I use this approach in NoSQLUnit project you can take a look at poms there, if you have any problem, please do not hesitate to continue asking me.

Babu Bheemaraj dijo...

I tried the same thing with a multi-module project where there's a single .exec file obtained with integration testing of the application.

Also, i made a new maven project to collect instrumented jars for use with the report task. (just like you showed here)

However, the generated html report shows zero coverage for all classes.

Any hints /suggestions?

ati dijo...

Tried it and it works! Thank you for providing this example!

Dr. Lina dijo...

Jual obat aborsi cytotec
Jual obat aborsi bandung
Jual obat aborsi batam
Jual obat aborsi makassar

Jual obat aborsi malang
Jual obat aborsi palembang
Jual obat aborsi semarang

Jual obat aborsi jakarta
Jual obat aborsi bekasi

Jual obat aborsi surabaya ,Semarang, Jogja, yogyakarta,Malang, Surabaya, Jakarta, Bandung, Bekasi, Batam, Palembang dan Makassar.

Unknown dijo...

تستخدم شركة الاول افضل معدات تنظيف المنازل فيمكنك الاستعانة بنا لتحظى بافضل تنظيف للمنازل ولدينا فروع تغطى جميع المملكة فشركة الاول تعد افضل
شركة تنظيف بمكة
وافضل شركة تنظيف بالاحساء

افضل شركة تنظيف سجاد بالرياض

شركة صيانة مكيفات بالرياض

yanmaneee dijo...

michael kors purses
reebok outlet
cheap jordans
bape clothing
yeezy shoes
chrome hearts outlet
balenciaga trainers
christian louboutin outlet
nike air max

Assignment Help dijo...

You can connect with our team regarding any academic writing services at any hour of the day and we provide you the best and plagiarism free economics dissertation help assignment.
history dissertation help

tom554 dijo...

Hey, your blog is very informative. It is nice to read such high-quality content. Attractive information on your blog, thank you for taking the time and share with us. ABC assignment Essay help delivers high-quality content for all your subjects.

assignmentauthors dijo...

This figure is obtained after the comparison using this formula =MIN (B4:B24). freelance writer for hire

James Wick dijo...

Take Assignment help Ireland services to finish your work without any stress. If you have no one to ask your queries, use Assignment help services and get experts’ guidance for your concerns.
Assignment help Saudi Arabia
assignment help Hong Kong
assignment help Kuwait
assignment help United Arab Emirates

Assignment Help dijo...

Use Assignment Help services in Australia to get the services of professional academic writers easily. Enhance your chances of getting A+ grades in all project submission using online assignment writing services.