Clover-for-Grails Installation and Upgrade Guide

This page provides instructions for all available Clover-for-Grails plugin installation and upgrade 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; in Desktop edition coverage can be browsed using Eclipse/IntelliJ IDE, however it might be less convenient).

Overview

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 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 https://my.atlassian.com 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.

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

Upgrading Clover-for-Grails

Upgrading the Clover-for-Grails plugin is also very easy, as indicated in the procedure below.

Installing Clover-for-Grails by declaring dependency in BuildConfig.groovy

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

grails.project.dependency.resolution = {
    plugins {
        compile ":clover:3.1.11"
    }
}

If you're using Grails 2.2 or newer, you have to either

a) enable legacy dependency resolution mechanism:

grails.project.dependency.resolution = {
    legacyResolve true  // use pre-grails 2.2 dependency resolution based on plugin's BuildConfig
    plugins {
        compile ":clover:3.1.11"
    }
}

b) or add dependency to Clover core jar:

grails.project.dependency.resolution = {
    dependencies { 
        compile "com.cenqua.clover:clover:3.1.11" // Clover core JAR
    }
    plugins {
        compile ":clover:3.1.11"
    }
}

Installing Clover-for-Grails by declaring dependency in 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 com.cenqua.clover:clover and org.grails.plugins:clover in pom.xml:

<dependency>
    <groupId>com.cenqua.clover</groupId>
    <artifactId>clover</artifactId>
    <version>3.1.11</version>
    <scope>compile</scope>
    <type>jar</type>
</dependency>
<dependency>
    <groupId>org.grails.plugins</groupId>
    <artifactId>clover</artifactId>
    <version>3.1.11</version>
    <scope>compile</scope>
    <type>zip</type>
</dependency>

Installing Clover-for-Grails by using the 'install-plugin' command

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

Installing from the Grails central repository

To install the Clover-for-Grails plugin using Grails' install-plugin command:

Change directory to the root of your Grails project directory. For example, if you installed the sample Grails project 'petclinic' that is bundled with Grails, you would change directory into <Grails Home Directory>/samples/petclinic
Run the command:
```
grails install-plugin clover
```
Grails will download the Clover-for-Grails plugin and install it into your Grails project.

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

grailsRepo "http://plugins.grails.org"

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

Installing from the given web address

To install Clover-for-Grails directly from its location on the web:

Change directory to the root of your Grails project. For example, if you installed the sample Grails project 'petclinic' that is bundled with Grails, you would change directory into <Grails Installation Directory>/samples/petclinic
Run the following command, which downloads the Clover-for-Grails plugin from the web address and install it into your Grails project:
```
grails install-plugin http://plugins.grails.org/grails-clover/tags/RELEASE_x_y_z/grails-clover-x.y.z.zip
```
Where x, y and z (optional) refer to the latest version of the Clover-for-Grails plugin to be installed. To browse for a different version, just enter this URL up to .../tags/ and use your browser links to navigate to (and download) a different version.

You can also install Clover-for-Grails from its Subversion location on the web:

grails install-plugin https://svn.codehaus.org/grails-plugins/grails-clover/tags/RELEASE_x_y_z/grails-clover-x.y.z.zip

Installing from the downloaded plugin installation file

To download the Clover-for-Grails plugin installation file and install it:

Download the Clover-for-Grails plugin from this location:
```
http://plugins.grails.org/grails-clover/tags/RELEASE_x_y_z/grails-clover-x.y.z.zip
```
Where x, y and z (optional) refer to the latest version of the Clover-for-Grails plugin to be installed. To browse for a different version, just enter this URL up to .../tags/ and use your browser links to navigate to (and download) a different version.

Save the file to a location that can be accessed from your Grails project.
Change directory to the root of your Grails project.
Run the command to install the downloaded Clover-for-Grails installation file:
```
grails install-plugin /path/to/grails-clover-x.y.zip
```
Grails will install the downloaded Clover-for-Grails installation file into your Grails project.

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

Upgrading the Clover-for-Grails plugin

Upgrading the Clover-for-Grails plugin is easy. All you need to do is to 're-install' the Clover-for-Grails plugin by following one of the three methods above. During the installation process, Grails will prompt you with a message similar to the following:

You currently already have a version of the plugin installed [clover-x.y]. 
Do you want to upgrade this version? (y, n)

Type 'y', then press enter, then Grails will remove the old version of the Clover-for-Grails plugin and replace it with the newer version.

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:

The Grails command line
The BuildConfig.groovy file.

Upgrading Grails

Using with an older version of Grails that Clover does not support?

Clover-for-Grails only supports the version of Grails indicated on the Supported Platforms page. Hence, if your Grails project has been developed using an older version of Grails, you will need to:

Download and install a newer version of Grails that Clover supports.
Update your PATH environment variable to point to the bin directory of the newly installed version of Grails.
Change directory to the root of your Grails project directory.
Run the command:
```
grails upgrade
```
This upgrades your Grails project to the new version of Grails that you just installed.

All Versions

Clover 3.1 Documentation

Child pages