quay/static/js/services/dockerfile/dockerfile.service.ts

/**
 * Service which provides helper methods for extracting information out from a Dockerfile
 * or an archive containing a Dockerfile.
 */
export abstract class DockerfileService {

  /**
   * Retrieve Dockerfile from given file.
   * @param file Dockerfile or archive file containing Dockerfile.
   * @param success Success callback with retrieved Dockerfile as parameter.
   * @param failure Failure callback with failure message as parameter.
   */
  public abstract getDockerfile(file: any,
                                success: (dockerfile: DockerfileInfo) => void,
                                failure: (error: ErrorEvent | string) => void): void;

  /**
   * Retrieve Dockerfile from given file.
   * @param file Dockerfile or archive file containing Dockerfile.
   * @return promise Promise resolving to new DockerfileInfo instance or rejecting to error message.
   */
  public abstract extractDockerfile(file: any): Promise<DockerfileInfo | string>;
}


/**
 * Model representing information about a specific Dockerfile.
 */
export abstract class DockerfileInfo {

  /**
   * Extract the registry base image from the Dockerfile contents.
   * @return registryBaseImage The registry base image.
   */
  public abstract getRegistryBaseImage(): string | null;

  /**
   * Extract the base image from the Dockerfile contents.
   * @return baseImage The base image.
   */
  public abstract getBaseImage(): string | null;

  /**
   * Extract the base image and tag from the Dockerfile contents.
   * @return baseImageAndTag The base image and tag.
   */
  public abstract getBaseImageAndTag(): string | null;
}