io.streamnative.dependencies.DependencyVersionMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extra-enforcer-rules Show documentation
Custom Extra Enforcer Rules For SN BOM.
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 io.streamnative.dependencies;

import io.streamnative.utils.ArtifactUtils;
import io.streamnative.utils.ParentNodeProvider;
import io.streamnative.utils.ParentsVisitor;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.graph.DependencyNode;
import org.eclipse.aether.graph.DependencyVisitor;

/**
 * @author Brian Fox
 */
class DependencyVersionMap implements DependencyVisitor, ParentNodeProvider {
    private ParentsVisitor parentsVisitor;
    private boolean uniqueVersions;
    private final Map> idsToNode = new HashMap<>();

    DependencyVersionMap() {
        this.parentsVisitor = new ParentsVisitor();
    }

    public DependencyVersionMap setUniqueVersions(boolean uniqueVersions) {
        this.uniqueVersions = uniqueVersions;
        return this;
    }

    @Override
    public boolean visitEnter(DependencyNode node) {
        addDependency(node);
        return parentsVisitor.visitEnter(node) && !containsConflicts(node);
    }

    @Override
    public boolean visitLeave(DependencyNode node) {
        return parentsVisitor.visitLeave(node);
    }

    @Override
    public DependencyNode getParent(DependencyNode node) {
        return parentsVisitor.getParent(node);
    }

    private String constructKey(DependencyNode node) {
        return constructKey(node.getArtifact());
    }

    private String constructKey(Artifact artifact) {
        return artifact.getGroupId() + ":" + artifact.getArtifactId();
    }

    public void addDependency(DependencyNode node) {
        String key = constructKey(node);
        idsToNode.computeIfAbsent(key, k -> new ArrayList<>()).add(node);
    }

    private String getVersion(Artifact artifact) {
        return uniqueVersions ? artifact.getVersion() : artifact.getBaseVersion();
    }

    private boolean containsConflicts(DependencyNode node) {
        return containsConflicts(node.getArtifact());
    }

    private boolean containsConflicts(Artifact artifact) {
        return containsConflicts(idsToNode.get(constructKey(artifact)));
    }

    private boolean containsConflicts(List nodes) {
        String version = null;
        for (DependencyNode node : nodes) {
            if (version == null) {
                version = getVersion(node.getArtifact());
            } else {
                if (version.compareTo(getVersion(node.getArtifact())) != 0) {
                    return true;
                }
            }
        }
        return false;
    }

    public List> getConflictedVersionNumbers(List includes, List excludes) {
        List> output = new ArrayList<>();
        for (List nodes : idsToNode.values()) {
            if (containsConflicts(nodes)) {
                output.add(nodes);
            }
        }
        return output;
    }

    private static boolean includeArtifact(DependencyNode node, List includes, List excludes) {
        boolean included = includes == null || includes.isEmpty();
        if (!included) {
            for (String pattern : includes) {
                if (ArtifactUtils.compareDependency(pattern, ArtifactUtils.toArtifact(node))) {
                    included = true;
                    break;
                }
            }
        }
        if (!included) {
            return false;
        }
        boolean excluded = false;
        if (excludes != null) {
            for (String pattern : excludes) {
                if (ArtifactUtils.compareDependency(pattern, ArtifactUtils.toArtifact(node))) {
                    excluded = true;
                    break;
                }
            }
        }
        return !excluded;
    }

    private static List formatPatterns(List patterns) {
        if (patterns == null) {
            return null;
        }
        List formattedPatterns = new ArrayList<>();
        for (String pattern : patterns) {
            String[] subStrings = pattern.split(":");
            subStrings = StringUtils.stripAll(subStrings);
            String formattedPattern = StringUtils.join(subStrings, ":");
            formattedPatterns.add(formattedPattern);
        }
        return formattedPatterns;
    }
}