- Maven utilizes Ant
- to provide users with an easy-to-use and familiar interface to
- manage projects that have been described with a valid Maven project descriptor.
- The build files that Maven
- installs are stored in ${maven.home} directory.
-
- This document describes the Ant build file and targets - that are available when using the Clover Plug-in with Maven. -
-
- The current recommended approach to using Maven is to add
- delegators to these Maven-provided targets in your project's
- main build file. This will enable you to use your existing
- build file with the additional Maven functionality. In
- addition, it is also recommended that you load a standard set of
- property files. The property files will setup your environment,
- ${lib.repo} and ${maven.home}, and
- allow you to override Maven defaults properties. Please refer
- to the Integration document for
- more information on how to integrate these build targets into
- your project.
-
- The following table contains a brief overview of the
- build file that is installed as part of the Maven Clover Plug-in in the
- ${maven.home}/plugin/clover directory. In addition,
- the various Ant targets in this file is discussed.
-
| Build File | Description |
|---|---|
| build.xml | -- Contains targets to generate Clover test coverage reports. - | -
- The build file utilizes various properties for default and - user-configurable settings. All Clover Plug-in properties are described - in the Properties document. - - The rest of this document assumes your project follows the standard - Directory Layout; however, it is - possible to override many of these defaults. -
-| Target | Description |
|---|---|
| maven:clover-test | -Runs unit tests on Clover-instrumented code and generates - coverage data. | -
| maven:clover-report-html | -Generates HTML Clover Test coverage reports. | -
| maven:clover-report-swing | -Run Clover Test coverage reports with the Swing viewer | -
- This target instruments your code, runs your unit tests on it - and generates a Clover database file. This target must be called - prior to calling one of the report targets below. -
-
- Note : There is a limitation in Clover 0.5b. The
- test coverage results are written to Clover database on JVM shutdown
- only. Thus be careful to execute the maven:clover-test
- target separately from the maven:clover-report-* ones
- or the report will show a 0% coverage result! In other words, do not
- type "ant maven:clover-test maven:clover-report-*".
- Instead, do it in 2 JVM invocations :
- "ant maven:clover-tests" and
- "ant maven:clover-report-*".
-
- Prior to running this target you should have called the
- maven:clover-test one which generates a test
- result database file. This target generates an HTML report
- from that database file. The report shows exactly what lines of
- your code were exercised by your tests.
-
- Prior to running this target you should have called the
- maven:clover-test one which generates a test
- result database file. This target runs a Swing viewer
- displaying the content of that database file.
-
- Having a common directory layout would allow for users familiar - with one Maven project to immediately feel at home in another - Maven project. The advantages are analogous to adopting a - site-wide look-and-feel. Common Maven procedures strengthen the - Maven brand. -
-- The next two sections document the directory layout expected by - Maven and the directory layout created by Maven. Please try to - conform to this structure as much as possible; however, if you - must these settings can be overridden via properties as - documented in the Integration document. -
-| Directory name | -Content | -Comment | -
|---|---|---|
| target/clover | -Contains instrumented code and clover database. | -- This directory is used by the Clover Plug-in as a placeholder for - the instrumented code and also as the location of the Clover - database. - | -
| target/docs/clover | -Contains generated Clover reports. | -- Clover generates its HTML reports in this directory. - | -
- The following is a list of things that are being contemplated - for the Maven Clover Plug-in. -
-
+ The typical way to use the Clover plugin is by registering a Clover
+ report in your project.xml:
+
clover:report goal.
+ maven.clover.report.[report name]
+ properties. Before generating a
+ report, the goal recompiles the source code with Clover and reruns
+ the unit tests. The generated reports show exactly what lines of
+ your code were exercised by your tests.
+ - This document provides an overview of the Maven Clover Plug-in. + The Clover Plug-in is the place where + Clover tools are found + in Maven.
- The documents presented here are references, if you are looking - for more verbose usage material, please refer to the Getting Started section. + Clover is a tool that generates Test Coverage reports. It is free for + non-commercial use. If your project is a commercial project you will + need to get a license for the Clover jar before using this plugin.
-- The Clover Plug-in is the place where Clover tools are found - in Maven. -
-- Clover is a tool that generates Test Coverage reports. It is free for - non-commercial use. If your project is a commercial project you will - need to get a license for the Clover jar before using this Plug-in. -
-| Document | Description |
|---|---|
| Build File | -- This document provides detailed information on the various - targets that are available as part of the Maven Clover Plug-in. - These targets can be delegated to by your project's local - build file. - | -
| Properties | -- The behavior of the Maven Clover Plug-in can be altered via - properties. This document describes each property - available as the default used. - | -
| Directory Layout | -- The preferred directory layout structure is documented - here. This is a useful document if you are trying to - determine what a particular component of your directory - hierarchy is used for. - | -
| Futures | -- These are the current thoughts on additional items - that could or should be added to the plug-in. - They may or may not make it to an actual task list of a - developer. - | -
- The following is an overview of the various properties (and - default values) used by the Maven Clover Plug-in build file. Most of these - properties are optional and have defaults; however, there are - mandatory properties that must be set as described in this document. -
-- These properties can be overridden to change the default behavior of - the Maven Clover Plug-in. If you need to override any of these - properties, please refer to the - Integration - document for the preferred method of setting properties in your project. -
+| Section | Description | |||
|---|---|---|---|---|
| Property | Optional? | Description | Default | |
| Misc | +maven.clover.orderBy | +Yes |
- These properties specify various settings that control the
- behaviour of the Clover Plug-in.
+ Specifies how the reports must be sorted:
+
|
+
+ PcCoveredAsc
|
| Property | Optional? | Description | ||||
|---|---|---|---|---|---|---|
| maven.clover.database.dir | -No | +maven.clover.report.html | +Yes |
- Specifies the location of the Clover database. The default value is
- ${maven.build.dir}/clover/database.
+ Decides whether an HTML report will be generated.
|
-
+ true
+ |
+
|
| maven.clover.orderBy | -No | -
- Specifies the type of report to generate:
-
|
+ maven.clover.report.xml | +Yes | ++ Decides whether an XML report will be generated. + | +
+ false
+ |
+
| maven.clover.report.swing | +Yes | ++ Decides whether a Swing report will be generated. + | +
+ false
+ |
+ |||
| maven.clover.database.dir | +Yes | ++ Specifies the location of the Clover database. + | +
+ ${maven.build.clover}/database
+ |