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

Go to download
/*
 * 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.base.Preconditions.checkArgument;

import com.google.cloud.tools.opensource.dependencies.Artifacts;
import com.google.cloud.tools.opensource.dependencies.DependencyPath;
import com.google.cloud.tools.opensource.dependencies.UnresolvableArtifactProblem;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.LinkedListMultimap;
import com.google.common.collect.ListMultimap;
import java.io.IOException;
import org.eclipse.aether.artifact.Artifact;

/** Result of class path resolution with {@link UnresolvableArtifactProblem}s if any. */
public final class ClassPathResult {

  private final ImmutableList classPath;

  /**
   * An ordered map from class path elements to one or more Maven dependency paths.
   *
   * The keys of the returned map represent Maven artifacts in the resolved class path,
   * including transitive dependencies. The return value of {@link LinkedListMultimap#keySet()}
   * preserves key iteration order.
   *
   * The values of the returned map for a key (class path entry) represent the different Maven
   * dependency paths from {@code artifacts} to the Maven artifact.
   */
  private final ImmutableListMultimap dependencyPaths;

  private final ImmutableList artifactProblems;

  public ClassPathResult(
      ListMultimap dependencyPaths,
      Iterable artifactProblems) {
    this.dependencyPaths = ImmutableListMultimap.copyOf(dependencyPaths);
    this.classPath = ImmutableList.copyOf(dependencyPaths.keySet());
    this.artifactProblems = ImmutableList.copyOf(artifactProblems);
  }

  /** Returns the resolved class path. */
  public ImmutableList getClassPath() {
    return classPath;
  }

  /**
   * Returns all paths to the class path entry or 
   * an empty list if the entry is not in the class path.
   */
  public ImmutableList getDependencyPaths(ClassPathEntry entry) {
    return dependencyPaths.get(entry);
  }

  /** Returns problems encountered while constructing the dependency graph. */
  public ImmutableList getArtifactProblems() {
    return artifactProblems;
  }

  /** Returns text describing dependency paths to class path entries in the dependency tree. */
  public String formatDependencyPaths(Iterable entries) {
    StringBuilder message = new StringBuilder();
    for (ClassPathEntry entry : entries) {
      ImmutableList dependencyPaths = getDependencyPaths(entry);
      checkArgument(dependencyPaths.size() >= 1, "%s is not in the class path", entry);

      message.append(entry + " is at:\n");

      int otherCount = dependencyPaths.size() - 1;
      message.append("  " + dependencyPaths.get(0) + "\n");
      if (otherCount == 1) {
        message.append("  and 1 dependency path.\n");
      } else if (otherCount > 1) {
        message.append("  and " + otherCount + " other dependency paths.\n");
      }
    }
    return message.toString();
  }
  
  /**
   * Returns the classpath entries for the transitive dependencies of the specified
   * artifact.
   */
  public ImmutableSet getClassPathEntries(String coordinates) {
    ImmutableSet.Builder builder = ImmutableSet.builder();
    for (ClassPathEntry entry : classPath) {
      for (DependencyPath dependencyPath : dependencyPaths.get(entry)) {
        if (dependencyPath.size() > 1) {
          Artifact artifact = dependencyPath.get(1);
          if (Artifacts.toCoordinates(artifact).equals(coordinates)) {
            builder.add(entry);
          }
        }
      }
    }
    return builder.build();
  }

  /**
   * Returns the class path entry for the artifact that matches {@code groupId} and {@code
   * artifactId}. {@code Null} if no matching artifact is found.
   */
  ClassPathEntry findEntryById(String groupId, String artifactId) {
    for (ClassPathEntry entry : getClassPath()) {
      Artifact artifact = entry.getArtifact();
      if (artifact.getGroupId().equals(groupId) && artifact.getArtifactId().equals(artifactId)) {
        return entry;
      }
    }
    return null;
  }

  /**
   * Returns the class path entry that contains the class of {@code symbol}. {@code Null} if no
   * matching entry is found.
   */
  ClassPathEntry findEntryBySymbol(Symbol symbol) throws IOException {
    String className = symbol.getClassBinaryName();
    for (ClassPathEntry entry : getClassPath()) {
      if (entry.getFileNames().contains(className)) {
        return entry;
      }
    }
    return null;
  }
}