Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 46 Next »

Plugin Information

View Clover on the plugin site for more information.

This plugin allows you to capture code coverage reports from Clover. Hudson will generate and track code coverage across time. This plugin can be used without the need to modify your build.xml.

Scriptless Integration for Ant Builds

Since version 2.0 of the Clover Plugin, Clover can be integrated into any* Ant build without the need to modify the build.xml .
Simply check the "Automatically record and report Code Coverage" checkbox in the Job configuration screen.

The Clover plugin will add an Ant BuildListener and appropriate configuration parameters to allow Clover HTML, XML, JSON and Historical reports to be generated for your Job.

These will automatically be linked to from the Job and Build pages.

The Clover License string can be configured either per-Job, or globally view the "Manage Hudson -> Configure System -> Manage Clover" screen.

* most. we've not tested this on every Ant build (wink)

 Manually Configuring Clover Plugin

  1. Install the clover plugin
  2. Configure your project's build script to generate clover XML reports
  3. (Optional) configure your project's build script to generate clover HTML or PDF reports (this plugin prefers HTML reports to PDF).  The plugin will not extract any information from these reports, but will use them as a better formatted most recent coverage report when they are available.
  4. Enable the "Publish Clover Coverage Report" publisher
  5. Specify the directory where the clover.xml report is generated.
  6. (Optional) Configure the coverage metric targets to reflect your goals.

Maven Configuration (with freestyle project)

The maven-clover-plugin is one of the plugins that highlights an issue with how Maven 2 handles aggregator goals.

Hudson cannot handle maven aggregator goals with the maven2 project (alpha) project type due to how this project type calls Maven.

In order to obtain multi-module clover reports, you must therefore use the free-style software project project type.  In any case, the hudson clover plugin does not currently support the maven2 project (alpha) project type.

In order to ensure that the correct aggregated report is generated, it is necessary to invoke maven multiple times.

Short answer:

  • Create the job as a "free-style software project".
  • Enable the "Invoke top-level Maven targets" Build.
  • Specify the following goals for Maven: (Note the use of the pipe character | to invoke maven three times).
install
-Dmaven.test.failure.ignore=true
|
-Dclover.license.file=path-to-clover-license
clover:instrument
clover:aggregate
|
-Dclover.license.file=path-to-clover-license
-N
clover:aggregate
clover:clover
  • Enable the "Publish Clover Coverage Report" publisher.
  • Depending on your Source Code Management, the clover report directory will either be "target/site/clover" or "module-name/target/site/clover"
  • Don't forget to configure the pom.xml to generate the clover.xml report
    <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
      ...
      <build>
        ...
        <plugins>
          ...
          <plugin>
            <artifactId>maven-clover-plugin</artifactId>
            ...
    	<configuration>
              ...
              <licenseLocation>${clover.license.file}</licenseLocation>
              <generateHtml>true</generateHtml>
              <generateXml>true</generateXml>
              ...
            </configuration>
            ...
          </plugin>
          ...
        </plugins>
        ...
      </build>
      ...
    </project>
    

Maven2, Clover and Multimodule with a <packaging>ear</packaging> child module

The maven2 ear packaging will break if you use the clover goal at any time during the same invokation of maven if you ivoke the package or later phases (as it will see artifacts without a classifier and with the clover classifier, get confused and give up)

To work around this, you should configurer your root pom to include the <packaging>ear</packaging> targets only when you are not using clover... how to do this:

<project>
  ...
  <profiles>
    ...
    <profile>
      <id>running-clover</id>
      <activation>
        <property>
          <name>clover.license.file</name>
        </property>
      </activation>
      <build>
        <pluginManagement>
          <plugins>
            <plugin>
              <artifactId>maven-clover-plugin</artifactId>
              <configuration>
                <licenseLocation>${clover.license.file}</licenseLocation>
                <generateHtml>true</generateHtml>
                <generateXml>true</generateXml>
              </configuration>
            </plugin>
          </plugins>
        </pluginManagement>
      </build>
    </profile>
    <profile>
      <id>not-running-clover</id>
      <activation>
        <property>
          <name>!clover.license.file</name>
        </property>
      </activation>
      <modules>
        <module>my-ear-artifact</module>
        <!-- list any other ear child modules here -->
      </modules>
    </profile>
    ...
  </profiles>
  ...
</project>

 The above... hack... is why it is recommended to invoke maven three times.  If you don't need this hack, you could simplify down to two invocations and specify the clover license file location in the pom.xml, i.e. install clover:instrument | -N clover:aggregate clove:site

Version History

Version 4.0.6 (May 13, 2012)

  • Upgrade to Clover 3.1.5

Version 4.0.5 (Jan 18, 2012)

Version 4.0.4 (Nov 8, 2011)

Version 4.0.2 (Jun 6, 2011)

Version 4.0.1 (May 7, 2011)

Version 4.0

Jenkins 1.399 or later

  • fixed the icon path on configuration pages (JENKINS-7795).
  • Clover Coverage Trend Report Stop Displaying For Failed Build (JENKINS-3918).
  • Ignore 0/0 Conditional in coverage graph (JENKINS-8198).
  • i18n & i10n(ja)

Version 3.0.2

Version 3.0.1

  • Upgrade to Clover 3.0 which has Support for Groovy
  • View Release Notes
  • No other changes to the Hudson Clover plugin, apart from its dependency on Clover 3.0

Version 2.6.3

This release is only compatibly with Hudson: 1.339 and above.

Version 2.5

  • support for specifying an optional Clover XML report filename

Version 2.4 (skipped)

Version 2.3

  • support for running builds on Windows
  • updated Clover dependency to 2.6.1 to support IE6

Version 2.2

  • minor bug fix

Version 2.1

  • Scriptless integration for Ant Builds - no modifications to build.xml required - just check the "With Clover" checkbox.
  • New bar-charts
  • Clover HTML linked from each Build to make comparing changes in coverage easier

Version 1.7

  • Clover processing runs before notifications run, to avoid inconsistency in the build status reporting (JENKINS-1285)

Version 1.5 (17/08/2007)

  • Fixed a number of issues relating to rendering of the trend graph when there was no trend present.
  • No labels