Merge pull request #128 from xdev-software/develop

Release

Author: AB-xdev

.gitignore

@@ -1,65 +1,37 @@
 # Maven
 target/
-pom.xml.tag
-pom.xml.releaseBackup
-pom.xml.versionsBackup
-pom.xml.next
-release.properties
 dependency-reduced-pom.xml
-buildNumber.properties
-.mvn/timing.properties
-# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+
+# Maven Wrapper
 .mvn/wrapper/maven-wrapper.jar
 
+# Maven Flatten Plugin
+.flattened-pom.xml
 
 # Compiled class file
 *.class
 
 # Log file
 *.log
 
-# BlueJ files
-*.ctxt
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
 # Package/Binary Files don't belong into a git repo
 *.jar
 *.war
-*.nar
 *.ear
 *.zip
 *.tar.gz
-*.rar
 *.dll
 *.exe
 *.bin
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 
-# JRebel
-**/resources/rebel.xml
-**/resources/rebel-remote.xml
-
-# eclispe stuff for root
-/.settings/
-/.classpath
-/.project
-
-
-# eclispe stuff for modules
-/*/.metadata/
-/*/.apt_generated_tests/
-/*/.settings/
-/*/.classpath
-/*/.project
-/*/RemoteSystemsTempFiles/
-
-#custom
-.flattened-pom.xml
-.tern-project
+# Eclipse
+.metadata
+.settings
+.classpath
+.project
 
 # == IntelliJ ==
 *.iml

CHANGELOG.md

@@ -1,3 +1,29 @@
+# 2.0.0
+* Changed ignore backend to utilize [JGit](https://github.com/eclipse-jgit/jgit) 
+    * This should now behave exactly like a ``.gitignore``
+    * Overall performance should be a lot faster
+* Make it possible to modify transferred files
+* Provide an option to emulate [``COPY --parents``](https://docs.docker.com/reference/dockerfile/#copy---parents) (which is currently not supported by Docker out of the box)
+    * This option is required to utilize Docker's cache properly
+    ```docker
+    # ...
+    
+    # Copy & Cache wrapper
+    COPY --parents mvnw .mvn/** ./
+    RUN ./mvnw --version
+
+    # Copy & Cache poms/dependencies
+    COPY --parents **/pom.xml ./
+    # Resolve jars so that they can be cached and don't need to be downloaded when a Java file changes
+    RUN ./mvnw -B dependency:go-offline -pl app -am -DincludeScope=runtime -T2C
+
+    # Copying all other files
+    COPY . ./
+    # Run the actual build
+    RUN ./mvnw -B clean package -pl app -am -T2C -Dmaven.test.skip
+    ```
+* At ton of minor optimizations and improvements
+
 # 1.2.0
 * Provide an option to always transfer specific paths
 * Always transfer Dockerfile - as it is required for building - by default

LICENSE

@@ -187,6 +187,7 @@
       identification within third-party archives.
 
    Copyright 2024 XDEV Software
+   Copyright 2023 Java Git Contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -8,13 +8,15 @@ A re-implementation of [Testcontainers Image-Builder](https://java.testcontainer
 * Allows passing a custom logger to the image build - [testcontainers-java#3093](https://github.com/testcontainers/testcontainers-java/issues/3093)
 * Allows using ``ARG``s for ``FROM`` - [testcontainers-java#3238](https://github.com/testcontainers/testcontainers-java/issues/3238)
 * Brings a custom [build-context](https://docs.docker.com/build/building/context/) processor
-  * Works more efficient and reliable than the default implementation (however likely still not perfect)
-  * uses ``.gitignore`` if available
+  * Works more efficient and reliable than the default implementation because it utilizes [JGit](https://github.com/eclipse-jgit/jgit)
+  * uses the ``.gitignore`` if available
   * Allows adding custom ignores
     * This way the build-context can be fine tuned in a way that the build cache works very efficiently (e.g. only re-built when actual code that matters changes)
+  * Makes it possible to modify files that are transferred
+* Provide a compatibility layer to emulate [``COPY --parents``](https://docs.docker.com/reference/dockerfile/#copy---parents) (which is currently not supported by Docker out of the box)
 * Do not pull images that are declared inside the Dockerfile
 * Makes logger non generic and therefore controllable
-* Did some general code cleanup
+* Some general code cleanup and performance improvements
 
 A common use case - that can also be seen [inside the demo](./testcontainers-advanced-imagebuilder-demo/src/main/java/software/xdev/Application.java) - is for creating an image - used in e.g. Integration tests - for an application that is also inside the same repo.
 

pom.xml

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

testcontainers-advanced-imagebuilder-demo/Dockerfile

@@ -1,34 +1,36 @@
+# syntax=docker/dockerfile:1-labs
 # Stage 1: Build the dummy app
 ARG JAVA_VERSION=21
 FROM eclipse-temurin:$JAVA_VERSION-jdk-alpine AS build-env
 
 RUN apk add --no-cache git bash
 
-# Create non root user
-ARG userName=limitedbuild
-ARG groupName=limitedbuild
-ARG userId=1000
-
-RUN addgroup --system ${groupName} \
-	&& adduser --uid ${userId} --system --disabled-password --shell /bin/bash ${userName} \
-	&& adduser ${userName} ${groupName}
-
-# Create build dir
-RUN mkdir /build \
-    && chown ${userName}:${groupName} /build
 WORKDIR /build
 
-USER ${userName}
-
-# Copying context is prepared by Testcontainers
-COPY --chown=${userName}:${groupName} . ./
-
-# RUN chmod +x ./mvnw
-ARG mvncmd='clean package -pl "testcontainers-advanced-imagebuilder-dummy-app" -am -T2C -Dmaven.test.skip'
-
-RUN echo "Executing '$mvncmd'"
-RUN chmod +x ./mvnw \
-  && ./mvnw -B ${mvncmd}
+# Copy & Cache wrapper
+COPY --parents mvnw .mvn/** ./
+RUN ./mvnw --version
+
+# Copy & Cache poms/dependencies
+COPY --parents **/pom.xml ./
+# Resolve jars so that they can be cached and don't need to be downloaded when a Java file changes
+ARG MAVEN_GO_OFFLINE_COMMAND='./mvnw -B dependency:go-offline -pl "testcontainers-advanced-imagebuilder-dummy-app" -am -DincludeScope=runtime -T2C'
+RUN echo "Executing '$MAVEN_GO_OFFLINE_COMMAND'"
+RUN ${MAVEN_GO_OFFLINE_COMMAND}
+
+# Copying all other files
+COPY . ./
+
+# A valid Git repo is required for the build
+RUN git config --global user.email "[email protected]" \
+  && git config --global user.name "Dynamic Build" \
+  && git init --initial-branch=dynamically-built-tcst \
+  && git add . \
+  && git commit -m "Init commit"
+
+ARG MAVEN_BUILD_COMMAND='./mvnw -B clean package -pl "testcontainers-advanced-imagebuilder-dummy-app" -am -T2C -Dmaven.test.skip'
+RUN echo "Executing '$MAVEN_BUILD_COMMAND'"
+RUN ${MAVEN_BUILD_COMMAND}
 
 # Stage 2: Build the executable image
 FROM eclipse-temurin:21-jre-alpine

testcontainers-advanced-imagebuilder-demo/pom.xml

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

testcontainers-advanced-imagebuilder-demo/src/main/java/software/xdev/Application.java

@@ -5,6 +5,7 @@
 import org.slf4j.LoggerFactory;
 
 import software.xdev.testcontainers.imagebuilder.AdvancedImageFromDockerFile;
+import software.xdev.testcontainers.imagebuilder.compat.DockerfileCOPYParentsEmulator;
 
 
 public final class Application
@@ -14,7 +15,7 @@ public static void main(final String[] args)
 	{
 		final AdvancedImageFromDockerFile builder = new AdvancedImageFromDockerFile("dynamically-built")
 			.withLoggerForBuild(LoggerFactory.getLogger("container.build"))
-			.withAdditionalIgnoreLines(
+			.withPostGitIgnoreLines(
 				// Ignore files that aren't related to the built code
 				".git/**",
 				".config/**",
@@ -26,11 +27,11 @@ public static void main(final String[] args)
 				"/renovate.json5",
 				// We need to keep the pom.xml as maven can't resolve the modules otherwise
 				"testcontainers-advanced-imagebuilder/src/**",
-				"testcontainers-advanced-imagebuilder/test/**",
 				"testcontainers-advanced-imagebuilder-demo/src/**"
 			)
 			.withDockerFilePath(Paths.get("../testcontainers-advanced-imagebuilder-demo/Dockerfile"))
-			.withBaseDir(Paths.get("../"));
+			.withBaseDir(Paths.get("../"))
+			.withDockerFileLinesModifier(new DockerfileCOPYParentsEmulator());
 
 		final String imageName = builder.get();
 

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

@@ -6,7 +6,7 @@
 
 	<groupId>software.xdev</groupId>
 	<artifactId>testcontainers-advanced-imagebuilder-dummy-app</artifactId>
-	<version>1.2.1-SNAPSHOT</version>
+	<version>2.0.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.2.1-SNAPSHOT</version>
+	<version>2.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<name>testcontainers-advanced-imagebuilder</name>
@@ -245,7 +245,7 @@
 					<plugin>
 						<groupId>org.sonatype.central</groupId>
 						<artifactId>central-publishing-maven-plugin</artifactId>
-						<version>0.7.0</version>
+						<version>0.8.0</version>
 						<extensions>true</extensions>
 						<configuration>
 							<publishingServerId>sonatype-central-portal</publishingServerId>