Enabling automatic code coverage integration

Automatic integration works with Ant, Maven and Grails tasks.

1. Go to your job. See Configuring jobs.
2. Click the Other tab.
3. In the 'Would you like to view code coverage for this plan?' setting, check Collect code coverage data for this job.
4. Select Automatically integrate a code coverage tool into this job.
5. In the Code coverage tool option, select Atlassian Clover (you will need to provide a Clover license in Administration > Manage Apps > Clover for Bamboo) or OpenClover (no license is required).
6. Click Save

By default, HTML and XML reports are generated. Additionally, you can:

• Select Generate a historical report to compare the current coverage results with previous code coverage reports.
• Select Generate a JSON report to get the results in a format ready for embedding into applications or external report views.

 Enabling manual code coverage integration

Manual code coverage integration works with any kind of task in which Clover can be called (Ant, Maven, Command, Grails). Use it when you already have Atlassian Clover or OpenClover integration configured to generate a report in your build scripts:

1. Go to your job. See Configuring jobs.
2. Click the Other tab.
3. In the 'Would you like to view code coverage for this plan?' settings, check Collect code coverage data for this job.
4. Select I already integrated a code coverage tool in this job.

5. In Coverage report, specify where Bamboo shall look for the XML report file generated. Specify the file path relative to your plan's root directory, e.g.:

    target/site/clover/clover.xml 

6. Click Save.

7. In the Artifacts tab, click Create artifact and complete the form as follows
   
   Name
   This should begin with with "Clover Report".
   Location
   This should point to the HTML report directory (e.g. target/site/clover)
   Copy Pattern
   Use **/*.*
   
   

8. Configure Atlassian Clover or OpenClover in your build script so that it generates both XML and HTML reports. See quick start guides how to do this:

   • Ant: for Atlassian Clover and for OpenClover

   • Maven: for Atlassian Clover and for OpenClover

9. For Atlassian Clover configure the license in your build script or pass it as a proper task parameter in the job configuration:

1. 1. Save the license key in a file (for example in /opt/bamboo/clover.license).
   2. Pass the location of the license key to the build task:
      • Define it in the build script, or
      • Pass it as a Java property for the Ant/Maven task in the plan configuration.
        
        

<project>
  <property name="clover.license.path" location="/opt/bamboo/clover.license"/>
</project>

clean with.clover test clover.report -Dclover.license.path=/opt/bamboo/clover.license

<plugin>
    <groupId>com.atlassian.maven.plugins</groupId>
    <artifactId>maven-clover2-plugin</artifactId>
    <configuration>
        <licenseLocation>/opt/bamboo/clover.license</licenseLocation>
    </configuration>
</plugin>

mvn clean clover2:setup verify clover2:aggregate clover2:clover -Dmaven.clover.licenseLocation=/opt/bamboo/clover.license

After every build, Bamboo will parse the Clover XML file and generate statistics and charts for a plan summary. The Plan summary and job summary pages will contain a Clover tab. 

Browsing code coverage results

For more information on Clover HTML report and Clover statistics for a job, see Viewing the Clover code-coverage for a plan. 

For more information on Clover code coverage summary for a plan, see Viewing the Clover code-coverage for a build.

For more information on Clover code coverage statistics across multiple plans, see Generating reports across multiple plans.

Limit the machines that Atlassian Clover runs on

If you have more remote agents than the number of machines for which Atlassian Clover is licensed, you can restrict the machines on which Clover runs by using capabilities:

1. For each of the EC2 images on which you would like to run builds with Atlassian Clover, add a capability such as clover=true to the configuration for the image.
   To do this, go to Administration > Elastic Bamboo > Configuration. Select the elastic image and click Add Capability.
2. Add a matching requirement, such as clover=true to the configuration for each job.
   To do this, go to Actions > Configure Plan > Jobs. Select the job where Clover runs and click Requirements and then Add Extra Requirement.

Troubleshooting

Failed to execute plugin 'Clover Results Collector' with error: No file matches the specified pattern ...