Cobertura XML Check Maven Plugin

The standard Cobertura maven plugin processes cobertura classes, not the XML report for threshold checks. This becomes a barrier when generating the cobertura report using tools like testacular, a coverage utility for Java Script. This plugin will parse the report and perform threshold checks. It targets the http://cobertura.sourceforge.net/xml/coverage-04.dtd

License	Apache 2
Categories	Maven Build Tools Cobertura Application Testing & Monitoring Code Coverage
GroupId	com.tacitknowledge.maven.plugins
ArtifactId	cobertura-checker
Last Version	1.0.0
Release Date	May 15, 2013
Type	maven-plugin
Description	Cobertura XML Check Maven Plugin The standard Cobertura maven plugin processes cobertura classes, not the XML report for threshold checks. This becomes a barrier when generating the cobertura report using tools like testacular, a coverage utility for Java Script. This plugin will parse the report and perform threshold checks. It targets the http://cobertura.sourceforge.net/xml/coverage-04.dtd
Project URL	https://github.com/tacitknowledge/maven-cobertura-checker
Project Organization	Tacit Knowledge
Source Code Management	https://github.com/tacitknowledge/maven-cobertura-checker

Download cobertura-checker

Filename	Size
cobertura-checker-1.0.0.pom
cobertura-checker-1.0.0.jar	19 KB
cobertura-checker-1.0.0-sources.jar	9 KB
cobertura-checker-1.0.0-javadoc.jar	55 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.tacitknowledge.maven.plugins</groupId>
    <artifactId>cobertura-checker</artifactId>
    <version>1.0.0</version>
</plugin>

Dependencies

compile (1)

Group / Artifact	Type	Version
org.apache.maven : maven-project	jar	2.2.1

provided (2)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.0.4
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.2

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.10

Project Modules

There are no modules declared in this project.

Introduction and Motivation

This processes a cobertura formatted XML report against coverage requirements. This is for use with [Testacular] (https://github.com/testacular/ "Testacular") which generates a cobertura formatted report but does not check coverage by itself.

Testacular does not allow complete control over the directory which outputs its reports. It creates subdirectories named by browser, browser version, and operating system. maven properties and profiles can handle these situations.

The standard cobertura maven plugin does have a check goal, but it was unusable against previously generated reports.

Target report DTD: http://cobertura.sourceforge.net/xml/coverage-04.dtd

Use it!

The sample directory contains a maven pom that exercises the plugin. Please see it for more details.

Sample Usage:

<configuration>
    <!-- note that testacular will create multiple sub directories
         based on browser and operating system.  These need to be configured.
         An example is this sub directory for executing in Phantom JS on a mac.

             'PhantomJS 1.7 (Mac)'

             To handle running the build on different platforms, use profile overrides
         -->
    <inputFile>${project.build.dir}/jstest/${cobertura.report.dir}/coverage.xml</inputFile>
    <skip>false</skip>
    <haltOnFailure>true</haltOnFailure>

    <!-- apply these to coverage element of report total -->
    <totalLineRate>1.0</totalLineRate>
    <totalBranchRate>1.0</totalBranchRate>

    <!-- apply these to each package -->
    <lineRate>0.0</lineRate>
    <branchRate>0.0</branchRate>

    <packages>
        <!-- override for packages specified by wildcard -->
        <PackageConfig>
            <nameOrPrefix>java.util.*</nameOrPrefix>
            <branchRate>0.5</branchRate>
            <lineRate>0.5</lineRate>
        </PackageConfig>
        <!-- override for specific package -->
        <PackageConfig>
            <nameOrPrefix>java.util.concurrent</nameOrPrefix>
            <branchRate>0.5</branchRate>
            <lineRate>0.5</lineRate>
        </PackageConfig>
    </packages>


</configuration>
<goals>
    <goal>check</goal>
</goals>

Licensing

This framework is released under Apache 2.0 Public License. The text of the license you can find at http://www.apache.org/licenses/LICENSE-2.0.txt.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Tacit Knowledge

Versions

Version
1.0.0 May 15, 2013