All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.hubspot.singularity.helpers.ImageName Maven / Gradle / Ivy

package com.hubspot.singularity.helpers;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Helper class for parsing docker repository/image names:
 */
public class ImageName {
  private static final String NAME_COMPONENT_REGEXP =
    "[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?";

  private static final String DOMAIN_COMPONENT_REGEXP =
    "(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])";

  private static final Pattern NAME_COMP_REGEXP = Pattern.compile(NAME_COMPONENT_REGEXP);

  private static final Pattern IMAGE_NAME_REGEXP = Pattern.compile(
    NAME_COMPONENT_REGEXP + "(?:(?:/" + NAME_COMPONENT_REGEXP + ")+)?"
  );

  private final Pattern DOMAIN_REGEXP = Pattern.compile(
    "^" + DOMAIN_COMPONENT_REGEXP + "(?:\\." + DOMAIN_COMPONENT_REGEXP + ")*(?::[0-9]+)?$"
  );

  private final Pattern TAG_REGEXP = Pattern.compile("^[\\w][\\w.-]{0,127}$");

  private final Pattern DIGEST_REGEXP = Pattern.compile("^sha256:[a-z0-9]{32,}$");

  private String repository;
  private String registry;
  private String tag;
  private String digest;
  private String user;

  /**
   * Create an image name
   *
   * @param fullName The fullname of the image in Docker format.
   */
  public ImageName(String fullName) {
    this(fullName, null);
  }

  /**
   * Create an image name with a tag. If a tag is provided (i.e. is not null) then this tag is used.
   * Otherwise the tag of the provided name is used (if any).
   *
   * @param fullName The fullname of the image in Docker format. I
   * @param givenTag tag to use. Can be null in which case the tag specified in fullName is used.
   */
  public ImageName(String fullName, String givenTag) {
    if (fullName == null) {
      throw new NullPointerException("Image name must not be null");
    }

    // set digest to null as default
    digest = null;
    // check if digest is part of fullName, if so -> extract it
    if (fullName.contains("@sha256")) { // Of it contains digest
      String[] digestParts = fullName.split("@");
      digest = digestParts[1];
      fullName = digestParts[0];
    }

    // check for tag
    Pattern tagPattern = Pattern.compile("^(.+?)(?::([^:/]+))?$");
    Matcher matcher = tagPattern.matcher(fullName);
    if (!matcher.matches()) {
      throw new IllegalArgumentException(
        fullName + " is not a proper image name ([registry/][repo][:port]"
      );
    }
    // extract tag if it exists
    tag = givenTag != null ? givenTag : matcher.group(2);
    String rest = matcher.group(1);

    // extract registry, repository, user
    parseComponentsBeforeTag(rest);

    /*
     * set tag to latest if tag AND digest are null
     * if digest is not null but tag is -> leave it!
     *  -> in case of "image_name@sha256" it is not required to get resolved to "latest"
     */
    if (tag == null && digest == null) {
      tag = "latest";
    }

    doValidate();
  }

  public String getRepository() {
    return repository;
  }

  public String getRegistry() {
    return registry;
  }

  public String getTag() {
    return tag;
  }

  public String getDigest() {
    return digest;
  }

  public boolean hasRegistry() {
    return registry != null && registry.length() > 0;
  }

  private String joinTail(String[] parts) {
    StringBuilder builder = new StringBuilder();
    for (int i = 1; i < parts.length; i++) {
      builder.append(parts[i]);
      if (i < parts.length - 1) {
        builder.append("/");
      }
    }
    return builder.toString();
  }

  private boolean isRegistry(String part) {
    return part.contains(".") || part.contains(":");
  }

  /**
   * Get the full name of this image, including the registry but without
   * any tag (e.g. privateregistry:fabric8io/java)
   *
   * @return full name with the original registry
   */
  public String getNameWithoutTag() {
    return getNameWithoutTag(null);
  }

  /**
   * Get the full name of this image like {@link #getNameWithoutTag()} does, but allow
   * an optional registry. This registry is used when this image does not already
   * contain a registry.
   *
   * @param optionalRegistry optional registry to use when this image does not provide
   *                         a registry. Can be null in which case no optional registry is used*
   * @return full name with original registry (if set) or optional registry (if not null)
   */
  public String getNameWithoutTag(String optionalRegistry) {
    StringBuilder ret = new StringBuilder();
    if (registry != null || optionalRegistry != null) {
      ret.append(registry != null ? registry : optionalRegistry).append("/");
    }
    ret.append(repository);
    return ret.toString();
  }

  /**
   * Get the full name of this image, including the registry and tag
   * (e.g. privateregistry:fabric8io/java:7u53)
   *
   * @return full name with the original registry and the original tag given (if any).
   */
  public String getFullName() {
    return getFullName(null);
  }

  /**
   * Get the full name of this image like {@link #getFullName(String)} does, but allow
   * an optional registry. This registry is used when this image does not already
   * contain a registry. If no tag was provided in the initial name, latest is used.
   *
   * @param optionalRegistry optional registry to use when this image does not provide
   *                         a registry. Can be null in which case no optional registry is used*
   * @return full name with original registry (if set) or optional registry (if not null).
   */
  public String getFullName(String optionalRegistry) {
    String fullName = getNameWithoutTag(optionalRegistry);
    if (tag != null) {
      fullName = fullName + ":" + tag;
    }
    if (digest != null) {
      fullName = fullName + "@" + digest;
    }
    return fullName;
  }

  /**
   * Get the user (or "project") part of the image name. This is the part after the registry and before
   * the image name
   *
   * @return user part or null if no user is present in the name
   */
  public String getUser() {
    return user;
  }

  /**
   * Get the simple name of the image, which is the repository sans the user parts.
   *
   * @return simple name of the image
   */
  public String getSimpleName() {
    String prefix = user + "/";
    return repository.startsWith(prefix)
      ? repository.substring(prefix.length())
      : repository;
  }

  // Validate parts and throw an IllegalArgumentException if a part is not valid
  private void doValidate() {
    List errors = new ArrayList<>();
    // Strip off user from repository name
    String image = user != null ? repository.substring(user.length() + 1) : repository;
    Object[] checks = new Object[] {
      "registry",
      DOMAIN_REGEXP,
      registry,
      "image",
      IMAGE_NAME_REGEXP,
      image,
      "user",
      NAME_COMP_REGEXP,
      user,
      "tag",
      TAG_REGEXP,
      tag,
      "digest",
      DIGEST_REGEXP,
      digest
    };
    for (int i = 0; i < checks.length; i += 3) {
      String value = (String) checks[i + 2];
      Pattern checkPattern = (Pattern) checks[i + 1];
      if (value != null && !checkPattern.matcher(value).matches()) {
        errors.add(
          String.format(
            "%s part '%s' doesn't match allowed pattern '%s'",
            checks[i],
            value,
            checkPattern.pattern()
          )
        );
      }
    }
    if (errors.size() > 0) {
      StringBuilder buf = new StringBuilder();
      buf.append(String.format("Given Docker name '%s' is invalid:", getFullName()));
      buf.append("\n");
      for (String error : errors) {
        buf.append(String.format("   * %s", error));
        buf.append("\n");
      }
      buf.append("See http://bit.ly/docker_image_fmt for more details");
      throw new IllegalArgumentException(buf.toString());
    }
  }

  private void parseComponentsBeforeTag(String rest) {
    String[] parts = rest.split("\\s*/\\s*");
    if (parts.length == 1) {
      registry = null;
      user = null;
      repository = parts[0];
    } else if (parts.length >= 2) {
      if (isRegistry(parts[0])) {
        registry = parts[0];
        if (parts.length > 2) {
          user = parts[1];
          repository = joinTail(parts);
        } else {
          user = null;
          repository = parts[1];
        }
      } else {
        registry = null;
        user = parts[0];
        repository = rest;
      }
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy