io.opentelemetry.contrib.staticinstrumenter.plugin.maven.ProjectModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of static-instrumentation-maven-plugin Show documentation

Maven3 plugin for static instrumentation of projects code and dependencies

There is a newer version: 1.26.0-alpha

Show newest version

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.contrib.staticinstrumenter.plugin.maven;

import java.io.File;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.project.MavenProject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** Contains methods to retrieve all artifacts created in Maven project. */
class ProjectModel {

  private static final Logger logger = LoggerFactory.getLogger(ProjectModel.class);

  private final MavenProject project;

  ProjectModel(MavenProject project) {
    this.project = project;
  }

  /**
   * Returns a list of all Maven project artifacts (attached included) or artifact specified by
   * user.
   */
  List chooseForInstrumentation(@Nullable String artifactName) {

    List allArtifacts = findProjectArtifacts();

    if (artifactName == null) {
      if (logger.isDebugEnabled()) {
        String fileNames = toFileNames(allArtifacts);
        logger.debug(
            "Artifact name not provided. Defaults to instrument all artifacts: {}", fileNames);
      }
      return allArtifacts;
    }

    for (Path artifactFile : allArtifacts) {
      if (artifactName.equals(artifactFile.toFile().getName())) {
        return new ArrayList<>(Collections.singletonList(artifactFile));
      }
    }
    String message =
        "Artifact with name "
            + artifactName
            + " not found. The available artifacts are: "
            + toFileNames(allArtifacts)
            + ". Project artifact: "
            + project.getArtifact()
            + ". "
            + "File of project artifact: "
            + project.getArtifact().getFile();
    throw new IllegalArgumentException(message);
  }

  private static String toFileNames(List paths) {
    return Arrays.toString(paths.stream().map(Path::toFile).map(File::getName).toArray());
  }

  private List findProjectArtifacts() {

    List artifactFiles = new ArrayList<>();

    Artifact artifact = project.getArtifact();
    File file = artifact.getFile();
    if (file != null) {
      artifactFiles.add(file.toPath());
    }

    artifactFiles.addAll(findPathsOfAttachedArtifacts());

    return artifactFiles;
  }

  private List findPathsOfAttachedArtifacts() {
    return project.getAttachedArtifacts().stream()
        .map(Artifact::getFile)
        .map(File::toPath)
        .collect(Collectors.toList());
  }
}