build: fix docker image output/manifest dirs

Author: chadlwilson

buildSrc/src/main/groovy/com/thoughtworks/go/build/docker/BuildDockerImageTask.groovy

@@ -29,10 +29,7 @@ import org.gradle.api.file.*
 import org.gradle.api.plugins.BasePlugin
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
-import org.gradle.api.tasks.Input
-import org.gradle.api.tasks.InputFile
-import org.gradle.api.tasks.Internal
-import org.gradle.api.tasks.TaskAction
+import org.gradle.api.tasks.*
 import org.gradle.api.tasks.bundling.Zip
 import org.gradle.process.ExecOperations
 
@@ -70,9 +67,10 @@ abstract class BuildDockerImageTask extends DefaultTask {
   @Input DistroVersion distroVersion
   @Input String tiniVersion
 
-  // We don't declare an output here, only an input. We dont want it to be cached.
-  // Multiple tasks share dir from parent with unique tarballs per distribution, so they are not "owned" by the task.
-  @Internal abstract DirectoryProperty getOutputDir()
+  // We don't declare an output here and multiple tasks share dir from parent with unique tarballs per
+  // distribution, so the dirs are not "owned" by the task.
+  @Internal abstract DirectoryProperty getDistributionDir()
+  @Internal final goVersions = project.goVersions as GoVersions
 
   @Internal Closure templateHelper
   @Internal Closure verifyHelper
@@ -86,8 +84,6 @@ abstract class BuildDockerImageTask extends DefaultTask {
   private final boolean keepImages = project.hasProperty('dockerBuildKeepImages')
   private final String gitPush = project.findProperty('dockerGitPush')
 
-  private final goVersions = project.goVersions as GoVersions
-
   BuildDockerImageTask() {
     dependsOn ':docker:initializeBuildx'
     group = BasePlugin.BUILD_GROUP
@@ -154,11 +150,11 @@ abstract class BuildDockerImageTask extends DefaultTask {
       logger.lifecycle("Building ${distro} image for ${distro.supportedArchitectures}. (Current build architecture is ${Architecture.current()}).")
 
       // build image
-      imageTarFile.parentFile.mkdirs()
+      imageOciTarFile.parentFile.mkdirs()
       executeInGitRepo("docker", "buildx", "build",
         "--pull",
         "--platform", supportedPlatforms.join(","),
-        "--output", "type=oci,dest=${imageTarFile}",
+        "--output", "type=oci,dest=${imageOciTarFile}",
         "--progress=plain",
         ".",
         "--tag", imageNameWithTag
@@ -266,9 +262,14 @@ abstract class BuildDockerImageTask extends DefaultTask {
     "v${goVersions.fullVersion}"
   }
 
+  @OutputFile
+  Provider<RegularFile> getImageOciTarOutput() {
+    distributionDir.map { it.file("gocd-${imageType.get().name()}-${dockerImageName}-v${goVersions.fullVersion}.tar") }
+  }
+
   @Internal
-  File getImageTarFile() {
-    outputDir.get().file("gocd-${imageType.get().name()}-${dockerImageName}-v${goVersions.fullVersion}.tar").asFile
+  File getImageOciTarFile() {
+    imageOciTarOutput.get().asFile
   }
 
   void writeTemplateToFile(String templateFile, String outputFile) {

docker/gocd-agent/build.gradle

@@ -33,17 +33,19 @@ plugins {
   id 'base'
 }
 
+def distributionsDir = layout.buildDirectory.dir("distributions")
+
 subprojects {
   apply plugin: 'base'
-  layout.buildDirectory = parent.layout.buildDirectory.dir("docker")
+  layout.buildDirectory = parent.layout.buildDirectory.dir(project.name)
   def (distro, distroVersion) = Distro.fromProjectName(project.name)
 
   def docker = tasks.register("docker", BuildDockerImageTask.class) { BuildDockerImageTask task ->
     task.configureFor(ImageType.agent)
     task.distro = distro
     task.distroVersion = distroVersion
     task.tiniVersion = project.versions.tini
-    task.outputDir = parent.layout.buildDirectory.dir("docker")
+    task.distributionDir = distributionsDir
 
     def licenseSourceFile = rootProject.file("LICENSE")
 
@@ -130,14 +132,15 @@ subprojects {
 
 tasks.register('generateManifest') {
   def dockerTasks = subprojects.tasks*.named('docker') as Collection<TaskProvider<? extends BuildDockerImageTask>>
-  def manifest = layout.buildDirectory.file("manifest.json")
+  dependsOn(dockerTasks)
+  def manifest = distributionsDir.map { it.file("manifest.json") }
   outputs.file(manifest)
 
   doLast {
     def meta = []
     dockerTasks.collect { it.get() }.each { dockerTask ->
       meta << [
-        file     : "${dockerTask.imageTarFile.name}",
+        file     : "${dockerTask.imageOciTarFile.name}",
         format   : 'oci',
         imageName: dockerTask.dockerImageName,
         tag      : dockerTask.imageTag,

docker/gocd-server/build.gradle

@@ -33,17 +33,19 @@ plugins {
   id 'base'
 }
 
+def distributionsDir = layout.buildDirectory.dir("distributions")
+
 subprojects {
   apply plugin: 'base'
-  layout.buildDirectory = parent.layout.buildDirectory.dir("docker")
+  layout.buildDirectory = parent.layout.buildDirectory.dir(project.name)
   def (distro, distroVersion) = Distro.fromProjectName(project.name)
 
   def docker = tasks.register("docker", BuildDockerImageTask.class) { BuildDockerImageTask task ->
     task.configureFor(ImageType.server)
     task.distro = distro
     task.distroVersion = distroVersion
     task.tiniVersion = project.versions.tini
-    task.outputDir = parent.layout.buildDirectory.dir("docker")
+    task.distributionDir = distributionsDir
 
     def licenseSourceFile = rootProject.file("LICENSE")
 
@@ -120,14 +122,15 @@ subprojects {
 
 tasks.register('generateManifest') {
   def dockerTasks = subprojects.tasks*.named('docker') as Collection<TaskProvider<? extends BuildDockerImageTask>>
-  def manifest = layout.buildDirectory.file("manifest.json")
+  dependsOn(dockerTasks)
+  def manifest = distributionsDir.map { it.file("manifest.json") }
   outputs.file(manifest)
 
   doLast {
     def meta = []
     dockerTasks.collect { it.get() }.each { dockerTask ->
       meta << [
-        file     : "${dockerTask.imageTarFile.name}",
+        file     : "${dockerTask.imageOciTarFile.name}",
         format   : 'oci',
         imageName: dockerTask.dockerImageName,
         tag      : dockerTask.imageTag,