Add "Always transfer paths" function

Author: AB-xdev

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.2.0
+* Provide an option to always transfer specific paths
+* Always transfer Dockerfile - as it is required for building - by default
+
 # 1.1.1
 * Migrated deployment to _Sonatype Maven Central Portal_ [#155](https://github.com/xdev-software/standard-maven-template/issues/155)
 

pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>software.xdev</groupId>
 	<artifactId>testcontainers-advanced-imagebuilder-root</artifactId>
-	<version>1.1.2-SNAPSHOT</version>
+	<version>1.2.0-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
 	<organization>

testcontainers-advanced-imagebuilder-demo/pom.xml

@@ -7,11 +7,11 @@
 	<parent>
 		<groupId>software.xdev</groupId>
 		<artifactId>testcontainers-advanced-imagebuilder-root</artifactId>
-		<version>1.1.2-SNAPSHOT</version>
+		<version>1.2.0-SNAPSHOT</version>
 	</parent>
 
 	<artifactId>testcontainers-advanced-imagebuilder-demo</artifactId>
-	<version>1.1.2-SNAPSHOT</version>
+	<version>1.2.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<organization>

testcontainers-advanced-imagebuilder-dummy-app/pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>software.xdev</groupId>
 	<artifactId>testcontainers-advanced-imagebuilder-dummy-app</artifactId>
-	<version>1.1.2-SNAPSHOT</version>
+	<version>1.2.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<organization>

testcontainers-advanced-imagebuilder/pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>software.xdev</groupId>
 	<artifactId>testcontainers-advanced-imagebuilder</artifactId>
-	<version>1.1.2-SNAPSHOT</version>
+	<version>1.2.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<name>testcontainers-advanced-imagebuilder</name>

testcontainers-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/AdvancedImageFromDockerFile.java

@@ -30,6 +30,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
@@ -96,6 +97,8 @@ public class AdvancedImageFromDockerFile
 	protected Optional<Path> baseDir = Optional.empty();
 	protected Optional<Path> baseDirRelativeIgnoreFile = Optional.of(Paths.get(".gitignore"));
 	protected List<String> additionalIgnoreLines = new ArrayList<>();
+	protected boolean alwaysTransferDockerfilePath = true;
+	protected Set<Path> alwaysTransferPaths = Set.of();
 	protected Optional<String> target = Optional.empty();
 	protected final Set<Consumer<BuildImageCmd>> buildImageCmdModifiers = new LinkedHashSet<>();
 	protected Set<String> externalDependencyImageNames = Collections.emptySet();
@@ -326,7 +329,16 @@ protected void configure(final BuildImageCmd buildImageCmd)
 			final TransferFilesCreator tfc =
 				new TransferFilesCreator(this.baseDir.get(), this.baseDirRelativeIgnoreFile.orElse(null));
 
-			final List<Path> filesToTransfer = tfc.getFilesToTransfer(this.additionalIgnoreLines);
+			final Set<Path> alwaysIncludePaths = new HashSet<>(this.alwaysTransferPaths);
+			if(this.alwaysTransferDockerfilePath)
+			{
+				final Path determinedDockerfilePath = this.dockerFilePath.orElse(Path.of("Dockerfile"));
+				alwaysIncludePaths.add(this.baseDir
+					.map(basePath -> basePath.relativize(determinedDockerfilePath))
+					.orElse(determinedDockerfilePath));
+			}
+			
+			final List<Path> filesToTransfer = tfc.getFilesToTransfer(this.additionalIgnoreLines, alwaysIncludePaths);
 
 			this.log().info("{}x files will be transferred", filesToTransfer.size());
 			if(this.log().isDebugEnabled())
@@ -472,6 +484,18 @@ public AdvancedImageFromDockerFile withAdditionalIgnoreLines(final String... add
 		return this;
 	}
 
+	public AdvancedImageFromDockerFile withAlwaysTransferPaths(final Set<Path> alwaysTransferPaths)
+	{
+		this.alwaysTransferPaths = new HashSet<>(Objects.requireNonNull(alwaysTransferPaths));
+		return this;
+	}
+	
+	public AdvancedImageFromDockerFile withAlwaysTransferDockerfilePath(final boolean alwaysTransferDockerfilePath)
+	{
+		this.alwaysTransferDockerfilePath = alwaysTransferDockerfilePath;
+		return this;
+	}
+	
 	public AdvancedImageFromDockerFile withTarget(final String target)
 	{
 		this.target = Optional.of(target);

testcontainers-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/TransferFilesCreator.java

@@ -54,13 +54,17 @@ public class TransferFilesCreator
 	private final Path baseDir;
 	private final Path ignoreFileRelativeToBaseDir;
 
-	public TransferFilesCreator(final Path baseDir, final Path ignoreFileRelativeToBaseDir)
+	public TransferFilesCreator(
+		final Path baseDir,
+		final Path ignoreFileRelativeToBaseDir)
 	{
 		this.baseDir = Objects.requireNonNull(baseDir);
 		this.ignoreFileRelativeToBaseDir = ignoreFileRelativeToBaseDir;
 	}
 
-	public List<Path> getFilesToTransfer(final Collection<String> additionalIgnoreLines)
+	public List<Path> getFilesToTransfer(
+		final Collection<String> additionalIgnoreLines,
+		final Set<Path> alwaysIncludePaths)
 	{
 		try
 		{
@@ -76,7 +80,7 @@ public List<Path> getFilesToTransfer(final Collection<String> additionalIgnoreLi
 				.map(s -> FileSystems.getDefault().getPathMatcher("glob:" + s))
 				.toList();
 
-			return this.walkFilesAndDetermineTransfer(ignoreMatchers);
+			return this.walkFilesAndDetermineTransfer(ignoreMatchers, alwaysIncludePaths);
 		}
 		catch(final IOException ioe)
 		{
@@ -115,15 +119,22 @@ else if(!s.startsWith("/") && !s.startsWith("*") && !s.startsWith("!"))
 			.toList();
 	}
 
-	protected List<Path> walkFilesAndDetermineTransfer(final List<PathMatcher> ignoreMatchers) throws IOException
+	protected List<Path> walkFilesAndDetermineTransfer(
+		final List<PathMatcher> ignoreMatchers,
+		final Set<Path> alwaysIncludePaths) throws IOException
 	{
 		try(final Stream<Path> walk = Files.walk(this.baseDir))
 		{
 			return walk
 				.filter(Files::isRegularFile)
 				.filter(file -> {
-					final Path relativePath = Paths.get("/").resolve(this.baseDir.relativize(file));
-					return ignoreMatchers.stream().noneMatch(m -> m.matches(relativePath));
+					final Path relativePath = this.baseDir.relativize(file);
+					if(alwaysIncludePaths.contains(relativePath))
+					{
+						return true;
+					}
+					final Path rootRelativePath = Paths.get("/").resolve(relativePath);
+					return ignoreMatchers.stream().noneMatch(m -> m.matches(rootRelativePath));
 				})
 				.toList();
 		}