org.codehaus.mojo.cobertura.CoberturaDatafileDumpMojo 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;

/*
 * 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 java.text.NumberFormat;
import java.util.Date;
import java.util.Iterator;

import net.sourceforge.cobertura.coveragedata.CoverageDataFileHandler;
import net.sourceforge.cobertura.coveragedata.PackageData;
import net.sourceforge.cobertura.coveragedata.ProjectData;
import net.sourceforge.cobertura.util.Header;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;

/**
 * Cobertura Datafile Dump Mojo
 *
 * @author Joakim Erdfelt
 * @version $Id: CoberturaDatafileDumpMojo.java 15531 2011-12-10 12:24:33Z rfscholte $
 * @goal dump-datafile
 */
public class CoberturaDatafileDumpMojo
    extends AbstractCoberturaMojo
{

    /**
     * Mojo main entry
     * @throws MojoExecutionException
     */
    public void execute()
        throws MojoExecutionException, MojoFailureException
    {
        if ( skipMojo() )
        {
            return;
        }
        
        if ( !getDataFile().exists() )
        {
            throw new MojoExecutionException( "Unable to dump nonexistent dataFile [" + getDataFile() + "]" );
        }

        ProjectData projectData = CoverageDataFileHandler.loadCoverageData( getDataFile() );
        NumberFormat percentage = NumberFormat.getPercentInstance();
        NumberFormat integer = NumberFormat.getIntegerInstance();

        println( "" );

        printProject( projectData, percentage, integer );

        Iterator it = projectData.getPackages().iterator();
        while ( it.hasNext() )
        {
            PackageData packageData = (PackageData) it.next();
            printPackage( percentage, integer, packageData );
        }

        println( "" );
    }

    /**
     * print project info to the log.
     * @param projectData
     * @param percentage
     * @param integer
     */
    private void printProject( ProjectData projectData, NumberFormat percentage, NumberFormat integer )
    {
        println( "" );
    }

    /**
     * print package info to the log.
     * @param percentage
     * @param integer
     * @param packageData
     */
    private void printPackage( NumberFormat percentage, NumberFormat integer, PackageData packageData )
    {
        println( "" );
    }

    /**
     * Write the message to the logger
     * @param msg
     */
    private void println( String msg )
    {
        getLog().info( msg );
    }
}