org.eclipse.jkube.kit.build.api.helper

Class DockerFileUtil

java.lang.Object

org.eclipse.jkube.kit.build.api.helper.DockerFileUtil

public class DockerFileUtil
extends Object

Utility class for dealing with dockerfiles

Since:

21/01/16

Author:

roland

Method Summary

Modifier and Type	Method and Description
static ImageConfiguration	addSimpleDockerfileConfig(ImageConfiguration image, File dockerfile)
static ImageConfiguration	createSimpleDockerfileConfig(File dockerFile, String defaultImageName)
static Map<String,String>	extractArgs(File dockerfile, Properties properties, String filter, Map<String,String> argsFromBuildConfig) Extract Args from dockerfile.
protected static Map<String,String>	extractArgsFromLines(List<String[]> argLines, Map<String,String> argsFromBuildConfig) Helper method for extractArgs(exposed for test)
static List<String>	extractBaseImages(File dockerFile, Properties properties, String filter, Map<String,String> argsFromBuildConfig) Extract the base images from a dockerfile.
static List<String[]>	extractLines(File dockerFile, String keyword, Properties properties, String filter) Extract all lines containing the given keyword
static File	getTopLevelDockerfile(File projectBaseDirectory)
static String	interpolate(File dockerFile, Properties properties, String filter) Interpolate a docker file with the given properties and filter
static boolean	isSimpleDockerFileMode(File projectBaseDirectory)
static com.google.gson.JsonObject	readDockerConfig()

Methods inherited from class java.lang.Object

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

Method Detail

extractBaseImages

public static List<String> extractBaseImages(File dockerFile,
                                             Properties properties,
                                             String filter,
                                             Map<String,String> argsFromBuildConfig)
                                      throws IOException

Extract the base images from a dockerfile. All lines containing a FROM is taken.

Parameters:

dockerFile - file from where to extract the base image.

properties - properties to interpolate in the provided dockerFile.

filter - string representing filter parameters for properties in dockerfile

argsFromBuildConfig - Docker Build args received from Build Configuration

Returns:

LinkedList of base images name or empty collection if none is found.

Throws:

IOException - if there's a problem while performing IO operations.

extractArgs

public static Map<String,String> extractArgs(File dockerfile,
                                             Properties properties,
                                             String filter,
                                             Map<String,String> argsFromBuildConfig)
                                      throws IOException

Extract Args from dockerfile. All lines containing ARG is taken.

Parameters:

dockerfile - Docker File

properties - properties

filter - interpolation filter

argsFromBuildConfig - Docker build args from Build Configuration

Returns:

HashMap of arguments or empty collection if none is found

Throws:

IOException

extractLines

public static List<String[]> extractLines(File dockerFile,
                                          String keyword,
                                          Properties properties,
                                          String filter)
                                   throws IOException

Extract all lines containing the given keyword

Parameters:

dockerFile - dockerfile to examine.

keyword - keyword to extract the lines for.

properties - properties to interpolate in the provided dockerFile.

filter - string representing filter parameters for properties in dockerfile

Returns:

list of matched lines or an empty list.

Throws:

IOException

interpolate

public static String interpolate(File dockerFile,
                                 Properties properties,
                                 String filter)
                          throws IOException

Interpolate a docker file with the given properties and filter

Parameters:

dockerFile - docker file to interpolate.

properties - properties to interpolate in the provided dockerFile.

filter - filter for parsing properties from Dockerfile

Returns:

The interpolated contents of the file.

Throws:

IOException - if there's a problem while performing IO operations.

extractArgsFromLines

protected static Map<String,String> extractArgsFromLines(List<String[]> argLines,
                                                         Map<String,String> argsFromBuildConfig)

Helper method for extractArgs(exposed for test)

Parameters:

argLines - list of string arrays containing lines with words

argsFromBuildConfig - Docker build args from Build Configuration

Returns:

map of parsed arguments

readDockerConfig

public static com.google.gson.JsonObject readDockerConfig()

isSimpleDockerFileMode

public static boolean isSimpleDockerFileMode(File projectBaseDirectory)

getTopLevelDockerfile

public static File getTopLevelDockerfile(File projectBaseDirectory)

createSimpleDockerfileConfig

public static ImageConfiguration createSimpleDockerfileConfig(File dockerFile,
                                                              String defaultImageName)

addSimpleDockerfileConfig

public static ImageConfiguration addSimpleDockerfileConfig(ImageConfiguration image,
                                                           File dockerfile)