Getting Jacoco to work with Dagger

January 16, 2015

Writing tests for your code provides you with a number of development benefits, from proving that your code meets set requirements to ensuring that future code changes don’t introduce bugs or break existing functionality. It’s also important to know how much of your code is covered by your tests and what areas in your code aren’t yet covered.

Jacoco is a framework that creates code coverage reports that show you how much of your code has or has not been touched in your tests. This post is an excellent guide to setting up your Android Gradle project to use Jacoco.

To generate the Jacoco test coverage report, execute the following in the commandline:

./gradlew cleanTest test jacocoTestReport

If you’re using Dagger in your Android Gradle project, you might encounter the following error:

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:jacocoTestReport'.
> Error while creating report

To dig deeper into this error, execute the same command with the stacktrace option:

./gradlew cleanTest test jacocoTestReport --stacktrace

In the stack trace, you’ll see an entry similar to this:

Caused by: java.io.FileNotFoundException: /app/build/intermediates/classes/debug/com/yourproject/AndroidModule$ModuleAdapter$ProvideAccountManagerProvidesAdapter.class (No such file or directory)
	at org.apache.tools.ant.types.resources.FileResource.getInputStream(FileResource.java:217)
	at org.jacoco.ant.ReportTask.createBundle(ReportTask.java:568)
	at org.jacoco.ant.ReportTask.createReport(ReportTask.java:547)
	at org.jacoco.ant.ReportTask.execute(ReportTask.java:494)
	... 67 more

Jacoco is expecting to find generated files with a single “$” in their name, but Dagger generates files with “$$” in their name. However, we don’t need to check test coverage in these generated classes, so we can tell Jacoco to ignore these files by adding the following to the “excludes” array (in addition to any existing entries) in the fileTree passed to “classDirectories”, like so:

classDirectories = fileTree(
 dir: '../app/build/intermediates/classes/debug',
 excludes: [
 '**/*InjectAdapter*.*',
 '**/*StaticInjection*.*',
 '**/*ModuleAdapter*.*'
 ]
 )
Joseph Kreiser
Joseph Kreiser
Software Developer

Looking for more like this?

Sign up for our monthly newsletter to receive helpful articles, case studies, and stories from our team.

Make Your Website Shine Through Shareable Meta tags
Development Web

Make Your Website Shine Through Shareable Meta tags

June 20, 2023

Improve the web site preview used by chat apps, websites, and social media with these easy tips.

Read more
Information Experience can make or break a product
Design Process

Information Experience can make or break a product

January 4, 2023

Kai discusses how writing impacts user experience, providing an overview of the types of writing that are involved in product development and how to approach it from a very high level.

Read more
Making your Android project modular with convention plugins
Android Development

Making your Android project modular with convention plugins

May 22, 2024

Explore the journey of Gradle and build tools like it, particularly in the context of Android development. You'll learn the necessity of separating code into modules as projects grow and how Gradle convention plugins can streamline this process.

Read more
View more articles