Clover-for-Grails Installation Guide

Still need help?

The Atlassian Community is here for you.

Ask the community

This page provides instructions for all available Clover-for-Grails plug-in installation options.

Clover License for Clover-for-Grails

We recommend purchasing Clover Server license for Grails-based projects.

A reason is that in order to see coverage results for a project built and tested from a command line, an HTML report must be generated (and report generation is not available in the Clover Desktop edition).



The documentation below assumes that you have already installed Grails and have configured your PATH environment variable to point to the bin directory of your Grails installation.

Installing Clover-for-Grails

There are several ways to install Clover-for-Grails:

  • Declaring dependency in BuildConfig.groovy
  • Declaring dependency in pom.xml
  • Using the 'install-plugin' command
    • installing from the grails central repository
    • installing from the given web address
    • installing from the downloaded installation file

Installing the Clover license

Clover requires a license file in order to run. Once you have installed the Clover-for-Grails plugin, you will need to download and install the Clover license file clover.license. You can generate a 30-day evaluation Clover license file by logging in to and following the instructions on the site. After 30 days, you need to purchase a commercial Clover license file from this site to continue running Clover. Refer to the instructions below for installing your Clover license file.

Upgrading Clover-for-Grails

Upgrading the Clover-for-Grails plugin is also very easy, as indicated here.

Installation of Clover for Grails plug-in

Using the BuildConfig.groovy

Edit your grails-app/conf/BuildConfig.groovy file and add a section like below:

grails.project.dependency.resolution = {
    plugins {
        compile "org.grails.plugins:clover:4.0.0"
    // For Grails 2.2 and later you have to add a dependency to a Clover core:
    dependencies { 
        compile "com.atlassian.clover:clover:4.0.0"  // com.cenqua.clover:clover for 3.x.x
    // or use a legacy dependency resolution mechanism:
    // legacyResolve true

Using the pom.xml

Grails 2.1 has introduced new dependency management based on Maven's pom.xml instead of BuildConfig.groovy file. In order to use this, declare "pom true" in BuildConfig.groovy:

grails.project.dependency.resolution = {
    pom true

and add dependencies to org.grails.plugins:clover (and com.atlassian.clover:clover) in pom.xml:

<!-- For *Grails 2.2* or later you must also add a dependency to the Clover Core -->
    <groupId>com.atlassian.clover</groupId> <!-- com.cenqua.clover for Clover 3.x -->


Using the 'install-plugin' command

grails install-plugin clover 4.0.0


(warning) The 'install-plugin' command has been deprecated in Grails 2.1. It's recommended to use BuildConfig.groovy or pom.xml.

(warning) If you're using Grails 1.3.7 and earlier, you might need to add a following entry to your list of repositories.

grailsRepo ""
mavenRepo ""

(warning) If you experience problems using this method, try installing the plugin directly from its web address:

grails install-plugin

Where x, y and z (optional) refer to the latest version of the Clover-for-Grails plugin to be installed.


It's also possible to install it from a downloaded file:

grails install-plugin /path/to/

Due to the nature of Grails' plugin installation architecture, you will need to install the Clover-for-Grails plugin into each Grails project whose source code you wish to test with Clover.



Installing the Clover license file

Once you have obtained your 30 day evaluation or commercial clover.license file, you need to install it so that your Clover-for-Grails plugin can acknowledge its existence.

You have the following options for installing the Clover license file clover.license:

Move or copy the clover.license file into this location:

Notes about this option:

The root directory of your Grails project.

  • For e.g. <Grails Installation Directory>/samples/petclinic

This option installs the Clover license file to this Grails project only. You will need to install this file into each of your other Grails projects with the Grails-for-Clover plugin too.

The etc directory within your Grails project.

  • For e.g. <Grails Installation Directory>/samples/petclinic/etc

This is similar to the previous option but 'hides' the clover.license file from the root directory of your Grails project.

Your user home directory.

  • Linux/UNIX/Mac OS X:
    • e.g. /home/alice/ or ~
  • Windows:
    • e.g. C:\Users\Alice

This will prevent you having to install the Clover license file into every Grails project on your computer as the license file will apply to every Grails project developed on your computer and login account.

You can also place the clover.license anywhere else that's accessible to the Clover-for-Grails plugin and reference it from either:


Related Topics


Last modified on Nov 12, 2014

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.