jamesfredley commented on code in PR #15827: URL: https://github.com/apache/grails-core/pull/15827#discussion_r3524955309
########## build-logic/plugins/src/main/groovy/org/apache/grails/buildsrc/BomConventionsPlugin.groovy: ########## @@ -0,0 +1,261 @@ +/* + * 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. + */ + +package org.apache.grails.buildsrc + +import groovy.transform.CompileDynamic +import groovy.transform.CompileStatic + +import org.gradle.api.GradleException +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.Task +import org.gradle.api.artifacts.Configuration +import org.gradle.api.artifacts.Dependency +import org.gradle.api.plugins.JavaPlatformExtension +import org.gradle.api.tasks.TaskProvider + +import org.apache.grails.gradle.tasks.bom.ExtractDependenciesTask +import org.apache.grails.gradle.tasks.bom.ExtractedDependencyConstraint +import org.apache.grails.gradle.tasks.bom.PropertyNameCalculator + +@CompileStatic +class BomConventionsPlugin implements Plugin<Project> { + + private static final String BASE_CONSTRAINTS_FILE = 'grails-bom-constraints.adoc' + + private static final Set<String> MICRONAUT_BOM_PROJECTS = [ + 'grails-hibernate5-micronaut-bom', + 'grails-hibernate7-micronaut-bom', + 'grails-micronaut-bom', + ] as Set<String> + + private static final Map<String, String> GRADLE_BUILD_PROJECTS = [ + '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', + ] + + @Override + void apply(Project project) { + applyDependencyDefinitions(project) + configureCoordinates(project) + configureExtraProperties(project) + configurePomCustomization(project) + + project.pluginManager.apply('java-platform') + project.extensions.configure(JavaPlatformExtension) { JavaPlatformExtension extension -> + extension.allowDependencies() + } + project.pluginManager.apply('org.apache.grails.buildsrc.publish') + project.pluginManager.apply('org.apache.grails.buildsrc.sbom') + + configureBomDependencies(project) + configureExtractConstraints(project) + configureSnapshotValidation(project) + } + + private static void applyDependencyDefinitions(Project project) { + project.apply([from: project.rootProject.layout.projectDirectory.file('dependencies.gradle')]) + } + + private static void configureCoordinates(Project project) { + project.version = project.findProperty('projectVersion') + project.group = 'org.apache.grails' + } + + private static void configureExtraProperties(Project project) { + project.extensions.extraProperties.set('isReleaseBuild', System.getenv('GRAILS_PUBLISH_RELEASE') == 'true') + project.extensions.extraProperties.set( + 'isPublishedExternal', + System.getenv().containsKey('NEXUS_PUBLISH_STAGING_PROFILE_ID') + ) + project.extensions.extraProperties.set('gradleBuildProjects', new LinkedHashMap<String, String>(GRADLE_BUILD_PROJECTS)) + } + + private static void configureBomDependencies(Project project) { + project.configurations.register('bomDependencies') { Configuration configuration -> + configuration.canBeResolved = true + configuration.transitive = true + configuration.extendsFrom(project.configurations.named('api').get()) + } + } + + private static void configureExtractConstraints(Project project) { + TaskProvider<ExtractDependenciesTask> extractConstraints = project.tasks.register( + 'extractConstraints', + ExtractDependenciesTask + ) { ExtractDependenciesTask task -> + task.captureProjectServices(project.dependencies, project.configurations) + task.setConfiguration(project.configurations.named('bomDependencies')) + task.destination.set(project.layout.buildDirectory.file(constraintsFileName(project))) + task.platformDefinitions.set(project.provider { getStringMap(project, 'combinedPlatforms') }) + task.definitions.set(project.provider { getStringMap(project, 'combinedDependencies') }) + task.projectName.set(project.name) + task.versions.set(project.provider { getStringMap(project, 'combinedVersions') }) + task.autoRegisterTransitivePlatforms.set(MICRONAUT_BOM_PROJECTS.contains(project.name)) + + project.rootProject.subprojects.each { Project subproject -> + project.evaluationDependsOn(subproject.path) + } + task.projectArtifactIds.set(project.provider { projectArtifactIds(project) }) + task.forcedGroupPrefixes.set(['org.apache.grails.profiles': 'grails-profile']) + task.projectCoordinateProperties.set(project.provider { projectCoordinateProperties(project) }) + task.dependsOn('generateMetadataFileForMavenPublication', 'generatePomFileForMavenPublication') + } + + project.tasks.named('check') { Task task -> + task.dependsOn(extractConstraints) + } + } + + private static String constraintsFileName(Project project) { + project.name == 'grails-base-bom' ? BASE_CONSTRAINTS_FILE : "${project.name}-constraints.adoc" + } + + private static Map<String, String> projectArtifactIds(Project project) { + Map<String, String> artifactIdMappings = [:] + project.rootProject.subprojects.each { Project subproject -> + artifactIdMappings[subproject.name] = (subproject.findProperty('pomArtifactId') ?: subproject.name).toString() + } + + getGradleBuildProjects(project).each { String dependencyName, String dependencyGroup -> + artifactIdMappings[dependencyName] = dependencyName + } + + artifactIdMappings + } + + private static Map<String, String> projectCoordinateProperties(Project project) { + Map<String, String> projectCoordinates = [:] + project.rootProject.subprojects.each { Project subproject -> + String artifactId = (subproject.findProperty('pomArtifactId') ?: subproject.name).toString() + String baseVersionName = artifactId.replaceAll('[.]', '-') + projectCoordinates["${subproject.group}:${artifactId}:${subproject.version}".toString()] = baseVersionName + } + + getGradleBuildProjects(project).each { String dependencyName, String dependencyGroup -> + projectCoordinates["${dependencyGroup}:${dependencyName}:${project.version}".toString()] = dependencyName + } + + projectCoordinates + } + + private static void configureSnapshotValidation(Project project) { + TaskProvider<Task> validateNoSnapshotDependencies = project.tasks.register('validateNoSnapshotDependencies') { Task task -> + task.group = 'publishing' + task.description = 'Validates that no snapshot dependencies are present in the project when performing a release.' + + task.doLast { + project.configurations.each { Configuration configuration -> + configuration.allDependencies.each { Dependency dependency -> + if (dependency.version && dependency.version.contains('-SNAPSHOT')) { + throw new GradleException( + "Releases cannot have a snapshot dependency: ${dependency.group}:${dependency.name} (${dependency.version})" + ) + } + } + } + } + } + + if (project.extensions.extraProperties.get('isReleaseBuild') && + project.extensions.extraProperties.get('isPublishedExternal')) { + project.tasks.matching { Task task -> + task.name in ['generateMetadataFileForMavenPublication', 'generatePomFileForMavenPublication'] + }.configureEach { Task task -> + task.dependsOn(validateNoSnapshotDependencies) + } + } + } + + private static void configurePomCustomization(Project project) { + project.extensions.extraProperties.set('pomCustomization', createPomCustomization(project)) + } + + @CompileDynamic + private static Closure createPomCustomization(Project project) { + { 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( + getStringMap(project, 'combinedPlatforms'), + getStringMap(project, 'combinedDependencies'), + getStringMap(project, 'combinedVersions') + ) + propertyNameCalculator.addForcedGroupPrefix('org.apache.grails.profiles', 'grails-profile') + propertyNameCalculator.addProjects(project.rootProject.subprojects) + for (String gradleArtifactId : project.ext.gradleBuildProjects) { + propertyNameCalculator.addProject( + 'org.apache.grails.gradle', + gradleArtifactId, + project.version as String, + gradleArtifactId + ) + } Review Comment: Fixed in 206a4b6129 by iterating the configured gradleBuildProjects map and passing each artifact-specific group into PropertyNameCalculator.addProject. The regenerated base BOM POM now emits version properties for the Gradle-build artifacts, and the constraints output remains unchanged versus the 8.0.x baseline. -- 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]
