ci: publish JaCoCo coverage report to PRs (#441)

Author: rashidi

.github/workflows/gradle-build.yml

@@ -51,6 +51,7 @@ jobs:
     if: ${{ needs.check-changes.outputs.build-changes == 'true'  || needs.check-changes.outputs.source-changes == 'true' }}
     runs-on: ubuntu-latest
     permissions:
+      contents: read
       pull-requests: write
     outputs:
       build-artifacts: ${{ steps.upload-build-artifacts.outputs.artifact-id }}
@@ -75,6 +76,19 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: ./gradlew check --configuration-cache --parallel
+      - name: Publish JaCoCo Report to PR
+        id: jacoco
+        uses: madrapps/jacoco-report@v1.8.0
+        if: always() && github.event_name == 'pull_request'
+        with:
+          paths: ${{ github.workspace }}/build/reports/jacoco/testCodeCoverageReport/testCodeCoverageReport.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          min-coverage-overall: 80
+          min-coverage-changed-lines: 80
+          title: 'JaCoCo Code Coverage'
+          update-comment: true
+          pass-emoji: '✨'
+          fail-emoji: '🤦🏽'
       - name: Upload build artifacts
         uses: actions/upload-artifact@v7
         id: upload-build-artifacts

build.gradle.kts

@@ -39,6 +39,58 @@ subprojects {
     }
 }
 
+tasks.named<JacocoReport>("testCodeCoverageReport") {
+    val objectFactory = project.objects
+    val exclusions = listOf(
+        // Spring Boot @SpringBootApplication entry points and inner classes
+        "**/*Application.class",
+        "**/*Application$*.class",
+
+        // Spring Boot AOT / GraalVM generated classes (if AOT is run)
+        "**/*__BeanDefinitions*.class",
+        "**/*__Autowiring*.class",
+        "**/*__ApplicationContextInitializer*.class",
+
+        // jOOQ generated catalog, schema, keys, and table records in :jooq
+        "zin/rashidi/boot/jooq/DefaultCatalog.class",
+        "zin/rashidi/boot/jooq/DefaultSchema.class",
+        "zin/rashidi/boot/jooq/Indexes.class",
+        "zin/rashidi/boot/jooq/Keys.class",
+        "zin/rashidi/boot/jooq/Tables.class",
+        "zin/rashidi/boot/jooq/tables/**"
+    )
+    val defaultClassDirs = objectFactory.fileCollection().from(classDirectories.from.toList())
+
+    classDirectories.setFrom(
+        defaultClassDirs.elements.map { locations ->
+            locations.map { location ->
+                objectFactory.fileTree().from(location.asFile).matching {
+                    exclude(exclusions)
+                }
+            }
+        }
+    )
+}
+
+tasks.register<JacocoCoverageVerification>("testCodeCoverageVerification") {
+    val reportTask = tasks.named<JacocoReport>("testCodeCoverageReport").get()
+    dependsOn(reportTask)
+
+    executionData.setFrom(reportTask.executionData)
+    classDirectories.setFrom(reportTask.classDirectories)
+    sourceDirectories.setFrom(reportTask.sourceDirectories)
+
+    violationRules {
+        rule {
+            limit {
+                counter = "INSTRUCTION"
+                minimum = "0.80".toBigDecimal()
+            }
+        }
+    }
+}
+
 tasks.check {
     dependsOn(tasks.named<JacocoReport>("testCodeCoverageReport"))
-}
+    dependsOn(tasks.named<JacocoCoverageVerification>("testCodeCoverageVerification"))
+}