Merge pull request #9 from build-extensions-oss/coverage

Add code coverage

Author: imanushin

.github/workflows/pre-merge.yaml

@@ -11,13 +11,17 @@ on:
 
 permissions:
   contents: read
+  # kover-report action needs updating the PR report
+  pull-requests: write
 
 jobs:
   gradle:
     strategy:
+      # don't fail immediately - otherwise failing build on Windows will cancel all other builds
+      fail-fast: false
       matrix:
         # build project on some operating systems
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
         # build on different java versions
         jdk: [ 11, 17, 21 ]
     runs-on: ${{ matrix.os }}
@@ -53,3 +57,22 @@ jobs:
       # No need to use daemon (this is run once container), however we print detailed logs and stacktraces
       - name: Assemble the project
         run: ./gradlew build --stacktrace --info --no-daemon
+
+      - name: Generate kover coverage report
+        run: ./gradlew koverXmlReport
+
+      # see https://github.com/marketplace/actions/kotlinx-kover-report
+      - name: Add coverage report to PR
+        id: kover
+        uses: mi-kas/kover-report@v1
+        with:
+          # we aggregate everything in root project
+          path: ${{ github.workspace }}/build/reports/kover/report.xml
+          title: Code Coverage
+          update-comment: true
+          # We check that in root project - no need to repeat it once again
+          # min-coverage-overall: ???
+          # we can't validate this in Gradle - the report must do this on GitHub
+          # We aren't ready yet
+          # min-coverage-changed-files: 80
+          coverage-counter-type: LINE

build.gradle.kts

@@ -0,0 +1,33 @@
+plugins {
+    base
+    // is defined in buildSrc
+    id("org.jetbrains.kotlinx.kover")
+}
+
+dependencies {
+    subprojects.forEach {
+        val projectName = it.name
+
+        // depend on all projects
+        if (projectName != "bom") {
+            kover(project(":${it.name}")) {}
+        }
+    }
+}
+
+tasks {
+    this.getByName("build") {
+        // prohibit building without verification
+        dependsOn(getByName("koverCachedVerify"))
+    }
+}
+
+kover.reports {
+    verify {
+        rule {
+            bound {
+                minValue.set(14)
+            }
+        }
+    }
+}

buildSrc/build.gradle.kts

@@ -9,4 +9,5 @@ repositories {
 dependencies {
     implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:${embeddedKotlinVersion}")
     implementation(libs.com.vanniktech.maven.publish.gradle.plugin)
+    implementation(libs.org.jetbrains.kotlinx.kover)
 }

buildSrc/src/main/kotlin/kotlin-convention.gradle.kts

@@ -6,6 +6,7 @@ plugins {
     kotlin("jvm")
     id("dependencies-lock")
     id("dependencies-publishing")
+    id("org.jetbrains.kotlinx.kover")
 }
 
 repositories {

gradle/libs.versions.toml

@@ -21,7 +21,9 @@ reflections = { module = "org.reflections:reflections", version.ref = "reflectio
 
 spek-dsl = { module = "org.spekframework.spek2:spek-dsl", version.ref = "spek2" }
 
+org-jetbrains-kotlinx-kover = { module = "org.jetbrains.kotlinx:kover-gradle-plugin", version = "0.9.3" }
+
 # this plugin is referenced in buildSrc
 com-vanniktech-maven-publish-gradle-plugin = { module = "com.vanniktech.maven.publish:com.vanniktech.maven.publish.gradle.plugin", version = "0.34.0" }
 
-[plugins]
+[plugins]