- Reworked documentation
- Prepare to release version 1.3 git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114422 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol
parent
b47bde6d6d
commit
ddd2d9516c
@ -5,7 +5,7 @@
|
||||
<pomVersion>3</pomVersion>
|
||||
<id>maven-clover-plugin</id>
|
||||
<name>Maven Clover Plug-in</name>
|
||||
<currentVersion>1.3-SNAPSHOT</currentVersion>
|
||||
<currentVersion>1.3</currentVersion>
|
||||
<description/>
|
||||
<shortDescription>Produce Clover reports</shortDescription>
|
||||
<url>http://maven.apache.org/reference/plugins/clover/</url>
|
||||
@ -24,7 +24,7 @@
|
||||
<version>
|
||||
<id>1.3</id>
|
||||
<name>1.3</name>
|
||||
<tag>HEAD</tag>
|
||||
<tag>MAVEN_CLOVER_1_3</tag>
|
||||
</version>
|
||||
</versions>
|
||||
<developers>
|
||||
@ -86,11 +86,21 @@
|
||||
</developers>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<id>clover</id>
|
||||
<groupId>clover</groupId>
|
||||
<artifactId>clover</artifactId>
|
||||
<version>1.2.3</version>
|
||||
<properties>
|
||||
<classloader>root</classloader>
|
||||
</properties>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<reports>
|
||||
<report>maven-changes-plugin</report>
|
||||
<report>maven-changelog-plugin</report>
|
||||
<report>maven-file-activity-plugin</report>
|
||||
<report>maven-developer-activity-plugin</report>
|
||||
<report>maven-file-activity-plugin</report>
|
||||
<report>maven-license-plugin</report>
|
||||
<report>maven-linkcheck-plugin</report>
|
||||
</reports>
|
||||
</project>
|
||||
|
||||
@ -1,116 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<author email="vmassol@octo.com">Vincent Massol</author>
|
||||
<title>Maven Clover Plug-in Build File Documentation</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven Clover Plug-in Build File">
|
||||
<p>
|
||||
Maven utilizes <a href="http://ant.apache.org/">Ant</a>
|
||||
to provide users with an easy-to-use and familiar interface to
|
||||
manage projects that have been described with a valid Maven <a
|
||||
href="../project-descriptor.html">project descriptor</a>.
|
||||
The build files that Maven <a href="../../start/index.html">
|
||||
installs</a> are stored in <code>${maven.home}</code> directory.
|
||||
</p>
|
||||
<p>
|
||||
This document describes the Ant build file and targets
|
||||
that are available when using the Clover Plug-in with Maven.
|
||||
</p>
|
||||
<p>
|
||||
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,
|
||||
<code>${lib.repo}</code> and <code>${maven.home}</code>, and
|
||||
allow you to override Maven defaults properties. Please refer
|
||||
to the <a href="../../start/integrate.html">Integration</a> document for
|
||||
more information on how to integrate these build targets into
|
||||
your project.
|
||||
</p>
|
||||
<p>
|
||||
The following table contains a brief overview of the
|
||||
build file that is installed as part of the Maven Clover Plug-in in the
|
||||
<code>${maven.home}/plugin/clover</code> directory. In addition,
|
||||
the various Ant targets in this file is discussed.
|
||||
</p>
|
||||
<table>
|
||||
<tr><th>Build File</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td><a href="#clover/build.xml">build.xml</a></td>
|
||||
<td>
|
||||
Contains targets to generate Clover test coverage reports.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p>
|
||||
The build file utilizes various properties for default and
|
||||
user-configurable settings. All Clover Plug-in properties are described
|
||||
in the <a href="properties.html">Properties</a> document.
|
||||
|
||||
The rest of this document assumes your project follows the standard
|
||||
<a href="dirlayout.html">Directory Layout</a>; however, it is
|
||||
possible to override many of these defaults.
|
||||
</p>
|
||||
</section>
|
||||
<section name="clover/build.xml">
|
||||
<table>
|
||||
<tr><th>Target</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td><a href="#maven:clover-test">maven:clover-test</a></td>
|
||||
<td>Runs unit tests on Clover-instrumented code and generates
|
||||
coverage data.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#maven:clover-report-html">maven:clover-report-html</a></td>
|
||||
<td>Generates HTML Clover Test coverage reports.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#maven:clover-report-swing">maven:clover-report-swing</a></td>
|
||||
<td>Run Clover Test coverage reports with the Swing viewer</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p/>
|
||||
<subsection name="maven:clover-test">
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
<strong>Note</strong> : 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 <code>maven:clover-test</code>
|
||||
target separately from the <code>maven:clover-report-*</code> ones
|
||||
or the report will show a 0% coverage result! In other words, do not
|
||||
type "<code>ant maven:clover-test maven:clover-report-*</code>".
|
||||
Instead, do it in 2 JVM invocations :
|
||||
"<code>ant maven:clover-tests</code>" and
|
||||
"<code>ant maven:clover-report-*</code>".
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="maven:clover-report-html">
|
||||
<p>
|
||||
Prior to running this target you should have called the
|
||||
<code>maven:clover-test</code> 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.
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="maven:clover-report-swing">
|
||||
<p>
|
||||
Prior to running this target you should have called the
|
||||
<code>maven:clover-test</code> one which generates a test
|
||||
result database file. This target runs a Swing viewer
|
||||
displaying the content of that database file.
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
@ -8,7 +8,10 @@
|
||||
|
||||
<body>
|
||||
|
||||
<release version="1.3" date="in CVS">
|
||||
<release version="1.3" date="2003-11-28">
|
||||
<action dev="vmassol" type="add">
|
||||
Added unit tests for the plugin and reworked the documentation.
|
||||
</action>
|
||||
<action dev="vmassol" type="update">
|
||||
Upgraded to Clover 1.2.3.
|
||||
</action>
|
||||
|
||||
@ -1,54 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<author email="vmassol@octo.com">Vincent Massol</author>
|
||||
<title>Maven Clover Plug-in Directory Layout</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
|
||||
<section name="Rationale">
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
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 <a
|
||||
href="../../start/integrate.html#Properties">Integration</a> document.
|
||||
</p>
|
||||
</section>
|
||||
<section name="Maven-Generated Layout">
|
||||
<table>
|
||||
<tr>
|
||||
<th>Directory name</th>
|
||||
<th>Content</th>
|
||||
<th>Comment</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>target/clover</td>
|
||||
<td>Contains instrumented code and clover database.</td>
|
||||
<td>
|
||||
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.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>target/docs/clover</td>
|
||||
<td>Contains generated Clover reports.</td>
|
||||
<td>
|
||||
Clover generates its HTML reports in this directory.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
@ -1,21 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<author email="vmassol@octo.com">Vincent Massol</author>
|
||||
<title>Futures for the Clover Plug-in</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Futures">
|
||||
<p>
|
||||
The following is a list of things that are being contemplated
|
||||
for the Maven Clover Plug-in.
|
||||
</p>
|
||||
<ol>
|
||||
<li>Also run integration unit tests before generating the reports</li>
|
||||
<li>Export the name of the Clover database as a property</li>
|
||||
</ol>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
@ -2,26 +2,42 @@
|
||||
|
||||
<document>
|
||||
<properties>
|
||||
<title>Maven clover Plug-in Goals</title>
|
||||
<title>Maven Clover plugin goals</title>
|
||||
<author email="dion@apache.org">dIon Gillard</author>
|
||||
<author email="vmassol@apache.org">Vincent Massol</author>
|
||||
</properties>
|
||||
<body>
|
||||
<section name="Registering a Clover report">
|
||||
<p>
|
||||
The typical way to use the Clover plugin is by registering a Clover
|
||||
report in your <code>project.xml</code>:
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
<reports>
|
||||
<report>maven-clover-plugin</report>
|
||||
[...]
|
||||
</reports>
|
||||
]]></source>
|
||||
</section>
|
||||
<goals>
|
||||
<goal>
|
||||
<name>clover</name>
|
||||
<description>Generate HTML test coverage reports with Clover</description>
|
||||
<description>
|
||||
This is the default goal. Does the same as the
|
||||
<code>clover:report</code> goal.
|
||||
</description>
|
||||
</goal>
|
||||
<goal>
|
||||
<name>clover:html-report</name>
|
||||
<description>Generate HTML test coverage reports with Clover</description>
|
||||
</goal>
|
||||
<goal>
|
||||
<name>clover:on</name>
|
||||
<description>Create the needed directory structure</description>
|
||||
</goal>
|
||||
<goal>
|
||||
<name>clover:swing-report</name>
|
||||
<description>Generate Swing test coverage reports with Clover</description>
|
||||
<name>clover:report</name>
|
||||
<description>
|
||||
Generate Clover test coverage reports with Clover. There are 3
|
||||
possible reports: HTML, XML or Swing. Whether a report is generated
|
||||
is controller by the <code>maven.clover.report.[report name]</code>
|
||||
<a href="properties.html">properties</a>. 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.
|
||||
</description>
|
||||
</goal>
|
||||
</goals>
|
||||
</body>
|
||||
|
||||
@ -3,67 +3,21 @@
|
||||
|
||||
<properties>
|
||||
<title>Maven Clover Plug-in</title>
|
||||
<author email="vmassol@octo.com">Vincent Massol</author>
|
||||
<author email="vmassol@apache.org">Vincent Massol</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven Clover Plug-in">
|
||||
<section name="Maven Clover plugin">
|
||||
<p>
|
||||
This document provides an overview of the Maven Clover Plug-in.
|
||||
The Clover Plug-in is the place where
|
||||
<a href="http://www.thecortex.net/clover/">Clover</a> tools are found
|
||||
in Maven.
|
||||
</p>
|
||||
<p>
|
||||
The documents presented here are references, if you are looking
|
||||
for more verbose usage material, please refer to the <a
|
||||
href="../../../start/index.html">Getting Started</a> 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.
|
||||
</p>
|
||||
<subsection name="What it is">
|
||||
<p>
|
||||
The Clover Plug-in is the place where <a
|
||||
href="http://www.thecortex.net/clover/">Clover</a> tools are found
|
||||
in Maven.
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="Overview of the Clover Plug-in Reference Documentation">
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
<tr><td><a href="build-file.html">Build File</a></td>
|
||||
<td>
|
||||
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.
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><a href="properties.html">Properties</a></td>
|
||||
<td>
|
||||
The behavior of the Maven Clover Plug-in can be altered via
|
||||
properties. This document describes each property
|
||||
available as the default used.
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><a href="dirlayout.html">Directory Layout</a></td>
|
||||
<td>
|
||||
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.
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td><a href="futures.html">Futures</a></td>
|
||||
<td>
|
||||
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.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
@ -9,11 +9,11 @@
|
||||
<item name="Clover" href="http://www.thecortex.net/clover/"/>
|
||||
</links>
|
||||
<menu name="Overview">
|
||||
<item name="Build File" href="/build-file.html"/>
|
||||
<item name="Goals" href="/goals.html"/>
|
||||
<item name="Properties" href="/properties.html"/>
|
||||
<item name="Directory Layout" href="/dirlayout.html"/>
|
||||
<item name="Futures" href="/futures.html"/>
|
||||
<item name="Goals" href="/goals.html"/>
|
||||
<item name="Properties" href="/properties.html"/>
|
||||
</menu>
|
||||
<menu name="Downloads">
|
||||
<item name="Clover Plugin 1.3" href="http://www.ibiblio.org/maven/maven/plugins/maven-clover-plugin-1.3.jar"/>
|
||||
</menu>
|
||||
</body>
|
||||
</project>
|
||||
|
||||
@ -2,63 +2,70 @@
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<author email="vmassol@octo.com">Vincent Massol</author>
|
||||
<title>Maven Clover Plug-in Properties Documentation</title>
|
||||
<author email="vmassol@apache.org">Vincent Massol</author>
|
||||
<title>Maven Clover plugin properties</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven Clover Plug-in Properties">
|
||||
<p>
|
||||
The following is an overview of the various properties (and
|
||||
default values) used by the Maven Clover Plug-in <a
|
||||
href="build-file.html">build file</a>. Most of these
|
||||
properties are optional and have defaults; however, there are
|
||||
mandatory properties that must be set as described in this document.
|
||||
</p>
|
||||
<p>
|
||||
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
|
||||
<a href="../../start/integrate.html">Integration</a>
|
||||
document for the preferred method of setting properties in your project.
|
||||
</p>
|
||||
<section name="Maven Clover plugin properties">
|
||||
<table>
|
||||
<tr><th>Section</th><th>Description</th></tr>
|
||||
<tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
|
||||
<tr>
|
||||
<td><a href="#Misc Settings">Misc</a></td>
|
||||
<td>maven.clover.orderBy</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
These properties specify various settings that control the
|
||||
behaviour of the Clover Plug-in.
|
||||
Specifies how the reports must be sorted:
|
||||
<ul>
|
||||
<li>Alpha -- Alpabetical </li>
|
||||
<li>PcCoveredAsc -- Percent total coverage, ascending</li>
|
||||
<li>PcCoveredDesc -- Percent total coverage, descending </li>
|
||||
<li>ElementsCoveredAsc -- Total elements covered, ascending </li>
|
||||
<li>ElementsCoveredDesc -- Total elements covered, descending </li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<code>PcCoveredAsc</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
|
||||
<section name="Misc Settings">
|
||||
<table>
|
||||
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td><a name="maven.clover.database.dir">maven.clover.database.dir</a></td>
|
||||
<td>No</td>
|
||||
<td>maven.clover.report.html</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies the location of the Clover database. The default value is
|
||||
<code>${maven.build.dir}/clover/database</code>.
|
||||
Decides whether an HTML report will be generated.
|
||||
</td>
|
||||
</tr>
|
||||
<td>
|
||||
<code>true</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.clover.orderBy</td>
|
||||
<td>No</td>
|
||||
<td>
|
||||
Specifies the type of report to generate:
|
||||
<ul>
|
||||
<li>Alpha -- Alpabetical </li>
|
||||
<li>PcCoveredAsc -- Percent total coverage, ascending <b>(default)</b></li>
|
||||
<li>PcCoveredDesc -- Percent total coverage, descending </li>
|
||||
<li>ElementsCoveredAsc -- Total elements covered, ascending </li>
|
||||
<li>ElementsCoveredDesc -- Total elements covered, descending </li>
|
||||
|
||||
</ul>
|
||||
</td>
|
||||
<td>maven.clover.report.xml</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Decides whether an XML report will be generated.
|
||||
</td>
|
||||
<td>
|
||||
<code>false</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.clover.report.swing</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Decides whether a Swing report will be generated.
|
||||
</td>
|
||||
<td>
|
||||
<code>false</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.clover.database.dir</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies the location of the Clover database.
|
||||
</td>
|
||||
<td>
|
||||
<code>${maven.build.clover}/database</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user