• Home
• com.google.cloud.tools
• dependencies
• 1.5.12
• source code
• GradleDependencyMediation.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.tools.opensource.classpath.GradleDependencyMediation Maven / Gradle / Ivy

/*
 * Copyright 2020 Google LLC.
 *
 * 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 com.google.cloud.tools.opensource.classpath;

import static com.google.common.collect.ImmutableList.toImmutableList;

import com.google.cloud.tools.opensource.dependencies.Artifacts;
import com.google.cloud.tools.opensource.dependencies.Bom;
import com.google.cloud.tools.opensource.dependencies.DependencyGraph;
import com.google.cloud.tools.opensource.dependencies.DependencyPath;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.util.version.GenericVersionScheme;
import org.eclipse.aether.version.InvalidVersionSpecificationException;
import org.eclipse.aether.version.Version;

/**
 * Retain only the highest version of a groupId:artifactId encountered. When you want to pin
 * versions for the artifacts in a BOM, use {@link #withEnforcedPlatform(Bom)}.
 */
public class GradleDependencyMediation implements DependencyMediation {

  // Mapping from versionless coordinates to versions
  private final ImmutableMap enforcedPlatform;

  // Not public. Use DependencyMediation.GRADLE instead.
  GradleDependencyMediation() {
    enforcedPlatform = ImmutableMap.of();
  }

  private GradleDependencyMediation(Bom enforcedPlatform) {
    this.enforcedPlatform =
        enforcedPlatform.getManagedDependencies().stream()
            .collect(ImmutableMap.toImmutableMap(Artifacts::makeKey, Artifact::getVersion));
  }

  /** Uses {@code enforcedPlatform} BOM when choosing versions. */
  public static GradleDependencyMediation withEnforcedPlatform(Bom enforcedPlatform) {
    return new GradleDependencyMediation(enforcedPlatform);
  }

  @Override
  public AnnotatedClassPath mediate(DependencyGraph dependencyGraph)
      throws InvalidVersionSpecificationException {

    AnnotatedClassPath annotatedClassPath = new AnnotatedClassPath();

    List dependencyPaths = dependencyGraph.list();

    // Step 1: Gather versions in the dependency graph.
    HashMultimap coordinatesToVersions = HashMultimap.create();
    GenericVersionScheme versionScheme = new GenericVersionScheme();
    for (DependencyPath dependencyPath : dependencyPaths) {
      Artifact artifact = dependencyPath.getLeaf();
      String versionlessCoordinates = Artifacts.makeKey(artifact);
      Version version = versionScheme.parseVersion(artifact.getVersion());
      coordinatesToVersions.put(versionlessCoordinates, version);
    }

    // Step 2: Select the highest version or the version in the enforcedPlatform for each
    // versionless coordinates.
    List selectedCoordinates = new ArrayList<>();
    for (String versionlessCoordinates : coordinatesToVersions.keySet()) {
      if (enforcedPlatform.containsKey(versionlessCoordinates)) {
        String versionInEnforcedPlatform = enforcedPlatform.get(versionlessCoordinates);
        selectedCoordinates.add(versionlessCoordinates + ":" + versionInEnforcedPlatform);
      } else {
        ImmutableList versions =
            coordinatesToVersions.get(versionlessCoordinates).stream()
                .sorted()
                .collect(toImmutableList());
        Version highestVersion = versions.get(versions.size() - 1);
        selectedCoordinates.add(versionlessCoordinates + ":" + highestVersion.toString());
      }
    }

    // Step 3: Build annotated class path.
    for (DependencyPath dependencyPath : dependencyPaths) {
      Artifact artifact = dependencyPath.getLeaf();
      if (selectedCoordinates.contains(Artifacts.toCoordinates(artifact))
          && artifact.getFile() != null) {
        // If artifact's file is null, it means there was a problem in downloading the artifact.
        // Such failure information is recorded in dependencyGraph's artifactProblems.
        annotatedClassPath.put(new ClassPathEntry(artifact), dependencyPath);
      }
    }

    return annotatedClassPath;
  }
}