Package software.xdev.testcontainers.imagebuilder

Class AdvancedImageFromDockerFile

java.lang.Object

org.testcontainers.utility.LazyFuture<String>

software.xdev.testcontainers.imagebuilder.AdvancedImageFromDockerFile

All Implemented Interfaces:

Future<String>, org.testcontainers.images.builder.traits.BuildContextBuilderTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.ClasspathTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.DockerfileTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.FilesTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.StringsTrait<AdvancedImageFromDockerFile>

public class AdvancedImageFromDockerFile
extends org.testcontainers.utility.LazyFuture<String>
implements org.testcontainers.images.builder.traits.BuildContextBuilderTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.ClasspathTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.FilesTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.StringsTrait<AdvancedImageFromDockerFile>, org.testcontainers.images.builder.traits.DockerfileTrait<AdvancedImageFromDockerFile>

Fork of ImageFromDockerfile to fix the following problems:

• testcontainers-java#3093
• testcontainers-java#3238
• TransferFilesCreator
• Fixed: Logger was not controllable (because it was generic)
• Deprecated-Stuff replaced / removed

Author:

AB

See Also:

• ImageFromDockerfile

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	alwaysTransferDockerfilePath
protected Set<String>	alwaysTransferRelativePaths
protected Optional<Path>	baseDir
protected Optional<Path>	baseDirRelativeIgnoreFile
protected final Map<String,String>	buildArgs
protected final Set<Consumer<com.github.dockerjava.api.command.BuildImageCmd>>	buildImageCmdModifiers
protected final org.slf4j.Logger	defaultLogger
protected final boolean	deleteOnExit
protected org.testcontainers.shaded.org.apache.commons.lang3.function.TriFunction<Path,List<DockerFileLineModifier>,Collection<String>,DockerFileContentModifier>	dockerFileContentModifierSupplier
protected List<DockerFileLineModifier>	dockerFileLinesModifiers
protected Optional<Path>	dockerFilePath
protected final String	dockerImageName
protected Set<String>	externalDependencyImageNames
protected Predicate<String>	ignoreFileLineFilter
protected org.slf4j.Logger	loggerForBuild
protected Set<String>	postGitIgnoreLines
protected Set<String>	preGitIgnoreLines
protected Optional<String>	target
protected final Map<String,org.testcontainers.images.builder.Transferable>	transferables
protected TransferArchiveTARCompressor	transferArchiveTARCompressor
protected Consumer<TransferArchiveTARCompressor>	transferArchiveTARCompressorCustomizer
protected BiFunction<Path,Path,TransferFilesCreator>	transferFilesCreatorSupplier
protected boolean	useWinNTFSJunctionFixIfApplicable

Constructor Summary

Constructors

Constructor	Description
AdvancedImageFromDockerFile()
AdvancedImageFromDockerFile(String dockerImageName)
AdvancedImageFromDockerFile(String dockerImageName, boolean deleteOnExit)
AdvancedImageFromDockerFile(String dockerImageName, boolean deleteOnExit, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
protected boolean	canImageNameBePulled(String imageName)
protected void	configure(com.github.dockerjava.api.command.BuildImageCmd buildImageCmd)
protected void	deleteImageOnExitIfRequired(Map<String,String> labels)
protected Set<String>	fullyResolveDependencyImages(Set<String> fileDependencyImages, Map<String,Optional<String>> fileArgs)
protected com.github.dockerjava.api.command.BuildImageResultCallback	getBuildImageResultCallback(org.slf4j.Logger logger)
protected long	getBytesToDockerDaemon(PipedOutputStream out)
protected org.slf4j.Logger	log()
protected void	prePullDependencyImages(Set<String> imagesToPull)
protected String	relativeDockerFilePathString(Path baseDir)
protected static String	removeEnd(String str, String remove)
protected String	resolve()
protected Path	safeDockerFilePath()
AdvancedImageFromDockerFile	withAlwaysTransferDockerfilePath(boolean alwaysTransferDockerfilePath)
AdvancedImageFromDockerFile	withAlwaysTransferRelativPaths(Set<String> alwaysTransferPaths)
AdvancedImageFromDockerFile	withBaseDir(Path baseDir)
AdvancedImageFromDockerFile	withBaseDirRelativeIgnoreFile(Path baseDirRelativeIgnoreFile)
AdvancedImageFromDockerFile	withBuildArg(String key, String value)
AdvancedImageFromDockerFile	withBuildArgs(Map<String,String> args)
AdvancedImageFromDockerFile	withBuildImageCmdModifier(Consumer<com.github.dockerjava.api.command.BuildImageCmd> modifier)
AdvancedImageFromDockerFile	withDockerFileContentModifierSupplier(org.testcontainers.shaded.org.apache.commons.lang3.function.TriFunction<Path,List<DockerFileLineModifier>,Collection<String>,DockerFileContentModifier> dockerFileContentModifierSupplier)
AdvancedImageFromDockerFile	withDockerFileLinesModifier(DockerFileLineModifier dockerFileLinesModifier)
AdvancedImageFromDockerFile	withDockerFilePath(Path dockerFilePath)
AdvancedImageFromDockerFile	withFileFromTransferable(String path, org.testcontainers.images.builder.Transferable transferable)
AdvancedImageFromDockerFile	withIgnoreFileLineFilter(Predicate<String> ignoreFileLineFilter)
AdvancedImageFromDockerFile	withLoggerForBuild(org.slf4j.Logger loggerForBuild)
AdvancedImageFromDockerFile	withPostGitIgnoreLines(String... postGitIgnoreLines)
AdvancedImageFromDockerFile	withPreGitIgnoreLines(String... preGitIgnoreLines)
AdvancedImageFromDockerFile	withTarget(String target)
AdvancedImageFromDockerFile	withTransferArchiveTARCompressor(TransferArchiveTARCompressor transferArchiveTARCompressor)
AdvancedImageFromDockerFile	withTransferArchiveTARCompressorCustomizer(Consumer<TransferArchiveTARCompressor> customizer)
AdvancedImageFromDockerFile	withTransferFilesCreatorSupplier(BiFunction<Path,Path,TransferFilesCreator> transferFilesCreatorSupplier)
AdvancedImageFromDockerFile	withUseWinNTFSJunctionFixIfApplicable(boolean useWinNTFSJunctionFixIfApplicable)	Should the fix for a crash when encountering Windows NTFS Junctions be applied if applicable?

Methods inherited from class org.testcontainers.utility.LazyFuture

cancel, get, get, isCancelled, isDone

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testcontainers.images.builder.traits.ClasspathTrait

withFileFromClasspath

Methods inherited from interface org.testcontainers.images.builder.traits.DockerfileTrait

withDockerfileFromBuilder

Methods inherited from interface org.testcontainers.images.builder.traits.FilesTrait

withFileFromFile, withFileFromFile, withFileFromPath, withFileFromPath

Methods inherited from interface org.testcontainers.images.builder.traits.StringsTrait

withFileFromString

Field Details

dockerImageName

protected final String dockerImageName

defaultLogger

protected final org.slf4j.Logger defaultLogger

deleteOnExit

protected final boolean deleteOnExit

transferables

protected final Map<String,org.testcontainers.images.builder.Transferable> transferables

buildArgs

protected final Map<String,String> buildArgs

loggerForBuild

protected org.slf4j.Logger loggerForBuild

dockerFilePath

protected Optional<Path> dockerFilePath

baseDir

protected Optional<Path> baseDir

baseDirRelativeIgnoreFile

protected Optional<Path> baseDirRelativeIgnoreFile

preGitIgnoreLines

protected Set<String> preGitIgnoreLines

ignoreFileLineFilter

protected Predicate<String> ignoreFileLineFilter

postGitIgnoreLines

protected Set<String> postGitIgnoreLines

alwaysTransferDockerfilePath

protected boolean alwaysTransferDockerfilePath

alwaysTransferRelativePaths

protected Set<String> alwaysTransferRelativePaths

transferFilesCreatorSupplier

protected BiFunction<Path,Path,TransferFilesCreator> transferFilesCreatorSupplier

transferArchiveTARCompressor

protected TransferArchiveTARCompressor transferArchiveTARCompressor

transferArchiveTARCompressorCustomizer

protected Consumer<TransferArchiveTARCompressor> transferArchiveTARCompressorCustomizer

dockerFileContentModifierSupplier

protected org.testcontainers.shaded.org.apache.commons.lang3.function.TriFunction<Path,List<DockerFileLineModifier>,Collection<String>,DockerFileContentModifier> dockerFileContentModifierSupplier

dockerFileLinesModifiers

protected List<DockerFileLineModifier> dockerFileLinesModifiers

target

protected Optional<String> target

buildImageCmdModifiers

protected final Set<Consumer<com.github.dockerjava.api.command.BuildImageCmd>> buildImageCmdModifiers

externalDependencyImageNames

protected Set<String> externalDependencyImageNames

useWinNTFSJunctionFixIfApplicable

protected boolean useWinNTFSJunctionFixIfApplicable

Constructor Details

AdvancedImageFromDockerFile

public AdvancedImageFromDockerFile()

AdvancedImageFromDockerFile

public AdvancedImageFromDockerFile(String dockerImageName)

AdvancedImageFromDockerFile

public AdvancedImageFromDockerFile(String dockerImageName,
 boolean deleteOnExit)

AdvancedImageFromDockerFile

public AdvancedImageFromDockerFile(String dockerImageName,
 boolean deleteOnExit,
 org.slf4j.Logger logger)

Method Details

withFileFromTransferable

public AdvancedImageFromDockerFile withFileFromTransferable(String path,
 org.testcontainers.images.builder.Transferable transferable)

Specified by:

withFileFromTransferable in interface org.testcontainers.images.builder.traits.BuildContextBuilderTrait<AdvancedImageFromDockerFile>

withLoggerForBuild

public AdvancedImageFromDockerFile withLoggerForBuild(org.slf4j.Logger loggerForBuild)

resolve

protected String resolve()

Specified by:

resolve in class org.testcontainers.utility.LazyFuture<String>

deleteImageOnExitIfRequired

protected void deleteImageOnExitIfRequired(Map<String,String> labels)

getBytesToDockerDaemon

protected long getBytesToDockerDaemon(PipedOutputStream out)
                               throws IOException

Throws:

IOException

getBuildImageResultCallback

protected com.github.dockerjava.api.command.BuildImageResultCallback getBuildImageResultCallback(org.slf4j.Logger logger)

removeEnd

protected static String removeEnd(String str,
 String remove)

configure

protected void configure(com.github.dockerjava.api.command.BuildImageCmd buildImageCmd)

fullyResolveDependencyImages

protected Set<String> fullyResolveDependencyImages(Set<String> fileDependencyImages,
 Map<String,Optional<String>> fileArgs)

relativeDockerFilePathString

protected String relativeDockerFilePathString(Path baseDir)

safeDockerFilePath

protected Path safeDockerFilePath()

prePullDependencyImages

protected void prePullDependencyImages(Set<String> imagesToPull)

canImageNameBePulled

protected boolean canImageNameBePulled(String imageName)

log

protected org.slf4j.Logger log()

withBuildArg

public AdvancedImageFromDockerFile withBuildArg(String key,
 String value)

withBuildArgs

public AdvancedImageFromDockerFile withBuildArgs(Map<String,String> args)

withDockerFilePath

public AdvancedImageFromDockerFile withDockerFilePath(Path dockerFilePath)

withBaseDir

public AdvancedImageFromDockerFile withBaseDir(Path baseDir)

withBaseDirRelativeIgnoreFile

public AdvancedImageFromDockerFile withBaseDirRelativeIgnoreFile(Path baseDirRelativeIgnoreFile)

withPreGitIgnoreLines

public AdvancedImageFromDockerFile withPreGitIgnoreLines(String... preGitIgnoreLines)

withIgnoreFileLineFilter

public AdvancedImageFromDockerFile withIgnoreFileLineFilter(Predicate<String> ignoreFileLineFilter)

withPostGitIgnoreLines

public AdvancedImageFromDockerFile withPostGitIgnoreLines(String... postGitIgnoreLines)

withAlwaysTransferRelativPaths

public AdvancedImageFromDockerFile withAlwaysTransferRelativPaths(Set<String> alwaysTransferPaths)

withAlwaysTransferDockerfilePath

public AdvancedImageFromDockerFile withAlwaysTransferDockerfilePath(boolean alwaysTransferDockerfilePath)

withTarget

public AdvancedImageFromDockerFile withTarget(String target)

withTransferFilesCreatorSupplier

public AdvancedImageFromDockerFile withTransferFilesCreatorSupplier(BiFunction<Path,Path,TransferFilesCreator> transferFilesCreatorSupplier)

withTransferArchiveTARCompressor

public AdvancedImageFromDockerFile withTransferArchiveTARCompressor(TransferArchiveTARCompressor transferArchiveTARCompressor)

withTransferArchiveTARCompressorCustomizer

public AdvancedImageFromDockerFile withTransferArchiveTARCompressorCustomizer(Consumer<TransferArchiveTARCompressor> customizer)

withDockerFileContentModifierSupplier

public AdvancedImageFromDockerFile withDockerFileContentModifierSupplier(org.testcontainers.shaded.org.apache.commons.lang3.function.TriFunction<Path,List<DockerFileLineModifier>,Collection<String>,DockerFileContentModifier> dockerFileContentModifierSupplier)

withDockerFileLinesModifier

public AdvancedImageFromDockerFile withDockerFileLinesModifier(DockerFileLineModifier dockerFileLinesModifier)

withBuildImageCmdModifier

public AdvancedImageFromDockerFile withBuildImageCmdModifier(Consumer<com.github.dockerjava.api.command.BuildImageCmd> modifier)

withUseWinNTFSJunctionFixIfApplicable

public AdvancedImageFromDockerFile withUseWinNTFSJunctionFixIfApplicable(boolean useWinNTFSJunctionFixIfApplicable)

Should the fix for a crash when encountering Windows NTFS Junctions be applied if applicable?

See software.xdev.testcontainers.imagebuilder.transfer.java.nio.file.winntfs for details