Add Jacoco code coverage violation rules (#533)

This commit adds Jacoco violation rules as well as the following:
- fails the PR workflow if rules are violated
- uploads the report if the rules are violated
- replaces JacocoConventionsPlugin (Java) with a simple groovy script

Resolves #511

Author: onobc

.github/workflows/ci-pr.yml

@@ -37,24 +37,26 @@ jobs:
       - name: Build and run unit tests
         run: |
           ./gradlew clean build -x integrationTest --continue --scan
+      - name: Upload Test Results
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-results
+          path: '*/build/reports/tests/**/*.*'
+          retention-days: 3
       - name: Create Aggregated Jacoco Report
-        if: contains(github.event.pull_request.labels.*.name, 'ci/upload-jacoco')
         run: |
           ./gradlew aggregateJacocoTestReport --info
+      - name: Verify Code Coverage
+        run: |
+          ./gradlew jacocoTestCoverageVerification --info
       - name: Upload Aggregated Jacoco Report
-        if: contains(github.event.pull_request.labels.*.name, 'ci/upload-jacoco')
+        if: failure() || contains(github.event.pull_request.labels.*.name, 'ci/upload-jacoco')
         uses: actions/upload-artifact@v3
         with:
           name: jacoco-results
           path: 'build/reports/jacoco/**/*.*'
           retention-days: 3
-      - name: Capture Test Results
-        if: failure()
-        uses: actions/upload-artifact@v3
-        with:
-          name: test-results
-          path: '*/build/reports/tests/**/*.*'
-          retention-days: 3
   integration_tests:
     needs: [prerequisites, build_and_verify]
     runs-on: ubuntu-latest

build.gradle

@@ -9,6 +9,7 @@ plugins {
 
 description = 'Spring for Apache Pulsar'
 
+apply from: 'gradle/jacoco-conventions.gradle'
 apply from: 'gradle/aggregate-jacoco-report.gradle'
 apply from: 'gradle/update-copyrights.gradle'
 apply from: 'gradle/version-catalog-update.gradle'

buildSrc/build.gradle

@@ -59,10 +59,6 @@ gradlePlugin {
 			id = "io.spring.convention.artfiactory"
 			implementationClass = "io.spring.gradle.convention.ArtifactoryPlugin"
 		}
-		jacocoConventionsPlugin {
-			id = "org.springframework.pulsar.jacoco"
-			implementationClass = "org.springframework.pulsar.gradle.check.JacocoConventionsPlugin"
-		}
 		optionalDependenciesPlugin {
 			id = "org.springframework.pulsar.optional-dependencies"
 			implementationClass = "org.springframework.pulsar.gradle.optional.OptionalDependenciesPlugin"

buildSrc/src/main/java/org/springframework/pulsar/gradle/SpringModulePlugin.java

@@ -19,7 +19,6 @@
 import org.gradle.api.Project;
 import org.gradle.api.plugins.PluginManager;
 
-import org.springframework.pulsar.gradle.check.JacocoConventionsPlugin;
 import org.springframework.pulsar.gradle.publish.PublishAllJavaComponentsPlugin;
 import org.springframework.pulsar.gradle.publish.SpringMavenPlugin;
 
@@ -33,6 +32,5 @@ protected void additionalPlugins(Project project) {
 		PluginManager pluginManager = project.getPluginManager();
 		pluginManager.apply(SpringMavenPlugin.class);
 		pluginManager.apply(PublishAllJavaComponentsPlugin.class);
-		pluginManager.apply(JacocoConventionsPlugin.class);
 	}
 }

buildSrc/src/main/java/org/springframework/pulsar/gradle/check/JacocoConventionsPlugin.java

@@ -0,0 +1,43 @@
+def javaProjects = [ 'spring-pulsar',
+					 'spring-pulsar-cache-provider',
+					 'spring-pulsar-cache-provider-caffeine',
+					 'spring-pulsar-reactive',
+					 'spring-pulsar-test' ]
+
+
+allprojects {
+	if (!javaProjects.contains(project.name)) {
+		return
+	}
+
+	apply plugin: 'jacoco'
+
+	jacoco {
+		toolVersion libs.versions.jacoco.get()
+	}
+
+	project.tasks.withType(Test, (test) ->
+		project.tasks.withType(JacocoReport, test::finalizedBy))
+
+	tasks.withType(JacocoCoverageVerification) {
+		violationRules {
+			rule {
+				limit {
+					minimum = 0.5
+				}
+			}
+			rule {
+				enabled = false
+				element = 'CLASS'
+				includes = ['org.gradle.*']
+
+				limit {
+					counter = 'LINE'
+					value = 'TOTALCOUNT'
+					maximum = 0.3
+				}
+			}
+		}
+
+	}
+}