org.apache.maven.plugins.invoker.SelectorUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-invoker-plugin Show documentation
The Maven Invoker Plugin is used to run a set of Maven projects. The plugin can determine whether each project execution is successful, and optionally can verify the output generated from a given project execution.
The newest version!
/*
 * 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 org.apache.maven.plugins.invoker;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import java.util.Properties;
import java.util.stream.Collectors;

import org.apache.maven.plugins.invoker.AbstractInvokerMojo.ToolchainPrivateManager;
import org.apache.maven.project.MavenProject;
import org.apache.maven.toolchain.MisconfiguredToolchainException;
import org.apache.maven.toolchain.ToolchainPrivate;
import org.codehaus.plexus.util.Os;

/**
 * Provides utility methods for selecting build jobs based on environmental conditions.
 *
 * @author Benjamin Bentmann
 */
class SelectorUtils {

    static void parseList(String list, Collection includes, Collection excludes) {
        if (Objects.isNull(list)) {
            return;
        }

        String[] tokens = list.split(",+");

        for (String token1 : tokens) {
            String token = token1.trim();

            if (token.startsWith("!")) {
                excludes.add(token.substring(1));
            } else {
                includes.add(token);
            }
        }
    }

    static boolean isOsFamily(String osSpec) {
        List includes = new ArrayList<>();
        List excludes = new ArrayList<>();
        parseList(osSpec, includes, excludes);

        return isOsFamily(includes, true) && !isOsFamily(excludes, false);
    }

    static boolean isOsFamily(List families, boolean defaultMatch) {
        if (families == null || families.isEmpty()) {
            return defaultMatch;
        }
        return families.stream().anyMatch(Os::isFamily);
    }

    /**
     * Retrieves the current Maven version.
     *
     * @return The current Maven version.
     */
    static String getMavenVersion() {
        try {
            // This relies on the fact that MavenProject is the in core classloader
            // and that the core classloader is for the maven-core artifact
            // and that should have a pom.properties file
            // if this ever changes, we will have to revisit this code.
            Properties properties = new Properties();
            // CHECKSTYLE_OFF: LineLength
            properties.load(MavenProject.class
                    .getClassLoader()
                    .getResourceAsStream("META-INF/maven/org.apache.maven/maven-core/pom.properties"));
            // CHECKSTYLE_ON: LineLength
            String str = properties.getProperty("version");
            return str == null ? null : str.trim();
        } catch (Exception e) {
            return null;
        }
    }

    static String getMavenVersion(File mavenHome) throws IOException {
        File mavenLib = new File(mavenHome, "lib");
        File[] jarFiles = mavenLib.listFiles((dir, name) -> name.endsWith(".jar"));

        if (jarFiles == null) {
            throw new IllegalArgumentException("Invalid Maven home installation directory: " + mavenHome);
        }

        for (File file : jarFiles) {
            try {
                URL url = new URL("jar:" + file.toURI().toURL().toExternalForm()
                        + "!/META-INF/maven/org.apache.maven/maven-core/pom.properties");

                try (InputStream in = url.openStream()) {
                    Properties properties = new Properties();
                    properties.load(in);
                    String str = properties.getProperty("version");
                    String version = str == null ? null : str.trim();
                    if (version != null) {
                        return version;
                    }
                }
            } catch (FileNotFoundException | MalformedURLException e) {
                // ignore
            }
        }
        return null;
    }

    static boolean isMavenVersion(String mavenSpec, String actualVersion) {
        List includes = new ArrayList<>();
        List excludes = new ArrayList<>();
        parseList(mavenSpec, includes, excludes);

        List mavenVersionList = parseVersion(actualVersion);

        return isJreVersion(mavenVersionList, includes, true) && !isJreVersion(mavenVersionList, excludes, false);
    }

    static String getJreVersion() {
        return System.getProperty("java.version", "");
    }

    static boolean isJreVersion(String jreSpec, String actualJreVersion) {
        List includes = new ArrayList<>();
        List excludes = new ArrayList<>();
        parseList(jreSpec, includes, excludes);

        List jreVersion = parseVersion(actualJreVersion);

        return isJreVersion(jreVersion, includes, true) && !isJreVersion(jreVersion, excludes, false);
    }

    static boolean isJreVersion(List jreVersions, List versionPatterns, boolean defaultMatch) {
        if (versionPatterns == null || versionPatterns.isEmpty()) {
            return defaultMatch;
        }

        return versionPatterns.stream().anyMatch(versionPattern -> isJreVersion(jreVersions, versionPattern));
    }

    static boolean isJreVersion(List jreVersions, String versionPattern) {
        List checkVersion = parseVersion(versionPattern);

        if (versionPattern.endsWith("+")) {
            // 1.5+ <=> [1.5,)
            return compareVersions(jreVersions, checkVersion) >= 0;
        } else if (versionPattern.endsWith("-")) {
            // 1.5- <=> (,1.5)
            return compareVersions(jreVersions, checkVersion) < 0;
        } else {
            // 1.5 <=> [1.5,1.6)
            return checkVersion.size() <= jreVersions.size()
                    && checkVersion.equals(jreVersions.subList(0, checkVersion.size()));
        }
    }

    static List parseVersion(String version) {
        version = version.replaceAll("\\D", ".");

        String[] tokens = version.split("\\s*\\.+\\s*");

        return Arrays.stream(tokens)
                .filter(s -> !s.isEmpty())
                .map(Integer::valueOf)
                .collect(Collectors.toList());
    }

    static int compareVersions(List version1, List version2) {
        for (Iterator it1 = version1.iterator(), it2 = version2.iterator(); ; ) {
            if (!it1.hasNext()) {
                return it2.hasNext() ? -1 : 0;
            }
            if (!it2.hasNext()) {
                return it1.hasNext() ? 1 : 0;
            }

            Integer num1 = it1.next();
            Integer num2 = it2.next();

            int rel = num1.compareTo(num2);
            if (rel != 0) {
                return rel;
            }
        }
    }

    /**
     * @param toolchainPrivateManager
     * @param invokerToolchains
     * @return {@code true} if all invokerToolchains are available, otherwise {@code false}
     */
    static boolean isToolchain(
            ToolchainPrivateManager toolchainPrivateManager, Collection invokerToolchains) {
        for (InvokerToolchain invokerToolchain : invokerToolchains) {
            boolean found = false;
            try {
                for (ToolchainPrivate tc : toolchainPrivateManager.getToolchainPrivates(invokerToolchain.getType())) {
                    if (!invokerToolchain.getType().equals(tc.getType())) {
                        // useful because of MNG-5716
                        continue;
                    }

                    if (tc.matchesRequirements(invokerToolchain.getProvides())) {
                        found = true;
                        continue;
                    }
                }
            } catch (MisconfiguredToolchainException e) {
                return false;
            }

            if (!found) {
                return false;
            }
        }

        return true;
    }
}