Add option to create tags for a built image

This commit adds configuration to the Maven and Gradle plugins to
allow specifying multiple tag to be created that refer to the built
image.

See gh-27613

Author: ceccone

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/AbstractBuildLog.java

@@ -31,6 +31,7 @@
  * @author Phillip Webb
  * @author Scott Frederick
  * @author Andrey Shlykov
+ * @author Rafael Ceccone
  * @since 2.3.0
  */
 public abstract class AbstractBuildLog implements BuildLog {
@@ -89,6 +90,12 @@ public void executedLifecycle(BuildRequest request) {
 		log();
 	}
 
+	@Override
+	public void createdTag(ImageReference tag) {
+		log("Successfully created image tag '" + tag + "'");
+		log();
+	}
+
 	private String getDigest(Image image) {
 		List<String> digests = image.getDigests();
 		return (digests.isEmpty() ? "" : digests.get(0));

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/BuildLog.java

@@ -31,6 +31,7 @@
  * @author Phillip Webb
  * @author Scott Frederick
  * @author Andrey Shlykov
+ * @author Rafael Ceccone
  * @since 2.3.0
  * @see #toSystemOut()
  */
@@ -99,6 +100,12 @@ public interface BuildLog {
 	 */
 	void executedLifecycle(BuildRequest request);
 
+	/**
+	 * Log that a tag has been created.
+	 * @param tag the tag reference
+	 */
+	void createdTag(ImageReference tag);
+
 	/**
 	 * Factory method that returns a {@link BuildLog} the outputs to {@link System#out}.
 	 * @return a build log instance that logs to system out

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/BuildRequest.java

@@ -37,6 +37,7 @@
  * @author Scott Frederick
  * @author Andrey Shlykov
  * @author Jeroen Meijer
+ * @author Rafael Ceccone
  * @since 2.3.0
  */
 public class BuildRequest {
@@ -71,6 +72,8 @@ public class BuildRequest {
 
 	private final String network;
 
+	private final List<ImageReference> tags;
+
 	BuildRequest(ImageReference name, Function<Owner, TarArchive> applicationContent) {
 		Assert.notNull(name, "Name must not be null");
 		Assert.notNull(applicationContent, "ApplicationContent must not be null");
@@ -87,12 +90,13 @@ public class BuildRequest {
 		this.buildpacks = Collections.emptyList();
 		this.bindings = Collections.emptyList();
 		this.network = null;
+		this.tags = Collections.emptyList();
 	}
 
 	BuildRequest(ImageReference name, Function<Owner, TarArchive> applicationContent, ImageReference builder,
 			ImageReference runImage, Creator creator, Map<String, String> env, boolean cleanCache,
 			boolean verboseLogging, PullPolicy pullPolicy, boolean publish, List<BuildpackReference> buildpacks,
-			List<Binding> bindings, String network) {
+			List<Binding> bindings, String network, List<ImageReference> tags) {
 		this.name = name;
 		this.applicationContent = applicationContent;
 		this.builder = builder;
@@ -106,6 +110,7 @@ public class BuildRequest {
 		this.buildpacks = buildpacks;
 		this.bindings = bindings;
 		this.network = network;
+		this.tags = tags;
 	}
 
 	/**
@@ -117,7 +122,7 @@ public BuildRequest withBuilder(ImageReference builder) {
 		Assert.notNull(builder, "Builder must not be null");
 		return new BuildRequest(this.name, this.applicationContent, builder.inTaggedOrDigestForm(), this.runImage,
 				this.creator, this.env, this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish,
-				this.buildpacks, this.bindings, this.network);
+				this.buildpacks, this.bindings, this.network, this.tags);
 	}
 
 	/**
@@ -128,7 +133,7 @@ public BuildRequest withBuilder(ImageReference builder) {
 	public BuildRequest withRunImage(ImageReference runImageName) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, runImageName.inTaggedOrDigestForm(),
 				this.creator, this.env, this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish,
-				this.buildpacks, this.bindings, this.network);
+				this.buildpacks, this.bindings, this.network, this.tags);
 	}
 
 	/**
@@ -140,7 +145,7 @@ public BuildRequest withCreator(Creator creator) {
 		Assert.notNull(creator, "Creator must not be null");
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, creator, this.env,
 				this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish, this.buildpacks, this.bindings,
-				this.network);
+				this.network, this.tags);
 	}
 
 	/**
@@ -156,7 +161,7 @@ public BuildRequest withEnv(String name, String value) {
 		env.put(name, value);
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator,
 				Collections.unmodifiableMap(env), this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish,
-				this.buildpacks, this.bindings, this.network);
+				this.buildpacks, this.bindings, this.network, this.tags);
 	}
 
 	/**
@@ -170,7 +175,7 @@ public BuildRequest withEnv(Map<String, String> env) {
 		updatedEnv.putAll(env);
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator,
 				Collections.unmodifiableMap(updatedEnv), this.cleanCache, this.verboseLogging, this.pullPolicy,
-				this.publish, this.buildpacks, this.bindings, this.network);
+				this.publish, this.buildpacks, this.bindings, this.network, this.tags);
 	}
 
 	/**
@@ -181,7 +186,7 @@ public BuildRequest withEnv(Map<String, String> env) {
 	public BuildRequest withCleanCache(boolean cleanCache) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
 				cleanCache, this.verboseLogging, this.pullPolicy, this.publish, this.buildpacks, this.bindings,
-				this.network);
+				this.network, this.tags);
 	}
 
 	/**
@@ -192,7 +197,7 @@ public BuildRequest withCleanCache(boolean cleanCache) {
 	public BuildRequest withVerboseLogging(boolean verboseLogging) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
 				this.cleanCache, verboseLogging, this.pullPolicy, this.publish, this.buildpacks, this.bindings,
-				this.network);
+				this.network, this.tags);
 	}
 
 	/**
@@ -203,7 +208,7 @@ public BuildRequest withVerboseLogging(boolean verboseLogging) {
 	public BuildRequest withPullPolicy(PullPolicy pullPolicy) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
 				this.cleanCache, this.verboseLogging, pullPolicy, this.publish, this.buildpacks, this.bindings,
-				this.network);
+				this.network, this.tags);
 	}
 
 	/**
@@ -214,7 +219,7 @@ public BuildRequest withPullPolicy(PullPolicy pullPolicy) {
 	public BuildRequest withPublish(boolean publish) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
 				this.cleanCache, this.verboseLogging, this.pullPolicy, publish, this.buildpacks, this.bindings,
-				this.network);
+				this.network, this.tags);
 	}
 
 	/**
@@ -238,7 +243,7 @@ public BuildRequest withBuildpacks(List<BuildpackReference> buildpacks) {
 		Assert.notNull(buildpacks, "Buildpacks must not be null");
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
 				this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish, buildpacks, this.bindings,
-				this.network);
+				this.network, this.tags);
 	}
 
 	/**
@@ -262,7 +267,7 @@ public BuildRequest withBindings(List<Binding> bindings) {
 		Assert.notNull(bindings, "Bindings must not be null");
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
 				this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish, this.buildpacks, bindings,
-				this.network);
+				this.network, this.tags);
 	}
 
 	/**
@@ -274,7 +279,29 @@ public BuildRequest withBindings(List<Binding> bindings) {
 	public BuildRequest withNetwork(String network) {
 		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
 				this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish, this.buildpacks, this.bindings,
-				network);
+				network, this.tags);
+	}
+
+	/**
+	 * Return a new {@link BuildRequest} with updated tags.
+	 * @param tags a collection of tags to be created for the built image
+	 * @return an updated build request
+	 */
+	public BuildRequest withTags(ImageReference... tags) {
+		Assert.notEmpty(tags, "Tags must not be empty");
+		return withTags(Arrays.asList(tags));
+	}
+
+	/**
+	 * Return a new {@link BuildRequest} with updated tags.
+	 * @param tags a collection of tags to be created for the built image
+	 * @return an updated build request
+	 */
+	public BuildRequest withTags(List<ImageReference> tags) {
+		Assert.notNull(tags, "Tags must not be null");
+		return new BuildRequest(this.name, this.applicationContent, this.builder, this.runImage, this.creator, this.env,
+				this.cleanCache, this.verboseLogging, this.pullPolicy, this.publish, this.buildpacks, this.bindings,
+				this.network, tags);
 	}
 
 	/**
@@ -386,6 +413,14 @@ public String getNetwork() {
 		return this.network;
 	}
 
+	/**
+	 * Return the collection of tags that should be created.
+	 * @return the tags
+	 */
+	public List<ImageReference> getTags() {
+		return this.tags;
+	}
+
 	/**
 	 * Factory method to create a new {@link BuildRequest} from a JAR file.
 	 * @param jarFile the source jar file

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/Builder.java

@@ -41,6 +41,7 @@
  * @author Phillip Webb
  * @author Scott Frederick
  * @author Andrey Shlykov
+ * @author Rafael Ceccone
  * @since 2.3.0
  */
 public class Builder {
@@ -110,8 +111,10 @@ public void build(BuildRequest request) throws DockerEngineException, IOExceptio
 		this.docker.image().load(ephemeralBuilder.getArchive(), UpdateListener.none());
 		try {
 			executeLifecycle(request, ephemeralBuilder);
+			createTags(request.getName(), request.getTags());
 			if (request.isPublish()) {
 				pushImage(request.getName());
+				pushTags(request.getTags());
 			}
 		}
 		finally {
@@ -157,6 +160,19 @@ private void pushImage(ImageReference reference) throws IOException {
 		this.log.pushedImage(reference);
 	}
 
+	private void createTags(ImageReference sourceReference, List<ImageReference> tags) throws IOException {
+		for (ImageReference tag : tags) {
+			this.docker.image().tag(sourceReference, tag);
+			this.log.createdTag(tag);
+		}
+	}
+
+	private void pushTags(List<ImageReference> tags) throws IOException {
+		for (ImageReference tag : tags) {
+			pushImage(tag);
+		}
+	}
+
 	private String getBuilderAuthHeader() {
 		return (this.dockerConfiguration != null && this.dockerConfiguration.getBuilderRegistryAuthentication() != null)
 				? this.dockerConfiguration.getBuilderRegistryAuthentication().getAuthHeader() : null;

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/DockerApi.java

@@ -52,6 +52,7 @@
  *
  * @author Phillip Webb
  * @author Scott Frederick
+ * @author Rafael Ceccone
  * @since 2.3.0
  */
 public class DockerApi {
@@ -300,6 +301,13 @@ public Image inspect(ImageReference reference) throws IOException {
 			}
 		}
 
+		public void tag(ImageReference sourceReference, ImageReference targetReference) throws IOException {
+			Assert.notNull(sourceReference, "SourceReference must not be null");
+			Assert.notNull(targetReference, "TargetReference must not be null");
+			URI uri = buildUrl("/images/" + sourceReference + "/tag", "repo", targetReference.toString());
+			http().post(uri);
+		}
+
 	}
 
 	/**

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/build/BuildRequestTests.java

@@ -46,6 +46,7 @@
  * @author Phillip Webb
  * @author Scott Frederick
  * @author Jeroen Meijer
+ * @author Rafael Ceccone
  */
 class BuildRequestTests {
 
@@ -206,6 +207,25 @@ void withNetworkUpdatesNetwork() throws IOException {
 		assertThat(request.getNetwork()).isEqualTo("test");
 	}
 
+	@Test
+	void withTagsAddsTags() throws IOException {
+		BuildRequest request = BuildRequest.forJarFile(writeTestJarFile("my-app-0.0.1.jar"));
+		BuildRequest witTags = request.withTags(ImageReference.of("docker.io/library/my-app:latest"),
+				ImageReference.of("example.com/custom/my-app:0.0.1"),
+				ImageReference.of("example.com/custom/my-app:latest"));
+		assertThat(request.getTags()).isEmpty();
+		assertThat(witTags.getTags()).containsExactly(ImageReference.of("docker.io/library/my-app:latest"),
+				ImageReference.of("example.com/custom/my-app:0.0.1"),
+				ImageReference.of("example.com/custom/my-app:latest"));
+	}
+
+	@Test
+	void withTagsWhenTagsIsNullThrowsException() throws IOException {
+		BuildRequest request = BuildRequest.forJarFile(writeTestJarFile("my-app-0.0.1.jar"));
+		assertThatIllegalArgumentException().isThrownBy(() -> request.withTags((List<ImageReference>) null))
+				.withMessage("Tags must not be null");
+	}
+
 	private void hasExpectedJarContent(TarArchive archive) {
 		try {
 			ByteArrayOutputStream outputStream = new ByteArrayOutputStream();

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/build/BuilderTests.java

@@ -58,6 +58,7 @@
  *
  * @author Phillip Webb
  * @author Scott Frederick
+ * @author Rafael Ceccone
  */
 class BuilderTests {
 
@@ -276,6 +277,65 @@ void buildInvokesBuilderWithIfNotPresentPullPolicy() throws Exception {
 		verify(docker.image(), times(2)).pull(any(), any(), isNull());
 	}
 
+	@Test
+	void buildInvokesBuilderWithTags() throws Exception {
+		TestPrintStream out = new TestPrintStream();
+		DockerApi docker = mockDockerApi();
+		Image builderImage = loadImage("image.json");
+		Image runImage = loadImage("run-image.json");
+		given(docker.image().pull(eq(ImageReference.of(BuildRequest.DEFAULT_BUILDER_IMAGE_NAME)), any(), isNull()))
+				.willAnswer(withPulledImage(builderImage));
+		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:base-cnb")), any(), isNull()))
+				.willAnswer(withPulledImage(runImage));
+		Builder builder = new Builder(BuildLog.to(out), docker, null);
+		BuildRequest request = getTestRequest().withTags(ImageReference.of("my-application:1.2.3"));
+		builder.build(request);
+		assertThat(out.toString()).contains("Running creator");
+		assertThat(out.toString()).contains("Successfully built image 'docker.io/library/my-application:latest'");
+		assertThat(out.toString()).contains("Successfully created image tag 'docker.io/library/my-application:1.2.3'");
+		verify(docker.image()).tag(eq(request.getName()), eq(ImageReference.of("my-application:1.2.3")));
+		ArgumentCaptor<ImageArchive> archive = ArgumentCaptor.forClass(ImageArchive.class);
+		verify(docker.image()).load(archive.capture(), any());
+		verify(docker.image()).remove(archive.getValue().getTag(), true);
+	}
+
+	@Test
+	void buildInvokesBuilderWithTagsAndPublishesImageAndTags() throws Exception {
+		TestPrintStream out = new TestPrintStream();
+		DockerApi docker = mockDockerApi();
+		Image builderImage = loadImage("image.json");
+		Image runImage = loadImage("run-image.json");
+		DockerConfiguration dockerConfiguration = new DockerConfiguration()
+				.withBuilderRegistryTokenAuthentication("builder token")
+				.withPublishRegistryTokenAuthentication("publish token");
+		given(docker.image().pull(eq(ImageReference.of(BuildRequest.DEFAULT_BUILDER_IMAGE_NAME)), any(),
+				eq(dockerConfiguration.getBuilderRegistryAuthentication().getAuthHeader())))
+						.willAnswer(withPulledImage(builderImage));
+		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:base-cnb")), any(),
+				eq(dockerConfiguration.getBuilderRegistryAuthentication().getAuthHeader())))
+						.willAnswer(withPulledImage(runImage));
+		Builder builder = new Builder(BuildLog.to(out), docker, dockerConfiguration);
+		BuildRequest request = getTestRequest().withPublish(true).withTags(ImageReference.of("my-application:1.2.3"));
+		builder.build(request);
+		assertThat(out.toString()).contains("Running creator");
+		assertThat(out.toString()).contains("Successfully built image 'docker.io/library/my-application:latest'");
+		assertThat(out.toString()).contains("Successfully created image tag 'docker.io/library/my-application:1.2.3'");
+
+		verify(docker.image()).pull(eq(ImageReference.of(BuildRequest.DEFAULT_BUILDER_IMAGE_NAME)), any(),
+				eq(dockerConfiguration.getBuilderRegistryAuthentication().getAuthHeader()));
+		verify(docker.image()).pull(eq(ImageReference.of("docker.io/cloudfoundry/run:base-cnb")), any(),
+				eq(dockerConfiguration.getBuilderRegistryAuthentication().getAuthHeader()));
+		verify(docker.image()).push(eq(request.getName()), any(),
+				eq(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()));
+		verify(docker.image()).tag(eq(request.getName()), eq(ImageReference.of("my-application:1.2.3")));
+		verify(docker.image()).push(eq(ImageReference.of("my-application:1.2.3")), any(),
+				eq(dockerConfiguration.getPublishRegistryAuthentication().getAuthHeader()));
+		ArgumentCaptor<ImageArchive> archive = ArgumentCaptor.forClass(ImageArchive.class);
+		verify(docker.image()).load(archive.capture(), any());
+		verify(docker.image()).remove(archive.getValue().getTag(), true);
+		verifyNoMoreInteractions(docker.image());
+	}
+
 	@Test
 	void buildWhenStackIdDoesNotMatchThrowsException() throws Exception {
 		TestPrintStream out = new TestPrintStream();