Update dependency resolution (#4)

* sort filetree entries

* refactor Configurations/Attributes

* add `exclusiveContent` filter for test projects

* update test for project aggregation

* wip

* gradle 8.9

* make testFixture util public

* minor build config tweaks

* Update Configurations

- Fix extendsFrom.
- Add Category attribute (apparently it's better than Usage? Although there's no explanation for this gradle/gradle#27991 (comment))
- Experiment with filtering via artifact view... (but it doesn't work because Gradle sucks gradle/gradle#27991)
- Create Configurations rather than register them, because Configurations get eagerly created anyway.

* rename `named` to `name`

(initially done to avoid `val name`'s getting clashing with `Named#getNamed()`, but the property is private so it doesn't have a getter so there's no clash)

* rename DevPublishService to match class name

* mark task constructors as internal

* sort FileTree elements, because the order isn't stable, even on the same machine

* refactoring to make simple, mark TaskActions as internal

* make Configurations non-visible by default

* tidy kdoc

* change DevPublishTasksContainer to actual class, not an abstract Gradle managed type

* update kdoc

* add lazy logging utils

* fix ApiPropagationTest

* misc tidying

* update api dump

* fix/tidy MultiProjectTest

* fix/tidy ApiPropagationTest

* update config cache property names in gradle.properties

* add more logger utils

(they're not used, but they're nice to have)

* add Task onlyIf/doLast/doFirst typesafe utils

* update file checksums

- Hide checksum type, and rename function so 'md5' isn't implied.
- Use SHA-256 (md5 vs sha256 doesn't really matter, but why not)
- Base64 encode (smaller log output)

* big ol' refactor to support checksums per publication

* disable Kotest autoscan

* prettier printing of checksums debug string

* add Kotest-GradleTestKit assertions

* add more tags to Gradle Plugin

* update Gradle plugin test to test up-to-date checks

* de-dupe createPublicationData

* remove unused functions

* tidy configurations

* fix repos being nested

* use shouldContain as infix fun

* test a single project

* move checksum utils to internal package

Author: aSemy

api/dev-publish-plugin.api

@@ -3,6 +3,7 @@ public final class dev/adamko/gradle/dev_publish/DevPublishPlugin : org/gradle/a
 	public static final field DEV_PUB__EXTENSION_NAME Ljava/lang/String;
 	public static final field DEV_PUB__MAVEN_REPO_DIR Ljava/lang/String;
 	public static final field DEV_PUB__MAVEN_REPO_NAME Ljava/lang/String;
+	public static final field DEV_PUB__PUBLICATION_API_DEPENDENCIES Ljava/lang/String;
 	public static final field DEV_PUB__PUBLICATION_DEPENDENCIES Ljava/lang/String;
 	public static final field DEV_PUB__PUBLICATION_INCOMING Ljava/lang/String;
 	public static final field DEV_PUB__PUBLICATION_OUTGOING Ljava/lang/String;

build.gradle.kts

@@ -14,10 +14,9 @@ project.group = "dev.adamko.gradle"
 
 dependencies {
   testFixturesApi(gradleTestKit())
-
-  testImplementation(platform(libs.kotest.bom))
-  testImplementation(libs.kotest.runnerJUnit5)
-  testImplementation(libs.kotest.assertionsCore)
+  testFixturesApi(platform(libs.kotest.bom))
+  testFixturesApi(libs.kotest.runnerJUnit5)
+  testFixturesApi(libs.kotest.assertionsCore)
 }
 
 

src/main/kotlin/DevPublishPlugin.kt

@@ -2,17 +2,21 @@ package dev.adamko.gradle.dev_publish
 
 import dev.adamko.gradle.dev_publish.data.DevPubAttributes
 import dev.adamko.gradle.dev_publish.data.DevPubConfigurationsContainer
+import dev.adamko.gradle.dev_publish.data.PublicationData
 import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
+import dev.adamko.gradle.dev_publish.internal.checksums.CreatePublicationChecksum.Companion.createPublicationChecksum
+import dev.adamko.gradle.dev_publish.internal.checksums.LoadPublicationChecksum.Companion.loadPublicationChecksum
+import dev.adamko.gradle.dev_publish.internal.checksums.checksumsToDebugString
 import dev.adamko.gradle.dev_publish.services.DevPublishService
 import dev.adamko.gradle.dev_publish.services.DevPublishService.Companion.SERVICE_NAME
 import dev.adamko.gradle.dev_publish.tasks.DevPublishTasksContainer
-import dev.adamko.gradle.dev_publish.utils.checksumsToDebugString
-import java.io.File
+import dev.adamko.gradle.dev_publish.utils.*
 import javax.inject.Inject
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.file.ProjectLayout
+import org.gradle.api.logging.Logging
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.plugins.ExtensionContainer
 import org.gradle.api.provider.Provider
@@ -22,6 +26,7 @@ import org.gradle.api.publish.maven.MavenPublication
 import org.gradle.api.publish.maven.plugins.MavenPublishPlugin
 import org.gradle.api.publish.maven.tasks.PublishToMavenRepository
 import org.gradle.api.services.BuildServiceRegistry
+import org.gradle.api.tasks.PathSensitivity.RELATIVE
 import org.gradle.kotlin.dsl.*
 import org.gradle.language.base.plugins.LifecycleBasePlugin
 import org.gradle.language.base.plugins.LifecycleBasePlugin.CHECK_TASK_NAME
@@ -66,24 +71,20 @@ constructor(
 
     devPubTasks.updateDevRepo.configure {
       // update this project's maven-test-repo with files from other subprojects
-      from(devPubConfigurations.testMavenPublicationConsumer.map { conf ->
-        conf.incoming.artifacts.artifactFiles
-      })
+      repositoryContents.from(devPubConfigurations.devMavenPublicationResolver)
     }
 
-    devPubConfigurations.testMavenPublicationProvider.configure {
-      outgoing {
-        artifact(devPubExtension.devMavenRepo) {
-          builtBy(devPubTasks.updateDevRepo)
-        }
+    devPubConfigurations.devMavenPublicationApiElements.outgoing {
+      // Only share repos from _this_ subproject, not from the aggregated repo
+      artifact(devPubExtension.publicationsStore) {
+        builtBy(devPubTasks.publishAllToDevRepo)
       }
     }
 
     configureMavenPublishingPlugin(
       project = project,
       devPubExtension = devPubExtension,
       devPubTasks = devPubTasks,
-      devPublishService = devPubService,
     )
 
     configureBasePlugin(
@@ -108,21 +109,16 @@ constructor(
     }
   }
 
-  private fun BuildServiceRegistry.registerDevPubService(): Provider<DevPublishService> {
-    return registerIfAbsent(
-      SERVICE_NAME,
-      DevPublishService::class
-    ) {
+  private fun BuildServiceRegistry.registerDevPubService(): Provider<DevPublishService> =
+    registerIfAbsent(SERVICE_NAME, DevPublishService::class) {
       maxParallelUsages.set(1)
     }
-  }
 
-  /** React to [MavenPublishPlugin], and configure the appropriate DevPublish tasks */
+  /** React to [MavenPublishPlugin], and configure the appropriate DevPublish tasks. */
   private fun configureMavenPublishingPlugin(
     project: Project,
     devPubExtension: DevPublishPluginExtension,
     devPubTasks: DevPublishTasksContainer,
-    devPublishService: Provider<DevPublishService>,
   ) {
     project.plugins.withType<MavenPublishPlugin>().configureEach {
       project.extensions.configure<PublishingExtension> {
@@ -131,10 +127,10 @@ constructor(
         }
 
         devPubTasks.generatePublicationChecksum.configure {
-          publicationData.addAllLater(devPublishService.map { service ->
+          publicationData.addAllLater(providers.provider {
             publications
               .withType<MavenPublication>()
-              .mapNotNull { service.createPublicationData(it) }
+              .mapNotNull { createPublicationData(it) }
           })
         }
       }
@@ -157,53 +153,56 @@ constructor(
     inputs.property("repoIsDevPub", repoIsDevPub)
 
     inputs
-      // must convert to FileTree, because the directory might not exist, and
+      // Must convert to FileTree, because the directory might not exist, and
       // Gradle won't accept directories that don't exist as inputs.
-      .files(checksumsStore.asFileTree)
+      .files(checksumsStore.asFileTree.sortedElements())
       .withPropertyName("devPubChecksumsStoreFiles")
+      .withPathSensitivity(RELATIVE)
 
     outputs
-      .files(publicationStore.map { it.asFileTree })
+      .files(publicationStore.map { it.asFileTree.sortedElements() })
       .withPropertyName("devPubPublicationStore")
 
-    val publicationData = devPubService.flatMap { service ->
-      providers.provider { service.createPublicationData(publication) }
-    }
-    val currentChecksum: Provider<String> = publicationData.map { data ->
-      data.createChecksumContent()
-    }
+    val currentProjectDir = layout.projectDirectory
 
-    val storedChecksum: Provider<String> = providers.zip(
-      publicationData,
-      checksumsStore,
-    ) { data, checksumStore ->
-      checksumStore.asFile
-        .resolve(data?.checksumFilename ?: "unknown")
-        .takeIf(File::exists)
-        ?.readText()
+    val publicationData = providers.provider { createPublicationData(publication) }
+
+    val currentChecksum = providers.createPublicationChecksum {
+      this.projectDir.set(currentProjectDir)
+      this.artifacts.from(publicationData.map { it.artifacts })
+      this.identifier.set(publicationData.flatMap { it.identifier })
     }
 
-    onlyIf("current checksums don't match stored checksum") {
-      if (!repoIsDevPub.get()) return@onlyIf true
+    val storedChecksum = providers.loadPublicationChecksum {
+      this.checksumFilename.set(publicationData.map { "${it.name}.txt" })
+      this.checksumsStore.set(checksumsStore)
+    }
 
-      if (logger.isInfoEnabled) {
-        logger.info(checksumsToDebugString(currentChecksum, storedChecksum))
+    onlyIf_("current checksums don't match stored checksum") {
+      if (!repoIsDevPub.get()) {
+        true
+      } else {
+        val enabled = currentChecksum.orNull != storedChecksum.orNull
+        logger.info {
+          val checksums = checksumsToDebugString(currentChecksum, storedChecksum).prependIndent("  ")
+          val match = if (!enabled) "match" else "do not match"
+          "[$path] currentChecksum and storedChecksum $match\n${checksums}"
+        }
+        enabled
       }
-
-      currentChecksum.orNull != storedChecksum.orNull
     }
 
-    doFirst("clear staging repo") {
+    doFirst_("clear staging repo") {
       if (repoIsDevPub.get()) {
         // clear the staging repo so that we can only sync this publication's files in the doLast {} below
         fs.delete { delete(stagingDevMavenRepo) }
         stagingDevMavenRepo.get().asFile.mkdirs()
       }
     }
 
-    doLast("sync staging repo to publication store") {
+    doLast_("sync staging repo to publication store") {
       if (repoIsDevPub.get()) {
-        logger.info("[$path] Syncing staging-dev-maven-repo to publication store ${publicationStore.get().asFile.invariantSeparatorsPath}")
+        logger.info { ("[$path] Syncing staging-dev-maven-repo to publication store ${publicationStore.get().asFile.invariantSeparatorsPath}") }
         fs.sync {
           from(stagingDevMavenRepo)
           into(publicationStore)
@@ -231,6 +230,29 @@ constructor(
     }
   }
 
+  /** Create an instance of [PublicationData] from [publication]. */
+  private fun createPublicationData(
+    publication: MavenPublication?,
+  ): PublicationData? {
+    if (publication == null) {
+      logger.warn("cannot create PublicationData - MavenPublication is null")
+      return null
+    }
+
+    val artifacts = providers.provider { publication.artifacts }
+      .map { artifacts ->
+        objects.fileCollection()
+          .from(artifacts.map { it.file })
+          .builtBy(artifacts)
+      }
+    val identifier = providers.provider { publication.run { "$groupId:$artifactId:$version" } }
+
+    return objects.newInstance<PublicationData>(publication.name).apply {
+      this.identifier.set(identifier)
+      this.artifacts.from(artifacts)
+    }
+  }
+
   companion object {
     const val DEV_PUB__EXTENSION_NAME = "devPublish"
 
@@ -243,7 +265,10 @@ constructor(
     const val DEV_PUB__MAVEN_REPO_DIR = "maven-dev"
 
     const val DEV_PUB__PUBLICATION_DEPENDENCIES = "devPublication"
+    const val DEV_PUB__PUBLICATION_API_DEPENDENCIES = "devPublicationApi"
     const val DEV_PUB__PUBLICATION_INCOMING = "devPublicationResolvableElements"
     const val DEV_PUB__PUBLICATION_OUTGOING = "devPublicationConsumableElements"
+
+    private val logger = Logging.getLogger(DevPublishService::class.java)
   }
 }

src/main/kotlin/data/DevPubConfigurationsContainer.kt

@@ -1,5 +1,6 @@
 package dev.adamko.gradle.dev_publish.data
 
+import dev.adamko.gradle.dev_publish.DevPublishPlugin
 import dev.adamko.gradle.dev_publish.DevPublishPlugin.Companion.DEV_PUB__PUBLICATION_DEPENDENCIES
 import dev.adamko.gradle.dev_publish.DevPublishPlugin.Companion.DEV_PUB__PUBLICATION_INCOMING
 import dev.adamko.gradle.dev_publish.DevPublishPlugin.Companion.DEV_PUB__PUBLICATION_OUTGOING
@@ -8,7 +9,6 @@ import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
 import dev.adamko.gradle.dev_publish.utils.consumable
 import dev.adamko.gradle.dev_publish.utils.declarable
 import dev.adamko.gradle.dev_publish.utils.resolvable
-import org.gradle.api.NamedDomainObjectProvider
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.artifacts.ConfigurationContainer
 import org.gradle.api.artifacts.dsl.DependencyHandler
@@ -30,38 +30,43 @@ class DevPubConfigurationsContainer(
     dependencies.attributesSchema.attribute(DevPublishTypeAttribute)
   }
 
-  private val testMavenPublicationDependencies = configurations.registerPublicationsDependencies()
-  val testMavenPublicationConsumer = configurations.registerPublicationsConsumer()
-  val testMavenPublicationProvider = configurations.registerPublicationsProvider()
+  private val devPublicationApiDependencies: Configuration =
+    configurations.create(DevPublishPlugin.DEV_PUB__PUBLICATION_API_DEPENDENCIES) {
+      description =
+        "Declare dependencies on test Maven Publications." +
+            "The publications will also be shared with consumers of this subproject."
+      declarable()
+    }
 
-  private fun ConfigurationContainer.registerPublicationsDependencies(): NamedDomainObjectProvider<Configuration> =
-    register(DEV_PUB__PUBLICATION_DEPENDENCIES) {
-      description = "Declare dependencies on test Maven Publications"
+  private val devPublicationDependencies: Configuration =
+    configurations.create(DEV_PUB__PUBLICATION_DEPENDENCIES) {
+      description = "Declare dependencies on test Maven Publications."
       declarable()
     }
 
-  private fun ConfigurationContainer.registerPublicationsConsumer(): NamedDomainObjectProvider<Configuration> =
-    register(DEV_PUB__PUBLICATION_INCOMING) {
-      description = "Resolve test Maven Publications"
+  val devMavenPublicationResolver: Configuration =
+    configurations.create(DEV_PUB__PUBLICATION_INCOMING) {
+      description = "Resolve dev Maven Publications."
       resolvable()
+      extendsFrom(devPublicationApiDependencies)
+      extendsFrom(devPublicationDependencies)
       attributes {
         attribute(USAGE_ATTRIBUTE, devPubAttributes.devPublishUsage)
         attribute(CATEGORY_ATTRIBUTE, devPubAttributes.devPublishCategory)
         attribute(DevPublishTypeAttribute, devPubAttributes.mavenRepositoryType)
       }
-      extendsFrom(testMavenPublicationDependencies.get())
     }
 
-  private fun ConfigurationContainer.registerPublicationsProvider(): NamedDomainObjectProvider<Configuration> =
-    register(DEV_PUB__PUBLICATION_OUTGOING) {
-      description = "Provide test Maven Publications"
+  val devMavenPublicationApiElements: Configuration =
+    configurations.create(DEV_PUB__PUBLICATION_OUTGOING) {
+      description = "Provide dev Maven Publications."
       consumable()
       attributes {
         attribute(USAGE_ATTRIBUTE, devPubAttributes.devPublishUsage)
         attribute(CATEGORY_ATTRIBUTE, devPubAttributes.devPublishCategory)
         attribute(DevPublishTypeAttribute, devPubAttributes.mavenRepositoryType)
       }
-      extendsFrom(testMavenPublicationDependencies.get())
+      extendsFrom(devPublicationApiDependencies)
     }
 
   @DevPublishInternalApi

src/main/kotlin/data/PublicationData.kt

@@ -1,33 +1,30 @@
 package dev.adamko.gradle.dev_publish.data
 
 import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
-import dev.adamko.gradle.dev_publish.utils.FileChecksumSeparator
-import dev.adamko.gradle.dev_publish.utils.checksum
 import javax.inject.Inject
 import org.gradle.api.Named
 import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.provider.Property
 import org.gradle.api.publish.maven.MavenPublication
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFiles
-import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.PathSensitive
 import org.gradle.api.tasks.PathSensitivity.RELATIVE
 
 /**
  * Specific information about a [MavenPublication] that will be used to create a checksum file.
  *
- * @param[named] must match the publication name, [MavenPublication.getName]
+ * @param[name] must match the publication name, [MavenPublication.getName]
  */
 abstract class PublicationData
 @Inject
 @DevPublishInternalApi
 constructor(
-  private val named: String
+  private val name: String,
 ) : Named {
 
   /**
-   * The artifacts inside a [MavenPublication]
+   * The artifacts inside a [MavenPublication].
    *
    * @see MavenPublication.getArtifacts
    */
@@ -46,23 +43,5 @@ constructor(
   abstract val identifier: Property<String>
 
   @Input
-  override fun getName(): String = named
-
-  @get:Internal
-  internal val checksumFilename = "$named.txt"
-
-  internal fun createChecksumContent(): String {
-    val md5 = artifacts
-      .map { "${it.invariantSeparatorsPath}${FileChecksumSeparator}${it.checksum()}" }
-      .sorted()
-      .joinToString("\n")
-
-    val identifier = identifier.get()
-
-    return /* language=TEXT */ """
-      |$identifier
-      |---
-      |$md5
-    """.trimMargin()
-  }
+  override fun getName(): String = name
 }