plugins/maven-compile-plugin/src/main/java/npanday/plugin/compile/AssemblyInfoGeneratorMojo.java

package npanday.plugin.compile;

/*
 * 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.
 */

import npanday.ArtifactTypeHelper;
import npanday.PlatformUnsupportedException;
import npanday.assembler.AssemblerContext;
import npanday.assembler.AssemblyInfo;
import npanday.assembler.AssemblyInfoException;
import npanday.assembler.AssemblyInfoMarshaller;
import npanday.registry.RepositoryRegistry;
import npanday.vendor.SettingsUtil;
import npanday.vendor.Vendor;
import npanday.vendor.VendorInfo;
import npanday.vendor.VendorRequirement;
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.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Generates an AssemblyInfo.* class based on information within the pom file.
 *
 * @author Shane Isbell
 * @goal generate-assembly-info
 * @phase generate-sources
 * @description Generates an AssemblyInfo.* class based on information within the pom file.
 */
public class AssemblyInfoGeneratorMojo
    extends AbstractMojo
{
    /**
     * @parameter expression="${npanday.settings}" default-value="${user.home}/.m2"
     */
    private String settingsPath;

    /**
     * @component
     */
    private RepositoryRegistry repositoryRegistry;

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

    /**
     * The framework version to compile under: 1.1, 2.0, 3.0
     *
     * @parameter expression = "${frameworkVersion}"
     */
    private String frameworkVersion;

    /**
     * The vendor version to compile under. For Microsoft, this will be the same as the framework version.
     *
     * @parameter expression = "${vendorVersion}"
     */
    private String vendorVersion;

    /**
     * .NET Language. The default value is <code>C_SHARP</code>. Not case or white-space sensitive.
     *
     * @parameter expression="${language}" default-value = "C_SHARP"
     * @required
     */
    private String language;

    /**
     * The vendor for the compiler: MICROSOFT, MONO, DOTGNU. Not case or white-space sensitive.
     *
     * @parameter expression="${vendor}"
     */
    private String vendor;

    /**
     * Specify a strong name key file.
     *
     * @parameter expression = "${keyfile}"
     */
    private File keyfile;

    /**
     * Specifies a strong name key container. (not currently supported)
     *
     * @parameter expression = "${keycontainer}"
     */
    private String keycontainer;

    /**
     * Source directory containing the copied class files.
     *
     * @parameter expression = "${sourceDirectory}" default-value="${project.build.sourceDirectory}"
     * @required
     */
    private String sourceDirectory;

    /**
     * @component
     */ 
    private AssemblerContext assemblerContext;

    /**
     * @component
     */
    private npanday.vendor.StateMachineProcessor stateMachineProcessor;

    /**
     * Adds a CustomStringAttribute for each key-value pair configured.
     *
     * @parameter
     */
    protected Map assemblyInfo = new HashMap();

    /**
     * If an AssemblyInfo file exists in the source directory, then this method will not generate an AssemblyInfo.
     *
     * @throws MojoExecutionException
     */
    public void execute()
        throws MojoExecutionException
    {
        long startTime = System.currentTimeMillis();

        SettingsUtil.applyCustomSettings( getLog(), repositoryRegistry, settingsPath );

        if ( ArtifactTypeHelper.isDotnetModule( project.getArtifact().getType() ))
        {
            return;
        }

        File srcFile = new File( sourceDirectory );
        if ( srcFile.exists() )
        {
            try
            {
                List files = FileUtils.getFiles( srcFile, "**/AssemblyInfo.*", null );
                if ( files.size() != 0 )
                {
                    getLog().info( "NPANDAY-902-001: Found AssemblyInfo file(s), so will not generate one" );
                    return;
                }
            }
            catch ( IOException e )
            {
                throw new MojoExecutionException(
                    "NPANDAY-902-004: Could not determine whether an AssemblyInfo file exists", e );
            }
        }
        getLog().info( "NPANDAY-902-000: Generating Assembly Info: Language = " + language.trim() );

        //TODO: Investigate the affect of not setting isDefault and profile. In the case of executables, this is
        //managed by the framework. I intended to keep vendor info and state machine processor out of the
        // Mojos. Unable to do so for this case. Look at new API.
        VendorRequirement vendorRequirement = new VendorRequirement(vendor, vendorVersion,  frameworkVersion);
        AssemblyInfo assemblyInfo = assemblerContext.getAssemblyInfo( project );
        assemblyInfo.setCustomStringAttributes(this.assemblyInfo);

        VendorInfo vendorInfo;
        try
        {
            vendorInfo = stateMachineProcessor.process( vendorRequirement );
        }
        catch ( npanday.vendor.IllegalStateException e )
        {
            throw new MojoExecutionException(
                "NPANDAY-902-008: Illegal state of vendor info: Message =  " + e.getMessage(), e);
        }
        catch ( PlatformUnsupportedException e )
        {
           throw new MojoExecutionException(
                "NPANDAY-902-009: Platform is unsupported: Message =  " + e.getMessage(), e);
        }

        if ( vendorInfo.getVendor().equals( Vendor.MICROSOFT ) && vendorInfo.getVendorVersion().equals( "1.1.4322" ) )
        {
            assemblyInfo.setKeyFile( keyfile );
            assemblyInfo.setKeyName( keycontainer );
        }
        try
        {
            AssemblyInfoMarshaller marshaller = assemblerContext.getAssemblyInfoMarshallerFor( language.trim() );
            marshaller.marshal( assemblyInfo, project, null );
        }
        catch ( IOException e )
        {
            throw new MojoExecutionException( "NPANDAY-902-002: Problem generating assembly info class", e );
        }
        catch ( AssemblyInfoException e )
        {
            throw new MojoExecutionException( "NPANDAY-902-005: Problem generating assembly info class", e );
        }

        long endTime = System.currentTimeMillis();
        getLog().info( "Mojo Execution Time = " + (endTime - startTime));
    }
}