plugins/maven-fxcop-plugin/src/main/java/npanday/plugin/fxcop/FxCopMojo.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package npanday.plugin.fxcop;

import npanday.ArtifactType;
import npanday.ArtifactTypeHelper;
import npanday.PlatformUnsupportedException;
import npanday.artifact.AssemblyResolver;
import npanday.artifact.NPandayArtifactResolutionException;
import npanday.executable.ExecutableRequirement;
import npanday.executable.ExecutionException;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.FileUtils;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

/**
 * Runs the FxCop Code Analysis Tool for the specified project's assembly.
 *
 * @author Shane Isbell
 * @goal fxcop
 * @description Runs the FxCop Code Analysis Tool for the specified project's assembly
 */
public class FxCopMojo
    extends AbstractMojo
{
    /**
     * @component
     */
    private npanday.executable.NetExecutableFactory netExecutableFactory;

    /**
     * The maven project.
     *
     * @parameter expression="${project}"
     * @required
     */
    private MavenProject project;

    /**
     * The Vendor for the executable.
     *
     * @parameter expression="${vendor}"
     */
    private String vendor;

    /**
     * @parameter expression = "${frameworkVersion}"
     */
    private String frameworkVersion;

    /**
     * The profile that the executable should use.
     *
     * @parameter expression = "${profile}" default-value = "Microsoft:FxCop:FxCopCmd"
     */
    private String profile;

    /**
     * @component
     */
    private AssemblyResolver assemblyResolver;

    /**
     * @parameter expression="${settings.localRepository}"
     * @readonly
     */
    private File localRepository;

    /**
     * @parameter expression = "${project.build.directory}"
     */
    private File targetDirectory;

    private File rootDir;


    public void execute()
        throws MojoExecutionException
    {
        //For multi-module
        if ( project.getPackaging().equals( "pom" ) )
        {

            if ( System.getProperty( "NPANDAY.ROOT_DIR" ) == null )
            {
                System.setProperty( "NPANDAY.ROOT_DIR", project.getBasedir().getAbsolutePath() );
            }
            return;
        }

        rootDir = ( System.getProperty( "NPANDAY.ROOT_DIR" ) != null ) ? new File(
            System.getProperty( "NPANDAY.ROOT_DIR" ) ) : null;

        try
        {
            assemblyResolver.resolveTransitivelyFor( project, project.getDependencies(),
                                                     project.getRemoteArtifactRepositories(), localRepository,
                                                     true );
        }
        catch ( IOException e )
        {
            throw new MojoExecutionException( e.getMessage() );
        }
        catch( NPandayArtifactResolutionException e )
        {
            throw new MojoExecutionException( e.getMessage() );
        }

        Set<Artifact> artifacts = project.getDependencyArtifacts();
        for ( Artifact artifact : artifacts )
        {
            if ( ArtifactTypeHelper.isDotnetAnyGac( artifact.getType() ) )
            {
                continue;
            }
            else
            {
                try
                {
                    FileUtils.copyFileToDirectory( artifact.getFile(), targetDirectory );
                }
                catch ( IOException e )
                {
                    throw new MojoExecutionException( "NPANDAY-1100-002: Artifact = " + artifact.toString(), e );
                }
            }
        }

        try
        {
            netExecutableFactory.getNetExecutableFor( new ExecutableRequirement( vendor, null, frameworkVersion, profile ), getCommands(), null ).execute();
        }
        catch ( ExecutionException e )
        {
            throw new MojoExecutionException( "NPANDAY-xxx-000: Unable to execute: Vendor " + vendor +
                ", frameworkVersion = " + frameworkVersion + ", Profile = " + profile, e );
        }
        catch ( PlatformUnsupportedException e )
        {
            throw new MojoExecutionException( "NPANDAY-xxx-001: Platform Unsupported: Vendor " + vendor +
                ", frameworkVersion = " + frameworkVersion + ", Profile = " + profile, e );
        }
    }

    public List<String> getCommands()
        throws MojoExecutionException
    {
        List<String> commands = new ArrayList<String>();

        String targetPath = "target" + File.separator + project.getArtifactId() + "." +
            ArtifactType.getArtifactTypeForPackagingName( project.getPackaging() ).getExtension();
        String outputPath = "target" + File.separator + "Output.xml";

        String relativePathToTargetFile =
            ( rootDir != null ) ? new File( project.getBasedir(), targetPath ).getAbsolutePath().substring(
                rootDir.getAbsolutePath().length() + 1 ) : targetPath;
        String relativePathToOutputFile =
            ( rootDir != null ) ? new File( project.getBasedir(), outputPath ).getAbsolutePath().substring(
                rootDir.getAbsolutePath().length() + 1 ) : outputPath;

        commands.add( "/f:" + relativePathToTargetFile );
        commands.add( "/o:" + relativePathToOutputFile );
        return commands;
    }
}