pl.allegro.tdr.gruntmaven.AbstractExecutableMojo Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 original author or authors.
 *
 * 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.
 */
package pl.allegro.tdr.gruntmaven;

import pl.allegro.tdr.gruntmaven.executable.Executable;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Parameter;
import static org.twdata.maven.mojoexecutor.MojoExecutor.*;

/**
 * Abstract mojo which uses MojoExecutor to execute exec-maven-plugin,
 * which in turn executes system command - command line only.
 *
 * Compatible with Windows via
 * cmd /C.
 *
 * @author Adam Dubiel
 */
public abstract class AbstractExecutableMojo extends BaseMavenGruntMojo {

    /**
     * Windows OS name.
     */
    private static final String WINDOWS_OS_FAMILY = "Windows";

    /**
     * Maven executor plugin group id.
     */
    private static final String EXEC_MAVEN_GROUP = "org.codehaus.mojo";

    /**
     * Maven executor plugin artifact id.
     */
    private static final String EXEC_MAVEN_ARTIFACT = "exec-maven-plugin";

    /**
     * Maven executor plugin goal.
     */
    private static final String EXEC_GOAL = "exec";

    private static final String EXEC_SUCCESS_CODES_ELEMENT = "successCodes";

    private static final String EXEC_SUCCESS_CODE_ELEMENT = "successCode";

    /**
     * Inject building OS name.
     */
    @Parameter(defaultValue = "${os.name}")
    private String osName;

    /**
     * Should npm/grunt print colors in output (default to false).
     */
    @Parameter(property = "showColors", defaultValue = "false")
    protected boolean showColors;

    /**
     * Version of exec plugin to use (defaults to 1.2.1).
     */
    @Parameter(property = "execMavenPluginVersion", defaultValue = "1.2.1")
    protected String execMavenPluginVersion;

    @Override
    public void executeInternal() throws MojoExecutionException, MojoFailureException {
        for (Executable executable : getExecutables()) {
            runExecutable(executable);
        }
    }

    private void runExecutable(Executable executable) throws MojoExecutionException, MojoFailureException {
        Element[] configuration = buildConfigForOS(executable);
        if (executable.overrideSuccessCodes()) {
            Element customSuccessCodes = overwriteSuccessCodes(executable);
            configuration = concat(configuration, customSuccessCodes);
        }

        executeMojo(plugin(
                groupId(EXEC_MAVEN_GROUP),
                artifactId(EXEC_MAVEN_ARTIFACT),
                version(execMavenPluginVersion)),
                goal(EXEC_GOAL),
                configuration(configuration),
                pluginExecutionEnvironment());
    }

    /**
     * Create
     * configuration element for host OS.
     *
     * @return configuration element
     */
    private Element[] buildConfigForOS(Executable executable) {
        Element[] configuration;

        getLog().info("OS Name: " + osName);

        if (osName.toUpperCase().contains(WINDOWS_OS_FAMILY.toUpperCase())) {
            configuration = buildConfigForWindows(executable);
        } else {
            configuration = buildConfigForProperOS(executable);
        }

        configuration = concat(configuration, new Element[]{element(name("workingDirectory"), gruntBuildDirectory)});

        if (executable.hasEnvironmentVars()) {
            configuration = concat(configuration, element("environmentVariables", elementsFromMap(executable.environmentVars())));
        }

        return configuration;
    }

    /**
     * Create
     * configuration element for proper *nix OSes.
     *
     * @return configuration
     */
    private Element[] buildConfigForProperOS(Executable executable) {
        Element[] osConfiguration = new Element[]{
            element(name("executable"), executable.executableName()),
            element(name("arguments"), executable.argumentsArray())
        };

        return osConfiguration;
    }

    /**
     * Create
     * configuration element for strange Windows OS.
     *
     * @return configuration
     */
    private Element[] buildConfigForWindows(Executable executable) {
        Element[] arguments = new Element[]{
            element(name("argument"), "/C"),
            element(name("argument"), executable.executableName())
        };
        arguments = concat(arguments, executable.argumentsArray());

        Element[] osConfiguration = new Element[]{
            element(name("executable"), "cmd"),
            element(name("arguments"), arguments)
        };

        return osConfiguration;
    }

    /**
     * Don't want to use any dependencies like Apache Commons - sorry.
     *
     * @param     type of array entries
     * @param array1 first array
     * @param array2 second array
     * @return first array + second array
     */
    protected  T[] concat(T[] array1, T... array2) {
        T[] result = Arrays.copyOf(array1, array1.length + array2.length);
        System.arraycopy(array2, 0, result, array1.length, array2.length);
        return result;
    }

    private Element[] elementsFromMap(Map elements) {
        List elementList = new ArrayList();
        for (Map.Entry entry : elements.entrySet()) {
            elementList.add(element(entry.getKey(), entry.getValue()));
        }

        return elementList.toArray(new Element[elementList.size()]);
    }

    /**
     * Return executable form maven exec
     * executable element, return
     * executable name for *nix OS, not Windows!
     *
     * @return executable name
     */
    protected abstract List getExecutables();

    private Element overwriteSuccessCodes(Executable executable) {
        Element[] successCodesElements = new Element[executable.successCodes().length];
        for (int index = 0; index < executable.successCodes().length; ++index) {
            successCodesElements[index] = element(EXEC_SUCCESS_CODE_ELEMENT, executable.successCodes()[index]);
        }
        return element(EXEC_SUCCESS_CODES_ELEMENT, successCodesElements);
    }
}