Merge pull request #122 from xdev-software/develop

AB-xdev · web-flow · commit 24baf652682e · 2025-06-12T11:54:37.000Z
Release
diff --git a/.config/pmd/java/ruleset.xml b/.config/pmd/java/ruleset.xml
diff --git a/.gitattributes b/.gitattributes
@@ -6,4 +6,4 @@
 
 # Force MVN Wrapper Linux files LF
 mvnw text eol=lf
-.mvn/wrapper/maven-wrapper.properties text eol=lf
+maven-wrapper.properties text eol=lf
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -33,6 +33,15 @@ body:
     validations:
       required: true
 
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of the problem
+      description: |
+        Describe as exactly as possible what is not working.
+    validations:
+      required: true
+
   - type: textarea
     id: steps-to-reproduce
     attributes:
@@ -47,20 +56,6 @@ body:
     validations:
       required: true
 
-  - type: textarea
-    id: expected-behavior
-    attributes:
-      label: Expected behavior
-      description: |
-        Tell us what you expect to happen.
-
-  - type: textarea
-    id: actual-behavior
-    attributes:
-      label: Actual behavior
-      description: |
-        Tell us what happens with the steps given above.
-
   - type: textarea
     id: additional-information
     attributes:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -89,7 +89,7 @@ jobs:
     
     - name: Create Release
       id: create_release
-      uses: shogo82148/actions-create-release@e5f206451d4ace2da9916d01f1aef279997f8659 # v1
+      uses: shogo82148/actions-create-release@4661dc54f7b4b564074e9fbf73884d960de569a3 # v1
       with:
         tag_name: v${{ steps.version.outputs.release }}
         release_name: v${{ steps.version.outputs.release }}
diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties
@@ -14,4 +14,4 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.10/apache-maven-3.9.10-bin.zip
diff --git a/CHANGELOG.md b/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)
 
diff --git a/pom.xml b/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>
@@ -46,7 +46,7 @@
 							<dependency>
 								<groupId>com.puppycrawl.tools</groupId>
 								<artifactId>checkstyle</artifactId>
-								<version>10.23.1</version>
+								<version>10.25.0</version>
 							</dependency>
 						</dependencies>
 						<configuration>
@@ -76,19 +76,19 @@
 							<includeTests>true</includeTests>
 							<printFailingErrors>true</printFailingErrors>
 							<rulesets>
-								<ruleset>.config/pmd/ruleset.xml</ruleset>
+								<ruleset>.config/pmd/java/ruleset.xml</ruleset>
 							</rulesets>
 						</configuration>
 						<dependencies>
 							<dependency>
 								<groupId>net.sourceforge.pmd</groupId>
 								<artifactId>pmd-core</artifactId>
-								<version>7.13.0</version>
+								<version>7.14.0</version>
 							</dependency>
 							<dependency>
 								<groupId>net.sourceforge.pmd</groupId>
 								<artifactId>pmd-java</artifactId>
-								<version>7.13.0</version>
+								<version>7.14.0</version>
 							</dependency>
 						</dependencies>
 					</plugin>
diff --git a/testcontainers-advanced-imagebuilder-demo/pom.xml b/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>
diff --git a/testcontainers-advanced-imagebuilder-dummy-app/pom.xml b/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>
@@ -82,7 +82,7 @@
 							<dependency>
 								<groupId>com.puppycrawl.tools</groupId>
 								<artifactId>checkstyle</artifactId>
-								<version>10.23.1</version>
+								<version>10.25.0</version>
 							</dependency>
 						</dependencies>
 						<configuration>
diff --git a/testcontainers-advanced-imagebuilder/pom.xml b/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>
@@ -56,7 +56,7 @@
 		<dependency>
 			<groupId>org.testcontainers</groupId>
 			<artifactId>testcontainers</artifactId>
-			<version>1.21.0</version>
+			<version>1.21.1</version>
 			<exclusions>
 				<!-- No JUnit 4 -->
 				<exclusion>
@@ -68,7 +68,7 @@
 		<dependency>
 			<groupId>software.xdev</groupId>
 			<artifactId>testcontainers-junit4-mock</artifactId>
-			<version>1.0.1</version>
+			<version>1.0.2</version>
 		</dependency>
 		<!-- Testcontainers is using outdated v1 -->
 		<dependency>
@@ -81,7 +81,7 @@
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter</artifactId>
-			<version>5.12.2</version>
+			<version>5.13.1</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
@@ -267,7 +267,7 @@
 							<dependency>
 								<groupId>com.puppycrawl.tools</groupId>
 								<artifactId>checkstyle</artifactId>
-								<version>10.23.1</version>
+								<version>10.25.0</version>
 							</dependency>
 						</dependencies>
 						<configuration>
@@ -297,19 +297,19 @@
 							<includeTests>true</includeTests>
 							<printFailingErrors>true</printFailingErrors>
 							<rulesets>
-								<ruleset>../.config/pmd/ruleset.xml</ruleset>
+								<ruleset>../.config/pmd/java/ruleset.xml</ruleset>
 							</rulesets>
 						</configuration>
 						<dependencies>
 							<dependency>
 								<groupId>net.sourceforge.pmd</groupId>
 								<artifactId>pmd-core</artifactId>
-								<version>7.13.0</version>
+								<version>7.14.0</version>
 							</dependency>
 							<dependency>
 								<groupId>net.sourceforge.pmd</groupId>
 								<artifactId>pmd-java</artifactId>
-								<version>7.13.0</version>
+								<version>7.14.0</version>
 							</dependency>
 						</dependencies>
 					</plugin>
diff --git a/testcontainers-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/AdvancedImageFromDockerFile.java b/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);
diff --git a/testcontainers-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/TransferFilesCreator.java b/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();
 		}
