Merge pull request #15605 from apache/grailsBomRestructure

Backport Grails Bom Restructure from Hibernate 7 branch

Author: jdaugherty

.github/workflows/gradle.yml

@@ -25,6 +25,32 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 jobs:
+  validateDependencies:
+    name: 'Validate Dependency Versions'
+    runs-on: ubuntu-24.04
+    steps:
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@v6
+      - name: "☕️ Setup JDK"
+        uses: actions/setup-java@v4
+        with:
+          distribution: liberica
+          java-version: 17
+      - name: "🐘 Setup Gradle"
+        uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
+        with:
+          develocity-access-key: ${{ secrets.GRAILS_DEVELOCITY_ACCESS_KEY  }}
+      - name: "🔍 Validate grails-core dependency versions"
+        run: >
+          ./gradlew validateDependencyVersions
+          --continue
+          --stacktrace
+      - name: "🔍 Validate grails-gradle dependency versions"
+        working-directory: 'grails-gradle'
+        run: >
+          ./gradlew validateDependencyVersions
+          --continue
+          --stacktrace
   buildGradle:
     name: 'Build Gradle Plugins'
     strategy:

.gitignore

@@ -52,6 +52,9 @@ prodDb.mv.db
 testWatchedFile.properties
 _alternativeTable.gsp
 **/src/en/ref/Versions/Grails BOM.adoc
+**/src/en/ref/Versions/Grails BOM Hibernate5.adoc
+**/src/en/ref/Versions/Grails BOM Micronaut.adoc
+**/src/en/ref/Configuration/Application Properties.adoc
 stacktrace.log
 target
 tmp/

build-logic/docs-core/src/main/groovy/org/apache/grails/gradle/tasks/bom/ExtractDependenciesTask.groovy

@@ -32,6 +32,7 @@ import org.gradle.api.artifacts.DependencyConstraint
 import org.gradle.api.artifacts.ExcludeRule
 import org.gradle.api.artifacts.ModuleDependency
 import org.gradle.api.artifacts.component.ModuleComponentSelector
+import org.gradle.api.artifacts.component.ProjectComponentSelector
 import org.gradle.api.artifacts.result.DependencyResult
 import org.gradle.api.artifacts.result.ResolvedDependencyResult
 import org.gradle.api.file.ConfigurableFileCollection
@@ -83,12 +84,28 @@ abstract class ExtractDependenciesTask extends DefaultTask {
     @Input
     abstract MapProperty<String, String> getProjectCoordinateProperties()
 
+    /**
+     * When {@code true}, transitive platform dependencies that are not explicitly
+     * registered in {@code combinedPlatforms} / {@code dependencies.gradle} will be
+     * auto-registered in {@link PropertyNameCalculator} instead of causing a build
+     * failure.  This is required for BOMs that import an external platform via the
+     * gradle module format (e.g. {@code micronaut-platform}) which itself imports
+     * many sub-BOMs that Grails does not manage directly.
+     *
+     * <p>Defaults to {@code false} so that existing BOMs (grails-bom, grails-base-bom)
+     * retain the strict validation that every platform dependency has a known property
+     * name in {@code dependencies.gradle}.</p>
+     */
+    @Input
+    abstract Property<Boolean> getAutoRegisterTransitivePlatforms()
+
     void setConfiguration(NamedDomainObjectProvider<Configuration> config) {
         dependencyArtifacts.from(config)
         configurationName.set(config.name)
     }
 
     ExtractDependenciesTask() {
+        autoRegisterTransitivePlatforms.convention(false)
         doFirst {
             if (!project.pluginManager.hasPlugin('java-platform')) {
                 throw new GradleException(/The 'java-platform' plugin must be applied to the project to use this task./)
@@ -188,6 +205,13 @@ abstract class ExtractDependenciesTask extends DefaultTask {
             }
 
             ResolvedDependencyResult dep = (ResolvedDependencyResult) result
+
+            // Skip project dependencies (e.g. platform(project(':grails-bom'))) since their
+            // constraints are already captured through the explicit constraints population
+            if (dep.requested instanceof ProjectComponentSelector) {
+                continue
+            }
+
             ModuleComponentSelector moduleComponentSelector = dep.requested as ModuleComponentSelector
 
             // Any non-constraint via api dependency should *always* be a platform dependency, so expand each of those
@@ -199,6 +223,16 @@ abstract class ExtractDependenciesTask extends DefaultTask {
 
             // fetch the BOM as a pom file so it can be expanded
             ExtractedDependencyConstraint constraint = propertyNameCalculator.calculate(bomCoordinate.groupId, bomCoordinate.artifactId, bomCoordinate.version, true)
+            if (!constraint) {
+                if (autoRegisterTransitivePlatforms.get()) {
+                    // Auto-register the transitive platform so it can be documented and expanded,
+                    // but without a version property reference since the version is managed by the
+                    // parent platform (e.g. micronaut-platform), not by a Grails property.
+                    constraint = new ExtractedDependencyConstraint(bomCoordinate.coordinates)
+                } else {
+                    throw new GradleException("Failed to find a property name for BOM dependency: ${bomCoordinate.coordinates}. All platform dependencies must have a property name defined meeting the naming requirements.")
+                }
+            }
             constraint.source = bomCoordinate.artifactId
             constraints.put(bomCoordinate.toCoordinateHolder(), constraint)
 

build-logic/plugins/build.gradle

@@ -74,5 +74,9 @@ gradlePlugin {
             id = 'org.apache.grails.buildsrc.repo'
             implementationClass = 'org.apache.grails.buildsrc.GrailsRepoSettingsPlugin'
         }
+        register('grailsDependencyValidator') {
+            id = 'org.apache.grails.buildsrc.dependency-validator'
+            implementationClass = 'org.apache.grails.buildsrc.GrailsDependencyValidatorPlugin'
+        }
     }
 }

build-logic/plugins/src/main/groovy/org/apache/grails/buildsrc/GradleUtils.groovy

@@ -48,6 +48,10 @@ class GradleUtils {
             def v = findProperty(project, name)
             return v == null ? null : Integer.valueOf(v as String) as T
         }
+        if (type && (type == Boolean || type == boolean.class)) {
+            def v = findProperty(project, name)
+            return v == null ? null : Boolean.parseBoolean(v as String) as T
+        }
 
         findProperty(project, name) as T
     }