org.apache.maven.plugin.clover.CloverInstrumentMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-clover-plugin
Maven plugin for Clover
There is a newer version: 2.4
package org.apache.maven.plugin.clover;

/*
 * Copyright 2001-2005 The Apache Software Foundation.
 *
 * 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 com.cenqua.clover.CloverInstr;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;

import java.io.File;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

/**
 * Instrument source roots.
 *
 * @author Vincent Massol
 * @version $Id: CloverInstrumentMojo.java 219894 2005-07-20 13:13:05Z brett $
 * @goal instrument
 * @phase generate-sources
 * @requiresDependencyResolution test
 */
public class CloverInstrumentMojo
    extends AbstractCloverMojo
{
    /**
     * @parameter
     * @required
     */
    private String cloverOutputDirectory;

    /**
     * @parameter
     * @required
     */
    private String cloverDatabase;

    /**
     * @parameter expression="${project}"
     * @required
     * @readonly
     */
    private MavenProject project;

    /**
     * @parameter expression="${plugin.artifacts}"
     * @required
     */
    private List pluginArtifacts;

    /**
     * @parameter expression="${component.org.apache.maven.artifact.factory.ArtifactFactory}"
     * @required
     * @readonly
     */
    private ArtifactFactory factory;

    private String cloverOutputSourceDirectory;

    private void init()
    {
        new File( this.cloverOutputDirectory ).mkdirs();

        this.cloverOutputSourceDirectory = new File( this.cloverOutputDirectory, "src" ).getPath();
    }

    public void execute()
        throws MojoExecutionException
    {
        init();

        registerLicenseFile();

        int result = CloverInstr.mainImpl( createCliArgs() );
        if ( result != 0 )
        {
            throw new MojoExecutionException( "Clover has failed to instrument the source files" );
        }

        addGeneratedSourcesToCompileRoots();
        addCloverDependencyToCompileClasspath();

        // Explicitely set the output directory to be the Clover one so that all other plugins executing
        // thereafter output files in the Clover output directory and not in the main output directory.
        // TODO: Ulgy hack below. Changing the directory should be enough for changing the values of all other
        // properties depending on it!
        this.project.getBuild().setDirectory( this.cloverOutputDirectory );
        this.project.getBuild().setOutputDirectory( new File( this.cloverOutputDirectory, "classes" ).getPath() );
        this.project.getBuild().setTestOutputDirectory(
            new File( this.cloverOutputDirectory, "test-classes" ).getPath() );
    }

    /**
     * @todo handle multiple source roots. At the moment only the first source root is instrumented
     */
    private void addGeneratedSourcesToCompileRoots()
    {
        this.project.getCompileSourceRoots().remove( 0 );
        this.project.addCompileSourceRoot( this.cloverOutputSourceDirectory );
    }

    private void addCloverDependencyToCompileClasspath()
        throws MojoExecutionException
    {
        Artifact cloverArtifact = null;
        Iterator artifacts = this.pluginArtifacts.iterator();
        while ( artifacts.hasNext() && cloverArtifact == null )
        {
            Artifact artifact = (Artifact) artifacts.next();
            if ( "clover".equalsIgnoreCase( artifact.getArtifactId() ) )
            {
                cloverArtifact = artifact;
            }
        }

        if ( cloverArtifact == null )
        {
            throw new MojoExecutionException( "Couldn't find 'clover' artifact in plugin dependencies" );
        }

        cloverArtifact = factory.createArtifact( cloverArtifact.getGroupId(), cloverArtifact.getArtifactId(),
                                                 cloverArtifact.getVersion(), Artifact.SCOPE_COMPILE,
                                                 cloverArtifact.getType() );

        // TODO: use addArtifacts
        Set set = new HashSet( project.getDependencyArtifacts() );
        set.add( cloverArtifact );
        project.setDependencyArtifacts( set );
    }

    /**
     * @return the CLI args to be passed to CloverInstr
     * @todo handle multiple source roots. At the moment only the first source root is instrumented
     */
    private String[] createCliArgs()
    {
        // TODO: Temporary while we wait for surefire to be able to fork unit tests. See
        // http://jira.codehaus.org/browse/MNG-441
        return new String[]{"-p", "threaded", "-f", "100", "-i", this.cloverDatabase, "-s",
            (String) this.project.getCompileSourceRoots().get( 0 ), "-d", this.cloverOutputSourceDirectory};
    }
}