scala_maven_dependency.CheckScalaVersionVisitor Maven / Gradle / Ivy

Go to download
/*
 * This is free and unencumbered software released into the public domain.
 * See UNLICENSE.
 */
package scala_maven_dependency;

import java.util.ArrayList;
import java.util.List;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.shared.dependency.graph.DependencyNode;
import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
import scala_maven.VersionNumber;
import util.StringUtil;

/**
 * Ensures that all scala versions match the given version.
 *
 * @author JSuereth
 */
public class CheckScalaVersionVisitor implements DependencyNodeVisitor {
  private boolean _failed = false;
  private Log _log;
  private Context _scalaContext;

  private List scalaDependentArtifactStrings = new ArrayList<>();

  @Override
  public boolean endVisit(DependencyNode node) {
    return !_failed;
  }

  public CheckScalaVersionVisitor(Context scalaContext, Log log) {
    this._scalaContext = scalaContext;
    this._log = log;
  }

  @Override
  public boolean visit(DependencyNode node) {
    // TODO - Do we care about provided scope?
    Artifact artifact = node.getArtifact();
    _log.debug("checking [" + artifact + "] for scala version");
    // TODO - Handle version ranges???? does that make sense given scala's binary
    // incompatability!
    try {
      if (_scalaContext.hasInDistro(artifact) && artifact.getVersion() != null) {
        VersionNumber originalVersion = new VersionNumber(artifact.getVersion());
        if (_scalaContext.version().compareTo(originalVersion)
            != 0) { // _version can be a VersionNumberMask
          _failed = true;
        }
        // If this dependency is transitive, we want to track which artifact requires
        // this...
        if (node.getParent()
            != null) { // TODO - Go all the way up the parent chain till we hit the bottom....
          final Artifact parentArtifact = node.getParent().getArtifact();
          scalaDependentArtifactStrings.add(
              " "
                  + StringUtil.makeArtifactNameString(parentArtifact)
                  + " requires scala version: "
                  + originalVersion);
        }
      } else {
        // TODO - What now?
      }
    } catch (Exception exc) {
      _log.warn(exc);
    }
    return !_failed;
  }

  public boolean isFailed() {
    return _failed;
  }

  public void logScalaDependents() {
    _log.warn(" Expected all dependencies to require Scala version: " + _scalaContext.version());
    for (String dependString : scalaDependentArtifactStrings) {
      _log.warn(dependString);
    }
  }
}