org.codehaus.mojo.cobertura.tasks.CheckTask Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cobertura-maven-plugin Show documentation

This is the Mojo's Maven plugin for Cobertura. Cobertura is a free Java tool that calculates the percentage of code accessed by tests. It can be used to identify which parts of your Java program are lacking test coverage.

There is a newer version: 2.7

Show newest version

package org.codehaus.mojo.cobertura.tasks;

/*
 * Copyright 2011
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.codehaus.mojo.cobertura.configuration.ConfigCheck;
import org.codehaus.mojo.cobertura.configuration.Regex;
import org.codehaus.plexus.util.StringUtils;

/**
 * The Check Task.
 * 
 * @author Joakim Erdfelt
 */
public class CheckTask
    extends AbstractTask
{
    private ConfigCheck config;

    private String dataFile;

    /**
     * Setup the check task.
     */
    public CheckTask()
    {
        super( "net.sourceforge.cobertura.check.Main" );
    }

    /**
     * {@inheritDoc}
     */
    public void execute()
        throws MojoExecutionException, MojoFailureException
    {
        if ( dataFile != null )
        {
            cmdLineArgs.addArg( "--datafile", dataFile );
        }

        if ( StringUtils.isNotEmpty( config.getBranchRate() ) )
        {
            cmdLineArgs.addArg( "--branch", config.getBranchRate() );
        }

        if ( StringUtils.isNotEmpty( config.getLineRate() ) )
        {
            cmdLineArgs.addArg( "--line", config.getLineRate() );
        }

        if ( StringUtils.isNotEmpty( config.getTotalBranchRate() ) )
        {
            cmdLineArgs.addArg( "--totalbranch", config.getTotalBranchRate() );
        }

        if ( StringUtils.isNotEmpty( config.getTotalLineRate() ) )
        {
            cmdLineArgs.addArg( "--totalline", config.getTotalLineRate() );
        }

        if ( StringUtils.isNotEmpty( config.getPackageBranchRate() ) )
        {
            cmdLineArgs.addArg( "--packagebranch", config.getPackageBranchRate() );
        }

        if ( StringUtils.isNotEmpty( config.getPackageLineRate() ) )
        {
            cmdLineArgs.addArg( "--packageline", config.getPackageLineRate() );
        }
        
        if ( StringUtils.isNotEmpty( config.getMaxmem() ) )
        {
            this.setMaxmem( config.getMaxmem() );
        }

        for ( Regex regex : config.getRegexes() )
        {
            cmdLineArgs.addArg( "--regex", regex.toString() );
        }

        int returnCode = executeJava();

        // Check the return code and print a message
        if ( returnCode == 0 )
        {
            getLog().info( "All checks passed." );
        }
        else
        {
            if ( config.isHaltOnFailure() )
            {
                throw new MojoFailureException( "Coverage check failed. See messages above." );
            }
            else
            {
                getLog().error( "Coverage check failed. See messages above." );
            }
        }
    }

    /**
     * @return the check configuration.
     */
    public ConfigCheck getConfig()
    {
        return config;
    }

    /**
     * @return Returns the dataFile.
     */
    public String getDataFile()
    {
        return dataFile;
    }

    /**
     * Set the check configuration.
     * @param config the config.
     */
    public void setConfig( ConfigCheck config )
    {
        this.config = config;
    }

    /**
     * @param dataFile The dataFile to set.
     */
    public void setDataFile( String dataFile )
    {
        this.dataFile = dataFile;
    }

}