org.xolstice.maven.plugin.protobuf.ProtocPlugin Maven / Gradle / Ivy

Go to download
package org.xolstice.maven.plugin.protobuf;

/*
 * Copyright (c) 2018 Maven Protocol Buffers Plugin Authors. All rights reserved.
 *
 * 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.logging.Log;
import org.codehaus.plexus.util.Os;

import java.io.File;
import java.util.List;

import static java.util.Collections.emptyList;

/**
 * Describes a {@code protoc} plugin that is written in Java and
 * assembled from resolved artifacts at runtime.
 * The state is populated from the Maven plugin's configuration.
 *
 * @since 0.3.0
 */
public class ProtocPlugin {

    private static final String DATA_MODEL_SYSPROP = "sun.arch.data.model";

    private static final String WIN_JVM_DATA_MODEL_32 = "32";

    private static final String WIN_JVM_DATA_MODEL_64 = "64";


    private String id;

    private String groupId;

    private String artifactId;

    private String version;

    private String classifier;

    private String mainClass;

    private String javaHome;

    // Assuming we're running a HotSpot JVM, use the data model of the
    // current JVM as the default. This property is only relevant on
    // Windows where we need to pick the right version of the WinRun4J executable.
    private String winJvmDataModel;

    private List args;

    private List jvmArgs;

    /**
     * Returns the unique id for this plugin.
     *
     * @return the plugin's unique id.
     */
    public String getId() {
        return id;
    }

    /**
     * Returns group id of the plugin's artifact for dependency resolution.
     *
     * @return the plugin's group id.
     */
    public String getGroupId() {
        return groupId;
    }

    /**
     * Returns the plugin's artifact id for dependency resolution.
     *
     * @return the plugin's artifact id.
     */
    public String getArtifactId() {
        return artifactId;
    }

    /**
     * Returns the plugin's version specification for dependency resolution.
     * This can be specified as either a single version or a version range.
     *
     * @return the plugin's version or version range.
     */
    public String getVersion() {
        return version;
    }

    /**
     * Returns an optional classifier of the plugin's artifact for dependency resolution.
     *
     * @return the plugin's artifact classifier.
     */
    public String getClassifier() {
        return classifier;
    }

    /**
     * Returns the plugin's Java main class to be execute by protoc.
     *
     * @return fully qualified name for the main class.
     */
    public String getMainClass() {
        return mainClass;
    }

    /**
     * Returns optional command line arguments to pass to the {@code main()} method.
     *
     * @return a list of command-line arguments.
     */
    public List getArgs() {
        return args != null ? args : emptyList();
    }

    /**
     * Returns optional JVM options for plugin execution.
     *
     * @return a list of JVM options.
     */
    public List getJvmArgs() {
        return jvmArgs != null ? jvmArgs : emptyList();
    }

    public String getJavaHome() {
        return javaHome;
    }

    public void setJavaHome(final String javaHome) {
        this.javaHome = javaHome;
    }

    public String getWinJvmDataModel() {
        return winJvmDataModel;
    }

    public String getPluginName() {
        return "protoc-gen-" + id;
    }

    /**
     * Validate the state of this plugin specification.
     *
     * @param log a logger instance for diagnostic output.
     */
    public void validate(final Log log) {
        if (id == null) {
            throw new MojoConfigurationException("id must be set in protocPlugin definition");
        }
        if (groupId == null) {
            throw new MojoConfigurationException("groupId must be set in protocPlugin definition");
        }
        if (artifactId == null) {
            throw new MojoConfigurationException("artifactId must be set in protocPlugin definition");
        }
        if (version == null) {
            throw new MojoConfigurationException("version must be set in protocPlugin definition");
        }
        if (mainClass == null) {
            throw new MojoConfigurationException("mainClass must be set in protocPlugin definition");
        }
        if (javaHome == null || !new File(javaHome).isDirectory()) {
            throw new MojoConfigurationException("javaHome is invalid: " + javaHome);
        }
        if (Os.isFamily(Os.FAMILY_WINDOWS)) {

            // If winJvmDataModel isn't set explicitly, try to guess the architecture
            // by looking at the directories in the JDK/JRE javaHome points at.
            // If that fails, try to figure out from the currently running JVM.

            if (winJvmDataModel != null) {
                if (!(winJvmDataModel.equals(WIN_JVM_DATA_MODEL_32) || winJvmDataModel.equals(WIN_JVM_DATA_MODEL_64))) {
                    throw new MojoConfigurationException("winJvmDataModel must be '32' or '64'");
                }
            } else if (archDirectoryExists("amd64")) {
                winJvmDataModel = WIN_JVM_DATA_MODEL_64;
                if (log.isDebugEnabled()) {
                    log.debug("detected 64-bit JVM from directory structure");
                }
            } else if (archDirectoryExists("i386")) {
                winJvmDataModel = WIN_JVM_DATA_MODEL_32;
                if (log.isDebugEnabled()) {
                    log.debug("detected 32-bit JVM from directory structure");
                }
            } else if (System.getProperty(DATA_MODEL_SYSPROP) != null) {
                winJvmDataModel = System.getProperty(DATA_MODEL_SYSPROP);
                if (log.isDebugEnabled()) {
                    log.debug("detected " + winJvmDataModel + "-bit JVM from system property " + DATA_MODEL_SYSPROP);
                }
            } else {
                winJvmDataModel = WIN_JVM_DATA_MODEL_32;
                if (log.isDebugEnabled()) {
                    log.debug("defaulting to 32-bit JVM");
                }
            }
        }
    }

    private boolean archDirectoryExists(String arch) {
        return javaHome != null
                && (new File(javaHome, "jre/lib/" + arch).isDirectory()
                || new File(javaHome, "lib/" + arch).isDirectory());
    }

    /**
     * Returns the generated plugin executable path.
     *
     * @param pluginDirectory directory where plugins will be created
     * @return file handle for the plugin executable.
     */
    public File getPluginExecutableFile(final File pluginDirectory) {
        if (Os.isFamily(Os.FAMILY_WINDOWS)) {
            return new File(pluginDirectory, getPluginName() + ".exe");
        } else {
            return new File(pluginDirectory, getPluginName());
        }
    }

    @Override
    public String toString() {
        return "ProtocPlugin{" +
                "id='" + id + '\'' +
                ", groupId='" + groupId + '\'' +
                ", artifactId='" + artifactId + '\'' +
                ", version='" + version + '\'' +
                ", classifier='" + classifier + '\'' +
                ", mainClass='" + mainClass + '\'' +
                ", javaHome='" + javaHome + '\'' +
                ", winJvmDataModel='" + winJvmDataModel + '\'' +
                ", args=" + args +
                ", jvmArgs=" + jvmArgs +
                '}';
    }
}