jdaugherty commented on code in PR #15568: URL: https://github.com/apache/grails-core/pull/15568#discussion_r3196289266
########## grails-bom/hibernate5-micronaut/build.gradle: ########## @@ -0,0 +1,254 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.grails.gradle.tasks.bom.ExtractDependenciesTask +import org.apache.grails.gradle.tasks.bom.ExtractedDependencyConstraint +import org.apache.grails.gradle.tasks.bom.PropertyNameCalculator + +buildscript { + apply from: rootProject.layout.projectDirectory.file('dependencies.gradle') +} + +plugins { + id 'java-platform' + id 'org.apache.grails.buildsrc.publish' + id 'org.apache.grails.buildsrc.sbom' +} + +version = projectVersion +group = 'org.apache.grails' + +javaPlatform { + allowDependencies() +} + +ext { + isReleaseBuild = System.getenv('GRAILS_PUBLISH_RELEASE') == 'true' + isPublishedExternal = System.getenv().containsKey('NEXUS_PUBLISH_STAGING_PROFILE_ID') + // TODO: It should be possible to pull these build names using includedBuild, but I haven't found a way to do so + gradleBuildProjects = [ + 'grails-gradle-plugins':'org.apache.grails', + 'grails-gradle-model':'org.apache.grails.gradle', + 'grails-gradle-common':'org.apache.grails.gradle', + 'grails-gradle-tasks':'org.apache.grails', + ] +} + +// Register the Micronaut platform in combinedPlatforms/combinedVersions so +// PropertyNameCalculator (used by extractConstraints and pomCustomization) can +// resolve a property name for the micronaut-platform constraint. +project.ext.combinedPlatforms = combinedPlatforms + ['micronaut-platform': "io.micronaut.platform:micronaut-platform:$micronautPlatformVersion".toString()] +project.ext.combinedVersions = combinedVersions + ['micronaut-platform.version': micronautPlatformVersion as String] + +// Coordinates we override via customBomDependencies — these must be excluded from the +// inherited platform chain so they don't conflict with our strictly-versioned overrides +// when consumers apply this BOM via enforcedPlatform. +def overriddenModules = customBomDependencies.values().collect { String coord -> + def parts = coord.split(':') + [group: parts[0], module: parts[1]] +} +Set<String> overriddenCoords = overriddenModules.collect { "${it.group}:${it.module}".toString() } as Set + +dependencies { + api(platform(project(':grails-base-bom'))) { + overriddenModules.each { ovr -> + exclude group: ovr.group, module: ovr.module + } + } + + // Re-export the Micronaut platform so consumers inherit Micronaut's managed versions + // transitively. Exclude Groovy since we declare the required version explicitly via + // customBomDependencies. Exclude Spock since we manage that version ourselves. + api(platform("io.micronaut.platform:micronaut-platform:$micronautPlatformVersion")) { + exclude group: 'org.apache.groovy' + exclude group: 'org.spockframework' + } + + constraints { + // Re-declare base BOM constraints directly so enforcedPlatform() consumers + // get forced versions. Constraints inherited via platform() are not enforced + // by enforcedPlatform — only direct constraints are. + // Skip entries we override below in customBomDependencies to avoid conflicting + // strictly constraints under enforcedPlatform. + gradleBomDependencies.values().each { String coord -> + def parts = coord.split(':') + String key = parts[0] + ':' + parts[1] + if (key in overriddenCoords) { + return + } + api coord + } + bomDependencies.values().each { String coord -> + def parts = coord.split(':') + String key = parts[0] + ':' + parts[1] + if (key in overriddenCoords) return + api coord + } + for (def entry : bomPlatformDependencies.entrySet()) { + api entry.value + } + // Re-declare the Micronaut platform as a constraint for enforcedPlatform support + api "io.micronaut.platform:micronaut-platform:$micronautPlatformVersion" + for (def entry : customBomDependencies.entrySet()) { + def parts = entry.value.split(':') + if (parts.length == 3) { + api("${parts[0]}:${parts[1]}") { + version { + strictly parts[2] + } + } + } else { + api entry.value + } + } + } +} + +configurations.register('bomDependencies').configure { + it.canBeResolved = true + it.transitive = true + it.extendsFrom(configurations.named('api').get()) +} + +tasks.register('extractConstraints', ExtractDependenciesTask).configure { ExtractDependenciesTask it -> + it.captureProjectServices(project.dependencies, project.configurations) + it.configuration = configurations.named('bomDependencies') + it.configurationName = 'bomDependencies' + it.destination = project.layout.buildDirectory.file('grails-hibernate5-micronaut-bom-constraints.adoc') + it.platformDefinitions = combinedPlatforms + it.definitions = combinedDependencies + it.projectName = project.name + it.versions = combinedVersions + // Micronaut's platform imports many sub-BOMs (micronaut-*-bom, netty-bom, etc.) that are + // not explicitly registered in dependencies.gradle. Auto-register them so extractConstraints + // can document their versions without requiring manual entries for every transitive platform. + // this is required because the micronaut bom format uses gradle modules instead of a pom like spring boot + it.autoRegisterTransitivePlatforms = true + rootProject.subprojects.each { p -> + evaluationDependsOn(p.path) + } + it.projectArtifactIds.set(project.provider { + Map<String, String> artifactIdMappings = [:] + + rootProject.subprojects.each { p -> + artifactIdMappings[p.name] = p.findProperty('pomArtifactId') ?: p.name + } + + for (Map.Entry<String, String> dependency : project.ext.gradleBuildProjects.entrySet()) { + artifactIdMappings[dependency.key] = dependency.key + } + + artifactIdMappings + }) + it.forcedGroupPrefixes.set(['org.apache.grails.profiles': 'grails-profile']) + it.projectCoordinateProperties.set(project.provider { + Map<String, String> projectCoordinates = [:] + + rootProject.subprojects.each { p -> + String artifactId = p.findProperty('pomArtifactId') as String ?: p.name + String baseVersionName = artifactId.replaceAll('[.]', '-') + projectCoordinates["${p.group}:${ artifactId}:${p.version}" as String] = baseVersionName Review Comment: Stray space in GString: `"${p.group}:${ artifactId}:${p.version}"` — `${ artifactId}` has a leading space inside the braces. Should be `${artifactId}`. Same issue on line 166 of `hibernate7-micronaut/build.gradle`. ########## grails-bom/hibernate5-micronaut/build.gradle: ########## @@ -0,0 +1,254 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.grails.gradle.tasks.bom.ExtractDependenciesTask +import org.apache.grails.gradle.tasks.bom.ExtractedDependencyConstraint +import org.apache.grails.gradle.tasks.bom.PropertyNameCalculator + +buildscript { + apply from: rootProject.layout.projectDirectory.file('dependencies.gradle') +} + +plugins { + id 'java-platform' + id 'org.apache.grails.buildsrc.publish' + id 'org.apache.grails.buildsrc.sbom' +} + +version = projectVersion +group = 'org.apache.grails' + +javaPlatform { + allowDependencies() +} + +ext { + isReleaseBuild = System.getenv('GRAILS_PUBLISH_RELEASE') == 'true' + isPublishedExternal = System.getenv().containsKey('NEXUS_PUBLISH_STAGING_PROFILE_ID') + // TODO: It should be possible to pull these build names using includedBuild, but I haven't found a way to do so + gradleBuildProjects = [ + 'grails-gradle-plugins':'org.apache.grails', + 'grails-gradle-model':'org.apache.grails.gradle', + 'grails-gradle-common':'org.apache.grails.gradle', + 'grails-gradle-tasks':'org.apache.grails', + ] +} + +// Register the Micronaut platform in combinedPlatforms/combinedVersions so +// PropertyNameCalculator (used by extractConstraints and pomCustomization) can +// resolve a property name for the micronaut-platform constraint. +project.ext.combinedPlatforms = combinedPlatforms + ['micronaut-platform': "io.micronaut.platform:micronaut-platform:$micronautPlatformVersion".toString()] +project.ext.combinedVersions = combinedVersions + ['micronaut-platform.version': micronautPlatformVersion as String] + +// Coordinates we override via customBomDependencies — these must be excluded from the +// inherited platform chain so they don't conflict with our strictly-versioned overrides +// when consumers apply this BOM via enforcedPlatform. +def overriddenModules = customBomDependencies.values().collect { String coord -> + def parts = coord.split(':') + [group: parts[0], module: parts[1]] +} +Set<String> overriddenCoords = overriddenModules.collect { "${it.group}:${it.module}".toString() } as Set + +dependencies { + api(platform(project(':grails-base-bom'))) { + overriddenModules.each { ovr -> + exclude group: ovr.group, module: ovr.module + } + } + + // Re-export the Micronaut platform so consumers inherit Micronaut's managed versions + // transitively. Exclude Groovy since we declare the required version explicitly via + // customBomDependencies. Exclude Spock since we manage that version ourselves. + api(platform("io.micronaut.platform:micronaut-platform:$micronautPlatformVersion")) { + exclude group: 'org.apache.groovy' + exclude group: 'org.spockframework' + } + + constraints { + // Re-declare base BOM constraints directly so enforcedPlatform() consumers + // get forced versions. Constraints inherited via platform() are not enforced + // by enforcedPlatform — only direct constraints are. + // Skip entries we override below in customBomDependencies to avoid conflicting + // strictly constraints under enforcedPlatform. + gradleBomDependencies.values().each { String coord -> + def parts = coord.split(':') + String key = parts[0] + ':' + parts[1] + if (key in overriddenCoords) { + return + } + api coord + } + bomDependencies.values().each { String coord -> + def parts = coord.split(':') + String key = parts[0] + ':' + parts[1] + if (key in overriddenCoords) return + api coord + } + for (def entry : bomPlatformDependencies.entrySet()) { + api entry.value + } + // Re-declare the Micronaut platform as a constraint for enforcedPlatform support + api "io.micronaut.platform:micronaut-platform:$micronautPlatformVersion" + for (def entry : customBomDependencies.entrySet()) { + def parts = entry.value.split(':') + if (parts.length == 3) { + api("${parts[0]}:${parts[1]}") { + version { + strictly parts[2] + } + } + } else { + api entry.value + } + } + } +} + +configurations.register('bomDependencies').configure { + it.canBeResolved = true + it.transitive = true + it.extendsFrom(configurations.named('api').get()) +} + +tasks.register('extractConstraints', ExtractDependenciesTask).configure { ExtractDependenciesTask it -> + it.captureProjectServices(project.dependencies, project.configurations) + it.configuration = configurations.named('bomDependencies') + it.configurationName = 'bomDependencies' + it.destination = project.layout.buildDirectory.file('grails-hibernate5-micronaut-bom-constraints.adoc') + it.platformDefinitions = combinedPlatforms + it.definitions = combinedDependencies + it.projectName = project.name + it.versions = combinedVersions + // Micronaut's platform imports many sub-BOMs (micronaut-*-bom, netty-bom, etc.) that are + // not explicitly registered in dependencies.gradle. Auto-register them so extractConstraints + // can document their versions without requiring manual entries for every transitive platform. + // this is required because the micronaut bom format uses gradle modules instead of a pom like spring boot + it.autoRegisterTransitivePlatforms = true + rootProject.subprojects.each { p -> + evaluationDependsOn(p.path) + } + it.projectArtifactIds.set(project.provider { + Map<String, String> artifactIdMappings = [:] + + rootProject.subprojects.each { p -> + artifactIdMappings[p.name] = p.findProperty('pomArtifactId') ?: p.name + } + + for (Map.Entry<String, String> dependency : project.ext.gradleBuildProjects.entrySet()) { + artifactIdMappings[dependency.key] = dependency.key + } + + artifactIdMappings + }) + it.forcedGroupPrefixes.set(['org.apache.grails.profiles': 'grails-profile']) + it.projectCoordinateProperties.set(project.provider { + Map<String, String> projectCoordinates = [:] + + rootProject.subprojects.each { p -> + String artifactId = p.findProperty('pomArtifactId') as String ?: p.name + String baseVersionName = artifactId.replaceAll('[.]', '-') + projectCoordinates["${p.group}:${ artifactId}:${p.version}" as String] = baseVersionName + } + + for (Map.Entry<String, String> dependency : project.ext.gradleBuildProjects.entrySet()) { + projectCoordinates["${dependency.value}:${dependency.key}:${project.version}" as String] = dependency.key + } + + projectCoordinates + }) + + it.dependsOn(project.tasks.named('generateMetadataFileForMavenPublication'), project.tasks.named('generatePomFileForMavenPublication')) +} + +def validateNoSnapshotDependencies = tasks.register('validateNoSnapshotDependencies') +validateNoSnapshotDependencies.configure { Task it -> + it.group = 'publishing' + it.description = 'Validates that no snapshot dependencies are present in the project when performing a release.' + + it.doLast { + configurations.each { config -> + config.allDependencies.each { dep -> + if (dep.version && dep.version.contains('-SNAPSHOT')) { + throw new GradleException("Releases cannot have a snapshot dependency: ${dep.group}:${dep.name} (${dep.version})") + } + } + } + } +} + +if (ext.isReleaseBuild && ext.isPublishedExternal) { + project.afterEvaluate { + tasks.named('generateMetadataFileForMavenPublication').configure { + dependsOn(validateNoSnapshotDependencies) + } + tasks.named('generatePomFileForMavenPublication').configure { + dependsOn(validateNoSnapshotDependencies) + } + } +} + +ext { + pomDescription = 'Grails Hibernate 5 Micronaut BOM (Bill of Materials) for Grails projects integrating with Micronaut and Hibernate 5. Layers Hibernate 5 dependency management on top of grails-micronaut-bom; consume as enforcedPlatform.' + pomCustomization = { xml -> + def root = xml.asNode() + + def propertiesNode = root.properties ? root.properties[0] : root.appendNode('properties') + + def depMgmt = root.dependencyManagement?.getAt(0) + def deps = depMgmt?.dependencies?.getAt(0) + if (deps) { + PropertyNameCalculator propertyNameCalculator = new PropertyNameCalculator(combinedPlatforms, combinedDependencies, combinedVersions) + propertyNameCalculator.addForcedGroupPrefix('org.apache.grails.profiles', 'grails-profile') + propertyNameCalculator.addProjects(rootProject.subprojects) + for (String gradleArtifactId : project.ext.gradleBuildProjects) { + propertyNameCalculator.addProject('org.apache.grails.gradle', gradleArtifactId, project.version as String, gradleArtifactId) + } + + Map<String, String> pomProperties = [:] + deps.dependency.each { dep -> + String groupId = dep.groupId.text().trim() + String artifactId = dep.artifactId.text().trim() + boolean isBom = dep.scope.text().trim() == 'import' + + String inlineVersion = dep.version.text().trim() + if (inlineVersion == 'null') { + inlineVersion = null + } + + if (inlineVersion) { + ExtractedDependencyConstraint extractedConstraint = propertyNameCalculator.calculate(groupId, artifactId, inlineVersion, isBom) + if (extractedConstraint?.versionPropertyReference) { + // use the property reference instead of the hard coded version so that it can be + // overriden by the spring boot dependency management plugin + dep.version[0].value = extractedConstraint.versionPropertyReference + + // Add an entry in the <properties> node with the actual version number + pomProperties.put(extractedConstraint.versionPropertyName, inlineVersion) + } + } else if (!inlineVersion) { + throw new GradleException("Dependency $groupId:$artifactId does not have a version.") + } + } + + for (Map.Entry<String, String> property : pomProperties.entrySet()) { + propertiesNode.appendNode(property.key, property.value) + } + } + } +} Review Comment: `hibernate5-micronaut/build.gradle` and `hibernate7-micronaut/build.gradle` are 254-line near-identical copies of each other (and closely mirror `grails-bom/micronaut/build.gradle`). The only real differences are the `pomDescription` string and the BOM project referenced. Consider extracting the shared boilerplate into a convention plugin or shared Gradle script to reduce 3× duplication and make future maintenance easier. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
