configuration cache: fix exposing environment variables and system properies via isRequiredBy() (#498)

* configuration cache: expose via isRequiredBy()

* copilot feedback

* small whitespace fix

Author: mikewacker

build.gradle

@@ -23,6 +23,7 @@ repositories {
 
 dependencies {
     implementation gradleApi()
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.20.0'
     implementation 'org.yaml:snakeyaml:2.5'
     testImplementation gradleTestKit()
     testImplementation 'org.spockframework:spock-core:2.3-groovy-4.0'

src/main/groovy/com/avast/gradle/dockercompose/ContainerInfo.groovy

@@ -1,8 +1,9 @@
 package com.avast.gradle.dockercompose
 
+import com.fasterxml.jackson.annotation.JsonIgnore
 import groovy.transform.Immutable
 
-//@Immutable // see ServiceHost.groovy
+@Immutable
 class ContainerInfo {
     /* For example serviceName_1 */
     String instanceName
@@ -12,14 +13,14 @@ class ContainerInfo {
     Map<Integer, Integer> udpPorts
     /* Docker inspection */
     Map<String, Object> inspection
-    String getContainerId() { inspection.Id }
-    String getContainerHostname() { inspection.Config.Hostname }
+    @JsonIgnore String getContainerId() { inspection.Id }
+    @JsonIgnore String getContainerHostname() { inspection.Config.Hostname }
 
-    String getHost() { serviceHost.host }
-    Map<Integer, Integer> getPorts() { tcpPorts }
-    Integer getPort() { ports.values().find() }
-    Integer getTcpPort() { tcpPorts.values().find() }
-    Integer getUdpPort() { udpPorts.values().find() }
+    @JsonIgnore String getHost() { serviceHost.host }
+    @JsonIgnore Map<Integer, Integer> getPorts() { tcpPorts }
+    @JsonIgnore Integer getPort() { ports.values().find() }
+    @JsonIgnore Integer getTcpPort() { tcpPorts.values().find() }
+    @JsonIgnore Integer getUdpPort() { udpPorts.values().find() }
 
 
     @Override

src/main/groovy/com/avast/gradle/dockercompose/ServiceHost.groovy

@@ -2,15 +2,7 @@ package com.avast.gradle.dockercompose
 
 import groovy.transform.Immutable
 
-// @Immutable annotation generates a code that uses ImmutableASTTransformation class from Groovy library.
-// When compiling for Gradle 5+ (so Groovy 2.5+) then the generated code uses a new method that was added in Groovy 2.5.
-// Therefore this method is not available in Groovy 2.4, so in Gradle 4.x.
-// So we disabled the @Immutable annotations because we want to support also Gradle 4.x users.
-// We can uncomment them if one of these conditions were met:
-//  1. Groovy of the latest Gradle fixes this forward compatibility.
-//  2. There is almost no users of Gradle 4.x.
-
-//@Immutable
+@Immutable
 class ServiceHost {
     String host
     ServiceHostType type

src/main/groovy/com/avast/gradle/dockercompose/ServiceInfo.groovy

@@ -1,5 +1,6 @@
 package com.avast.gradle.dockercompose
 
+import com.fasterxml.jackson.annotation.JsonIgnore
 import groovy.transform.Immutable
 
 @Immutable(knownImmutableClasses = [ContainerInfo], copyWith = true)
@@ -8,15 +9,15 @@ class ServiceInfo {
     /* Key is instance name, for example service_1 */
     Map<String, ContainerInfo> containerInfos = [:]
 
-    String getHost() { firstContainer?.serviceHost.host }
-    Map<Integer, Integer> getPorts() { tcpPorts }
-    Map<Integer, Integer> getTcpPorts() { firstContainer?.tcpPorts ?: [:] }
-    Map<Integer, Integer> getUdpPorts() { firstContainer?.udpPorts ?: [:] }
-    Integer getPort() { firstContainer?.port }
-    Integer getTcpPort() { firstContainer?.tcpPort }
-    Integer getUdpPort() { firstContainer?.udpPort }
+    @JsonIgnore String getHost() { firstContainer?.serviceHost.host }
+    @JsonIgnore Map<Integer, Integer> getPorts() { tcpPorts }
+    @JsonIgnore Map<Integer, Integer> getTcpPorts() { firstContainer?.tcpPorts ?: [:] }
+    @JsonIgnore Map<Integer, Integer> getUdpPorts() { firstContainer?.udpPorts ?: [:] }
+    @JsonIgnore Integer getPort() { firstContainer?.port }
+    @JsonIgnore Integer getTcpPort() { firstContainer?.tcpPort }
+    @JsonIgnore Integer getUdpPort() { firstContainer?.udpPort }
 
-    ContainerInfo getFirstContainer() {
+    @JsonIgnore ContainerInfo getFirstContainer() {
         containerInfos.values()?.find()
     }
 

src/main/groovy/com/avast/gradle/dockercompose/TasksConfigurator.groovy

@@ -1,6 +1,8 @@
 package com.avast.gradle.dockercompose
 
 import com.avast.gradle.dockercompose.tasks.*
+import com.fasterxml.jackson.core.type.TypeReference
+import com.fasterxml.jackson.databind.ObjectMapper
 import groovy.transform.CompileStatic
 import groovy.transform.PackageScope
 import org.gradle.api.Project
@@ -130,7 +132,9 @@ class TasksConfigurator {
 
         // composeSettings.tasksConfigurator is null when the doFirst actions run with the configuration cache enabled.
         def composeSettings = this.composeSettings
-        def servicesInfos = upTask.map { it.servicesInfos }
+        def servicesInfos = upTask.flatMap { it.servicesInfosFile }.map {
+            new ObjectMapper().readValue(it.asFile, new TypeReference<Map<String, ServiceInfo>>() {})
+        }
         if (task instanceof ProcessForkOptions) task.doFirst {
             composeSettings.exposeAsEnvironmentInternal(task as ProcessForkOptions, servicesInfos.get())
         }

src/main/groovy/com/avast/gradle/dockercompose/tasks/ComposeUp.groovy

@@ -6,6 +6,7 @@ import com.avast.gradle.dockercompose.DockerExecutor
 import com.avast.gradle.dockercompose.ServiceHost
 import com.avast.gradle.dockercompose.ServiceInfo
 import com.avast.gradle.dockercompose.ServiceInfoCache
+import com.fasterxml.jackson.databind.ObjectMapper
 import groovy.json.JsonSlurper
 import org.gradle.api.DefaultTask
 import org.gradle.api.file.DirectoryProperty
@@ -14,13 +15,18 @@ import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.TaskAction
 
+import java.nio.file.Paths
 import java.time.Duration
 import java.time.Instant
 
 abstract class ComposeUp extends DefaultTask {
 
+    @OutputFile
+    abstract RegularFileProperty getServicesInfosFile()
+
     @Internal
     Boolean wasReconnected = false // for tests
 
@@ -100,6 +106,8 @@ abstract class ComposeUp extends DefaultTask {
     ComposeUp() {
         group = 'docker'
         description = 'Builds and starts containers of docker-compose project'
+        setServicesInfosFile()
+        outputs.upToDateWhen { false }
     }
 
     @TaskAction
@@ -156,6 +164,7 @@ abstract class ComposeUp extends DefaultTask {
             } else {
                 serviceInfoCache.get().clear()
             }
+            writeServicesInfosFile()
         }
         catch (Exception e) {
             logger.debug("Failed to start-up Docker containers", e)
@@ -366,4 +375,17 @@ abstract class ComposeUp extends DefaultTask {
         }
         servicesInfos.collect { it -> it.copyWith(containerInfos: it.containerInfos.values().collect { newContainerInfos.getOrDefault(it.instanceName, it) }.collectEntries { [(it.instanceName): it] }) }
     }
+
+    void setServicesInfosFile() {
+        def normalName = 'composeUp'
+        def suffix = (name == normalName) ? '' : "-${name.take(name.size() - normalName.size())}"
+        def path = Paths.get('tmp', 'com.avast.gradle.docker-compose', "services-infos${suffix}.json")
+        servicesInfosFile.set(project.layout.buildDirectory.file(path.toString()))
+    }
+
+    void writeServicesInfosFile() {
+        def f = servicesInfosFile.get().asFile
+        f.parentFile.mkdirs()
+        new ObjectMapper().writeValue(f, servicesInfos)
+    }
 }

src/test/groovy/com/avast/gradle/dockercompose/DockerComposePluginTest.groovy

@@ -7,13 +7,17 @@ import com.avast.gradle.dockercompose.tasks.ComposeLogs
 import com.avast.gradle.dockercompose.tasks.ComposePull
 import com.avast.gradle.dockercompose.tasks.ComposePush
 import com.avast.gradle.dockercompose.tasks.ComposeUp
+import com.fasterxml.jackson.core.type.TypeReference
+import com.fasterxml.jackson.databind.ObjectMapper
 import org.gradle.api.Task
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.api.tasks.testing.Test
 import org.gradle.testfixtures.ProjectBuilder
 import spock.lang.IgnoreIf
 import spock.lang.Specification
 
+import java.nio.file.Paths
+
 import static com.avast.gradle.dockercompose.util.VersionNumber.parse
 
 class DockerComposePluginTest extends Specification {
@@ -602,4 +606,41 @@ class DockerComposePluginTest extends Specification {
                 network_mode: service:gw
         ''']
     }
+
+    def "deserialize servicesInfosFile and compare to original"() {
+        def f = Fixture.withNginx()
+        when:
+        f.project.tasks.composeBuild.build()
+        f.project.tasks.composeUp.up()
+        def mapper = new ObjectMapper()
+        def file = f.project.tasks.composeUp.servicesInfosFile.get().asFile
+        def deserializedServicesInfos = mapper.readValue(file, new TypeReference<Map<String, ServiceInfo>>() {})
+        then:
+        noExceptionThrown()
+        deserializedServicesInfos == f.project.tasks.composeUp.servicesInfos
+        cleanup:
+        f.project.tasks.composeDown.down()
+        f.close()
+    }
+
+    def "verify servicesInfosFile path"() {
+        def project = ProjectBuilder.builder().build()
+        when:
+        project.plugins.apply 'docker-compose'
+        project.dockerCompose {}
+        File file = project.tasks.composeUp.servicesInfosFile.get().asFile
+        then:
+        file.toPath().endsWith(Paths.get('build', 'tmp', 'com.avast.gradle.docker-compose', 'services-infos.json'))
+    }
+
+    def "verify servicesInfosFile path for nested configuration"() {
+        def project = ProjectBuilder.builder().build()
+        when:
+        project.plugins.apply 'docker-compose'
+        project.dockerCompose {
+            nested {}
+        }
+        def file = project.tasks.nestedComposeUp.servicesInfosFile.get().asFile
+        then:file.toPath().endsWith(Paths.get('build', 'tmp', 'com.avast.gradle.docker-compose', 'services-infos-nested.json'))
+    }
 }