Step 1 (PR-H): Add grails-jacoco convention plugin + Codecov coverage (depends on PR-G)

.github/workflows/coverage.yml

@@ -0,0 +1,119 @@
+# 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.
+
+name: "Coverage"
+
+on:
+  push:
+    branches:
+      - '[0-9]+.[0-9]+.x'
+      - '8.0.x-hibernate7.*'
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  coverage-core:
+    name: "Coverage - grails-core (${{ matrix.os }})"
+    if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: "☕️ Setup JDK"
+        uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with:
+          distribution: liberica
+          java-version: 21
+      - name: "🐘 Setup Gradle"
+        uses: gradle/actions/setup-gradle@50e97c2cd7a37755bbfafc9c5b7cafaece252f6e # v6.1.0
+        with:
+          cache-provider: basic # 'basic' uses the MIT-licensed, open-source cache provider; the default 'enhanced' provider (v6+) is proprietary (Gradle commercial Terms of Use)
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+      - name: "🌡️ Run tests with coverage"
+        run: >
+          ./gradlew jacocoAggregateReport
+          --continue
+          --stacktrace
+          -PskipCodeStyle
+      - name: "📤 Upload coverage artifact"
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: coverage-core-${{ matrix.os }}
+          path: build/reports/jacoco/aggregate/jacocoAggregateReport.xml
+          if-no-files-found: warn
+
+  coverage-gradle:
+    name: "Coverage - grails-gradle (${{ matrix.os }})"
+    if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: "☕️ Setup JDK"
+        uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with:
+          distribution: liberica
+          java-version: 21
+      - name: "🐘 Setup Gradle"
+        uses: gradle/actions/setup-gradle@50e97c2cd7a37755bbfafc9c5b7cafaece252f6e # v6.1.0
+        with:
+          cache-provider: basic # 'basic' uses the MIT-licensed, open-source cache provider; the default 'enhanced' provider (v6+) is proprietary (Gradle commercial Terms of Use)
+          develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+      - name: "🌡️ Run tests with coverage"
+        working-directory: grails-gradle
+        run: >
+          ./gradlew jacocoAggregateReport
+          --continue
+          --stacktrace
+          -PskipCodeStyle
+      - name: "📤 Upload coverage artifact"
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: coverage-gradle-${{ matrix.os }}
+          path: grails-gradle/build/reports/jacoco/aggregate/jacocoAggregateReport.xml
+          if-no-files-found: warn
+
+  upload-coverage:
+    name: "Upload Coverage to Codecov"
+    needs: [coverage-core, coverage-gradle]
+    # Run even if some matrix legs fail so partial coverage is still uploaded
+    if: always()
+    runs-on: ubuntu-24.04
+    steps:
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: "📥 Download all coverage artifacts"
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          path: coverage-reports
+      - name: "📊 Upload coverage to Codecov"
+        continue-on-error: true
+        uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v6.0.0
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          directory: coverage-reports
+          verbose: true

build-logic/plugins/build.gradle

@@ -75,6 +75,10 @@ gradlePlugin {
             id = 'org.apache.grails.gradle.grails-code-analysis'
             implementationClass = 'org.apache.grails.buildsrc.GrailsCodeAnalysisPlugin'
         }
+        register('grailsJacoco') {
+            id = 'org.apache.grails.gradle.grails-jacoco'
+            implementationClass = 'org.apache.grails.buildsrc.GrailsJacocoPlugin'
+        }
         register('grailsViolationAggregation') {
             id = 'org.apache.grails.gradle.grails-violation-aggregation'
             implementationClass = 'org.apache.grails.buildsrc.GrailsViolationAggregationPlugin'

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

@@ -0,0 +1,118 @@
+/*
+ *  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 org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.plugins.JavaPlugin
+import org.gradle.api.tasks.testing.Test
+import org.gradle.testing.jacoco.plugins.JacocoPlugin
+import org.gradle.testing.jacoco.plugins.JacocoPluginExtension
+import org.gradle.testing.jacoco.tasks.JacocoReport
+
+/**
+ * Convention plugin for JaCoCo code coverage. Apply to each subproject that compiles code.
+ *
+ * In addition to configuring per-subproject coverage, this plugin lazily registers a
+ * jacocoAggregateReport task on the root project the first time it is applied, then wires
+ * each subproject's exec data into that task. The aggregate produces a single XML report
+ * at build/reports/jacoco/aggregate/jacocoAggregateReport.xml suitable for Codecov upload.
+ */
+@CompileDynamic
+class GrailsJacocoPlugin implements Plugin<Project> {
+
+    static final String AGGREGATE_TASK_NAME = 'jacocoAggregateReport'
+
+    @Override
+    void apply(Project project) {
+        project.logger.info("Configuring JaCoCo for project: ${project.name}")
+        project.pluginManager.apply(JacocoPlugin)
+
+        project.extensions.configure(JacocoPluginExtension) {
+            it.toolVersion = '0.8.14'
+        }
+
+        project.tasks.withType(Test).configureEach {
+            it.finalizedBy 'jacocoTestReport'
+        }
+
+        project.tasks.withType(JacocoReport).configureEach {
+            it.dependsOn project.tasks.withType(Test)
+            it.reports {
+                it.xml.required = true
+                it.html.required = true
+                it.csv.required = true
+            }
+        }
+
+        contributeToRootAggregateReport(project)
+    }
+
+    private static void contributeToRootAggregateReport(Project project) {
+        Project root = project.rootProject
+
+        // Ensure JacocoPlugin is on the root so its JacocoReport task has tooling available.
+        // pluginManager.apply is idempotent — safe to call from every subproject.
+        root.pluginManager.apply(JacocoPlugin)
+
+        // Register the aggregate task once on the first apply; subsequent subprojects find it by name.
+        def aggregateTask
+        if (root.tasks.names.contains(AGGREGATE_TASK_NAME)) {
+            aggregateTask = root.tasks.named(AGGREGATE_TASK_NAME, JacocoReport)
+        } else {
+            aggregateTask = root.tasks.register(AGGREGATE_TASK_NAME, JacocoReport) { JacocoReport task ->
+                task.group = 'verification'
+                task.description = 'Aggregates JaCoCo coverage from all subprojects into a single XML report for Codecov.'
+                task.reports {
+                    it.xml.required = true
+                    it.xml.outputLocation = root.layout.buildDirectory.file(
+                        'reports/jacoco/aggregate/jacocoAggregateReport.xml'
+                    )
+                    it.html.required = false
+                    it.csv.required = false
+                }
+                task.onlyIf { JacocoReport t -> !t.executionData.files.isEmpty() }
+            }
+        }
+
+        // Wire this subproject's test exec data into the aggregate.
+        aggregateTask.configure { JacocoReport task ->
+            task.dependsOn project.tasks.withType(Test)
+            task.executionData.from(
+                project.fileTree(project.file('build/jacoco')) { include '*.exec' }
+            )
+        }
+
+        // Add source and class directories once the Java plugin is confirmed present.
+        // Hibernate 7 variant subprojects compile identical class names to their Hibernate 5
+        // counterparts; including both causes JaCoCo to throw "Can't add different class with
+        // same name". Exec data from H7 test runs is still included above so their coverage
+        // is attributed to the H5 class definitions.
+        if (!project.path.contains('hibernate7')) {
+            project.plugins.withType(JavaPlugin) {
+                aggregateTask.configure { JacocoReport task ->
+                    task.sourceDirectories.from(project.sourceSets.main.allSource.srcDirs)
+                    task.classDirectories.from(project.sourceSets.main.output.classesDirs)
+                }
+            }
+        }
+    }
+}