Refactor OciImageDefinition.Variant.parentImages -> dependencies

SgtSilvio · Sep 1, 2024 · d027b40 · d027b40
1 parent a409d9e
commit d027b40
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -54,8 +54,8 @@ oci {
     }
     imageDefinitions.register("main") {
         allPlatforms {
-            parentImages {
-                add("library:eclipse-temurin:21.0.2_13-jre-jammy")
+            dependencies {
+                runtime("library:eclipse-temurin:21.0.2_13-jre-jammy")
             }
             config {
                 entryPoint = listOf("java", "-jar")

diff --git a/examples/java-app-groovy-dsl/build.gradle b/examples/java-app-groovy-dsl/build.gradle
@@ -28,8 +28,8 @@ oci {
     }
     imageDefinitions.register("main") {
         allPlatforms {
-            parentImages {
-                add("library:eclipse-temurin:21.0.2_13-jre-jammy")
+            dependencies {
+                runtime.add("library:eclipse-temurin:21.0.2_13-jre-jammy")
             }
             config {
                 entryPoint = ["java", "-jar"]

diff --git a/examples/java-app/build.gradle.kts b/examples/java-app/build.gradle.kts
@@ -28,8 +28,8 @@ oci {
     }
     imageDefinitions.register("main") {
         allPlatforms {
-            parentImages {
-                add("library:eclipse-temurin:21.0.2_13-jre-jammy")
+            dependencies {
+                runtime("library:eclipse-temurin:21.0.2_13-jre-jammy")
             }
             config {
                 entryPoint = listOf("java", "-jar")

diff --git a/src/functionalTest/kotlin/io/github/sgtsilvio/gradle/oci/PublishMetadataTest.kt b/src/functionalTest/kotlin/io/github/sgtsilvio/gradle/oci/PublishMetadataTest.kt
@@ -47,8 +47,8 @@ internal class PublishMetadataTest {
                 }
                 imageDefinitions.register("main") {
                     allPlatforms {
-                        parentImages {
-                            add("library:eclipse-temurin:17.0.7_7-jre-jammy")
+                        dependencies {
+                            runtime("library:eclipse-temurin:17.0.7_7-jre-jammy")
                         }
                         config {
                             entryPoint.set(listOf("java", "-jar", "app.jar"))

diff --git a/src/functionalTest/kotlin/io/github/sgtsilvio/gradle/oci/TestProject.kt b/src/functionalTest/kotlin/io/github/sgtsilvio/gradle/oci/TestProject.kt
@@ -56,8 +56,8 @@ internal class TestProject(projectDir: File) {
                 }
                 imageDefinitions.register("main") {
                     allPlatforms {
-                        parentImages {
-                            add("library:eclipse-temurin:17.0.7_7-jre-jammy")
+                        dependencies {
+                            runtime("library:eclipse-temurin:17.0.7_7-jre-jammy")
                         }
                         config {
                             entryPoint.set(listOf("java", "-jar", "app.jar"))

diff --git a/src/main/kotlin/io/github/sgtsilvio/gradle/oci/dsl/OciImageDefinition.kt b/src/main/kotlin/io/github/sgtsilvio/gradle/oci/dsl/OciImageDefinition.kt
@@ -44,15 +44,17 @@ interface OciImageDefinition : Named {
     }
 
     interface Variant {
-        val parentImages: ParentImages
+        val dependencies: Dependencies
         val config: Config
         val layers: Layers
 
-        fun parentImages(configuration: Action<in ParentImages>)
+        fun dependencies(configuration: Action<in Dependencies>)
         fun config(configuration: Action<in Config>)
         fun layers(configuration: Action<in Layers>)
 
-        interface ParentImages : OciImageDependencyCollector<Unit>
+        interface Dependencies : DependencyConstraintFactories {
+            val runtime: OciImageDependencyCollector<Unit>
+        }
 
         interface Config {
             val creationTime: Property<Instant>
@@ -99,7 +101,7 @@ interface OciImageDefinition : Named {
     interface VariantScope {
         val layers: Layers
 
-        fun parentImages(configuration: Action<in Variant.ParentImages>)
+        fun dependencies(configuration: Action<in Variant.Dependencies>)
         fun config(configuration: Action<in Variant.Config>)
         fun layers(configuration: Action<in Layers>)
 

diff --git a/src/main/kotlin/io/github/sgtsilvio/gradle/oci/dsl/OciImageDependencyCollector.kt b/src/main/kotlin/io/github/sgtsilvio/gradle/oci/dsl/OciImageDependencyCollector.kt
@@ -9,7 +9,7 @@ import org.gradle.api.provider.ProviderConvertible
 /**
  * @author Silvio Giebl
  */
-interface OciImageDependencyCollector<T> : DependencyConstraintFactories {
+interface OciImageDependencyCollector<T> {
 
     val dependencies: Provider<Set<ModuleDependency>>
     val dependencyConstraints: Provider<Set<DependencyConstraint>>

diff --git a/src/main/kotlin/io/github/sgtsilvio/gradle/oci/internal/dsl/OciImageDefinitionImpl.kt b/src/main/kotlin/io/github/sgtsilvio/gradle/oci/internal/dsl/OciImageDefinitionImpl.kt
@@ -20,7 +20,7 @@ import org.gradle.api.Action
 import org.gradle.api.DomainObjectSet
 import org.gradle.api.Project
 import org.gradle.api.artifacts.*
-import org.gradle.api.artifacts.dsl.DependencyHandler
+import org.gradle.api.artifacts.dsl.DependencyConstraintHandler
 import org.gradle.api.attributes.Bundling
 import org.gradle.api.attributes.Category
 import org.gradle.api.capabilities.Capability
@@ -223,7 +223,7 @@ internal abstract class OciImageDefinitionImpl @Inject constructor(
         projectName: String,
     ) : OciImageDefinition.Variant {
 
-        final override val parentImages = objectFactory.newInstance<ParentImages>()
+        final override val dependencies = objectFactory.newInstance<Dependencies>()
         final override val config = objectFactory.newInstance<OciImageDefinition.Variant.Config>().apply {
             entryPoint.convention(null)
             arguments.convention(null)
@@ -232,8 +232,8 @@ internal abstract class OciImageDefinitionImpl @Inject constructor(
             objectFactory.newInstance<Layers>(imageDefinition.name, Optional.ofNullable(platform))
 
         init {
-            configuration.dependencies.addAllLater(parentImages.dependencies)
-            configuration.dependencyConstraints.addAllLater(parentImages.dependencyConstraints)
+            configuration.dependencies.addAllLater(dependencies.runtime.dependencies)
+            configuration.dependencyConstraints.addAllLater(dependencies.runtime.dependencyConstraints)
             val metadata = createMetadata(providerFactory)
             val metadataTask = taskContainer.createMetadataTask(imageDefinition.name, platform, metadata, projectLayout)
             configuration.outgoing.addArtifacts(providerFactory.provider {
@@ -292,25 +292,21 @@ internal abstract class OciImageDefinitionImpl @Inject constructor(
                 listProvider
             }
 
-        final override fun parentImages(configuration: Action<in OciImageDefinition.Variant.ParentImages>) =
-            configuration.execute(parentImages)
+        final override fun dependencies(configuration: Action<in OciImageDefinition.Variant.Dependencies>) =
+            configuration.execute(dependencies)
 
         final override fun config(configuration: Action<in OciImageDefinition.Variant.Config>) =
             configuration.execute(config)
 
         final override fun layers(configuration: Action<in OciImageDefinition.Variant.Layers>) =
             configuration.execute(layers)
 
-        abstract class ParentImages @Inject constructor(
-            dependencyHandler: DependencyHandler,
+        abstract class Dependencies @Inject constructor(
             objectFactory: ObjectFactory,
-        ) : OciImageDependencyCollectorImpl<Unit>(dependencyHandler, objectFactory),
-            OciImageDefinition.Variant.ParentImages {
+            dependencyConstraintHandler: DependencyConstraintHandler,
+        ) : DependencyConstraintFactoriesImpl(dependencyConstraintHandler), OciImageDefinition.Variant.Dependencies {
 
-            final override fun addInternal(dependency: ModuleDependency) = dependencies.add(dependency)
-
-            final override fun addInternal(dependencyProvider: Provider<out ModuleDependency>) =
-                dependencies.add(dependencyProvider)
+            final override val runtime = objectFactory.newInstance<OciImageDependencyCollectorImpl.Default>()
         }
 
         abstract class Layers @Inject constructor(
@@ -519,8 +515,8 @@ internal abstract class OciImageDefinitionImpl @Inject constructor(
         }
         final override val layers = objectFactory.newInstance<Layers>(platformFilter, imageDefName, filteredVariants)
 
-        final override fun parentImages(configuration: Action<in OciImageDefinition.Variant.ParentImages>) =
-            filteredVariants.configureEach { parentImages(configuration) }
+        final override fun dependencies(configuration: Action<in OciImageDefinition.Variant.Dependencies>) =
+            filteredVariants.configureEach { dependencies(configuration) }
 
         final override fun config(configuration: Action<in OciImageDefinition.Variant.Config>) =
             filteredVariants.configureEach { config(configuration) }

diff --git a/src/main/kotlin/io/github/sgtsilvio/gradle/oci/internal/dsl/OciImageDependenciesImpl.kt b/src/main/kotlin/io/github/sgtsilvio/gradle/oci/internal/dsl/OciImageDependenciesImpl.kt
@@ -5,7 +5,6 @@ import io.github.sgtsilvio.gradle.oci.attributes.*
 import io.github.sgtsilvio.gradle.oci.dsl.OciExtension
 import io.github.sgtsilvio.gradle.oci.dsl.OciImageDependencies
 import io.github.sgtsilvio.gradle.oci.dsl.OciImageDependenciesWithScopes
-import io.github.sgtsilvio.gradle.oci.dsl.ReferencableOciImageDependencyCollector
 import io.github.sgtsilvio.gradle.oci.internal.resolution.resolveOciImageInputs
 import io.github.sgtsilvio.gradle.oci.internal.string.concatCamelCase
 import io.github.sgtsilvio.gradle.oci.platform.PlatformSelector
@@ -33,8 +32,7 @@ internal abstract class OciImageDependenciesImpl @Inject constructor(
 
     final override fun getName() = name
 
-    final override val runtime: ReferencableOciImageDependencyCollector =
-        objectFactory.newInstance<ReferencableOciImageDependencyCollectorImpl>()
+    final override val runtime = objectFactory.newInstance<ReferencableOciImageDependencyCollectorImpl>()
 
     private val configuration: Configuration = configurationContainer.create(name + "OciImages").apply {
         description = "OCI image dependencies '$name'"

diff --git a/...ain/kotlin/io/github/sgtsilvio/gradle/oci/internal/dsl/OciImageDependencyCollectorImpl.kt b/...ain/kotlin/io/github/sgtsilvio/gradle/oci/internal/dsl/OciImageDependencyCollectorImpl.kt
@@ -12,14 +12,15 @@ import org.gradle.api.artifacts.dsl.DependencyHandler
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Provider
 import org.gradle.kotlin.dsl.setProperty
+import javax.inject.Inject
 
 /**
  * @author Silvio Giebl
  */
 internal abstract class OciImageDependencyCollectorImpl<T>(
     private val dependencyHandler: DependencyHandler,
     objectFactory: ObjectFactory,
-) : DependencyConstraintFactoriesImpl(dependencyHandler.constraints), OciImageDependencyCollector<T> {
+) : OciImageDependencyCollector<T> {
 
     final override val dependencies = objectFactory.setProperty<ModuleDependency>()
     final override val dependencyConstraints = objectFactory.setProperty<DependencyConstraint>()
@@ -88,4 +89,16 @@ internal abstract class OciImageDependencyCollectorImpl<T>(
         dependencyConstraintProvider: Provider<out DependencyConstraint>,
         action: Action<in DependencyConstraint>,
     ) = dependencyConstraints.add(dependencyConstraintProvider.map { action.execute(it); it })
+
+
+    internal abstract class Default @Inject constructor(
+        dependencyHandler: DependencyHandler,
+        objectFactory: ObjectFactory,
+    ) : OciImageDependencyCollectorImpl<Unit>(dependencyHandler, objectFactory) {
+
+        final override fun addInternal(dependency: ModuleDependency) = dependencies.add(dependency)
+
+        final override fun addInternal(dependencyProvider: Provider<out ModuleDependency>) =
+            dependencies.add(dependencyProvider)
+    }
 }