org.jfrog.build.extractor.docker

Class DockerUtils

java.lang.Object

org.jfrog.build.extractor.docker.DockerUtils

public class DockerUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerUtils.CommandType

Constructor Summary

Constructors

Constructor and Description
DockerUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	calculateModuleId(java.lang.String imageTag, java.lang.String targetRepo) Calculate the module ID from the image tag and the target repository.
static java.lang.String	digestToFileName(java.lang.String digest) Digest format to layer file name.
static void	downloadMarkerLayer(java.lang.String repo, java.lang.String imageName, java.lang.String imageDigests, org.jfrog.build.extractor.clientConfiguration.client.artifactory.ArtifactoryManager artifactoryManager) Download meta data from .marker layer in Artifactory.
static java.lang.String	fileNameToDigest(java.lang.String fileName) Layer file name to digest format.
static java.util.List<java.lang.String>	getArtManifestPath(java.lang.String imagePath, java.lang.String repo, DockerUtils.CommandType cmd)
static java.lang.String	getConfigDigest(java.lang.String manifest) Get config digest from manifest (image id).
static java.lang.String	getImageDigestFromFatManifest(java.lang.String manifest, java.lang.String os, java.lang.String arch) Get the digest from fat-manifest according to os and arch.
static java.lang.String	getImagePath(java.lang.String imageTag) Parse imageTag and get the relative path of the pushed image.
static java.util.List<java.lang.String>	getLayersDigests(java.lang.String manifestContent) Get a list of layer digests from docker manifest.
static int	getNumberOfDependentLayers(java.lang.String imageContent) Returns number of dependencies layers in the image.
static java.lang.String	getShaValue(java.lang.String digest) Get sha value from digest.
static java.lang.String	getShaVersion(java.lang.String digest) Get sha value from digest.
static java.lang.Boolean	isImageVersioned(java.lang.String imageTag) Check for the version in docker image tag (used in Jenkins).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockerUtils

public DockerUtils()

Method Detail

getConfigDigest

public static java.lang.String getConfigDigest(java.lang.String manifest)
                                        throws java.io.IOException

Get config digest from manifest (image id).

Throws:

java.io.IOException

getImageDigestFromFatManifest

public static java.lang.String getImageDigestFromFatManifest(java.lang.String manifest,
                                                             java.lang.String os,
                                                             java.lang.String arch)
                                                      throws java.io.IOException

Get the digest from fat-manifest according to os and arch.

Parameters:

manifest - - fat-manifest.

os - - image os to search.

arch - - arch to search.

Returns:

digest related to os and arch. If not found return an empty string.

Throws:

java.io.IOException - fat-manifest has missing 'manifest' key.

getLayersDigests

public static java.util.List<java.lang.String> getLayersDigests(java.lang.String manifestContent)
                                                         throws java.io.IOException

Get a list of layer digests from docker manifest.

Throws:

java.io.IOException

getShaVersion

public static java.lang.String getShaVersion(java.lang.String digest)

Get sha value from digest. example: sha256:abcabcabc12334 the value is sha256.

getShaValue

public static java.lang.String getShaValue(java.lang.String digest)

Get sha value from digest. example: sha256:abcabcabc12334 the value is abcabcabc12334.

digestToFileName

public static java.lang.String digestToFileName(java.lang.String digest)

Digest format to layer file name.

getNumberOfDependentLayers

public static int getNumberOfDependentLayers(java.lang.String imageContent)
                                      throws java.io.IOException

Returns number of dependencies layers in the image.

Throws:

java.io.IOException

fileNameToDigest

public static java.lang.String fileNameToDigest(java.lang.String fileName)

Layer file name to digest format.

getImagePath

public static java.lang.String getImagePath(java.lang.String imageTag)

Parse imageTag and get the relative path of the pushed image. example: url:8081/image:version to image/version.

isImageVersioned

public static java.lang.Boolean isImageVersioned(java.lang.String imageTag)

Check for the version in docker image tag (used in Jenkins).

downloadMarkerLayer

public static void downloadMarkerLayer(java.lang.String repo,
                                       java.lang.String imageName,
                                       java.lang.String imageDigests,
                                       org.jfrog.build.extractor.clientConfiguration.client.artifactory.ArtifactoryManager artifactoryManager)
                                throws java.io.IOException

Download meta data from .marker layer in Artifactory. As a result, the marker layer will transform to a regular docker layer (required to collect build info such as sha1, etc.).

Parameters:

repo - - Repository from which to download the layer

imageName - - Image name to download

imageDigests - - image digest to download

artifactoryManager - - Artifactory Manager

Throws:

java.io.IOException

getArtManifestPath

public static java.util.List<java.lang.String> getArtManifestPath(java.lang.String imagePath,
                                                                  java.lang.String repo,
                                                                  DockerUtils.CommandType cmd)

Parameters:

imagePath - - path to an image in artifactory without proxy e.g. hello-world/latest.

repo - - The repository to use for searching.

cmd - - docker push cmd/ docker pull cmd.

Returns:

All possible paths in Artifactory in order to find image manifest using proxy.

calculateModuleId

public static java.lang.String calculateModuleId(java.lang.String imageTag,
                                                 java.lang.String targetRepo)

Calculate the module ID from the image tag and the target repository.

Parameters:

imageTag - - The image tag

targetRepo - - The target repository

Returns:

the module ID.