Clover-for-Grails Quick Start Guide
Generating Clover Reports
Install the Clover-for-Grails plugin
Install the Clover-for-Grails plugin by running the following Grails command in the root of your Grails project directory.
grails install-plugin clover
The 'grails install-plugin' command has been removed in Grails 2.3.5 upwards. In such case we recommend adding the Clover plugin to your project's BuildConfig.groovy or pom.xml. For more installation options, please see Clover-for-Grails Installation Guide.
Generating a basic Clover coverage report
To generate a basic Clover code coverage report, you need to add the Clover option
-clover.on to the
grails test-app command line target for running unit tests against your Grails project.
grails test-app -clover.on -clover.view
Adding the Clover option
-clover.view to this Grails command makes the report open in a browser window immediately after generation. If you omit this command line option, Clover will generate a report that you can then open manually.
Passing the location of your
clover.license file to the
grails command line
If you have not placed your
clover.license file within your Grails project or user home directory (as indicated in the Installation Guide), you can pass the license file's location to the
grails command line by adding the Clover option
grails test-app -clover.on -clover.license.path=/path/to/clover.license
On Windows platform you must put the entire "-clover.license.path=c:\path\to\clover.license" in double quotes (it's a Grails "feature" which tries to evaluate a non-quoted value to boolean instead of string).
If you find that Clover-for-Grails runs out of memory, try increasing the Grails PermGen allocation by either setting the JAVA_OPTS environment variable:
Alternatively, you can define this variable in the
startGrails (Linux/UNIX/Mac OS X) or
startGrails.bat (Windows) script in the
<Grails Home Directory>/bin directory.