jdaugherty commented on code in PR #15827: URL: https://github.com/apache/grails-core/pull/15827#discussion_r3555974767
########## 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') Review Comment: The extracted scripts used `version = projectVersion`, which fails with `MissingPropertyException` when `projectVersion` is not defined. `findProperty` returns null here, leaving `project.version` as `unspecified`; `projectCoordinateProperties()` and the POM customization then register coordinates like `org.apache.grails:grails-gradle-plugins:unspecified`, and version property replacement silently stops matching with no error. Suggest failing fast, e.g. `project.property('projectVersion')` or an explicit check. ########## 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 -> Review Comment: This adds new lifecycle behavior that was not present in any of the extracted BOM scripts: `check` now runs `extractConstraints`, which also runs both publication generators and resolves the full BOM graph. `grails-doc:generateBomDocumentation` already invokes `extractConstraints` explicitly. It also makes a previously configuration-cache-compatible BOM check fail: `./gradlew :grails-base-bom:check --configuration-cache --rerun-tasks` reports unsupported serialization of `ConfigurationContainer`, `DependencyHandler`, and `Project`. Could we remove this `check` dependency and keep constraint extraction explicit? ########## 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'] Review Comment: Behavior change from the extracted scripts: they used `afterEvaluate { tasks.named(...).configure { ... } }`, which throws `UnknownTaskException` if the publication tasks are missing. `tasks.matching { }.configureEach { }` silently no-ops if these tasks are never created (e.g. the publish plugin renames its publication), so on a real release the snapshot validation could silently not run. Since this guard only matters when `isReleaseBuild && isPublishedExternal`, consider asserting the tasks exist in that case rather than matching by name. ########## 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') Review Comment: We have not used aggregate plugins to date. These should be left on the individual projects (publish & sbom) ########## 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> { Review Comment: I would rename this to GrailsBomPlugin ########## 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) + getGradleBuildProjects(project).each { String gradleArtifactId, String dependencyGroup -> + propertyNameCalculator.addProject( + dependencyGroup, + 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) { + dep.version[0].value = extractedConstraint.versionPropertyReference + pomProperties.put(extractedConstraint.versionPropertyName, inlineVersion) + } + } else if (!inlineVersion) { Review Comment: `else if (!inlineVersion)` is always true at this point — carried over from the original scripts, but since this code was rewritten anyway, a plain `else` would be clearer. ########## 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')]) Review Comment: The difference between this and before is it was applied in the buildscript so it was available in all contexts. I think this is ok, but it's important to note the difference. ########## dependencies.gradle: ########## @@ -20,6 +20,18 @@ // This file provides the 'grails-bom' dependencies, while grails-gradle/dependencies.gradle provides the 'grails-gradle-bom' dependencies // These files are split to facilitate separation of build vs application dependencies. These are the application dependencies. +static Map<String, String> groovyModuleDependencies(String groovyVersion) { + [ + '', '-ant', '-astbuilder', '-cli-commons', '-cli-picocli', '-console', '-contracts', '-datetime', Review Comment: This is harder to read and should be reverted. the standard of this file is to list the dependencies. these extractions make it harder to maintain -- 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]
