Introduce JaCoCo (#20)

* Initial introduction of JaCoCo.

Author: miroslavpojer

.github/workflows/ci_code_coverage.yml

@@ -0,0 +1,41 @@
+name: CI check JaCoCo code-coverage
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  code_coverage:
+    name: CI check JaCoCo code-coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/[email protected]
+      - name: Setup Scala
+        uses: olafurpg/setup-scala@v14
+        with:
+          java-version: "[email protected]"
+      - name: Build, run tests, and generate Jacoco code coverage report
+        run: sbt ++2.12.18 jacoco
+      - name: Add coverage to PR
+        id: jacoco
+        uses: madrapps/[email protected]
+        with:
+          paths: >
+            ${{ github.workspace }}/target/scala-2.12/jacoco/report/jacoco.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          min-coverage-overall: 0.0
+          min-coverage-changed-files: 80.0
+          title: JaCoCo code coverage report - springdoc-openapi-scala
+          update-comment: true
+          debug-mode: true
+      - name: Get the Coverage info
+        run: |
+          echo "Total coverage ${{ steps.jacoco.outputs.coverage-overall }}"
+          echo "Changed Files coverage ${{ steps.jacoco.outputs.coverage-changed-files }}"
+      - name: Fail PR if changed files coverage is less than 80%
+        if: ${{ steps.jacoco.outputs.coverage-changed-files < 80.0 }}
+        uses: actions/[email protected]
+        with:
+          script: |
+            core.setFailed('Changed files coverage is less than 80%!')

.github/workflows/ci_tests.yml

@@ -30,10 +30,10 @@ jobs:
     name: Scala ${{matrix.scala}}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4.1.1
       - uses: coursier/cache-action@v6
       - name: Setup Scala
-        uses: olafurpg/setup-scala@v11
+        uses: olafurpg/setup-scala@v14
         with:
           java-version: "[email protected]"
       - name: Build and run tests

build.sbt

@@ -15,18 +15,29 @@
  */
 
 import Dependencies._
+import com.github.sbt.jacoco.report.JacocoReportSettings
 
 ThisBuild / organization := "za.co.absa"
 ThisBuild / scalaVersion := Versions.scala212
 ThisBuild / versionScheme := Some("early-semver")
 
 lazy val supportedScalaVersions = List(Versions.scala212, Versions.scala213)
 
+lazy val commonJacocoReportSettings: JacocoReportSettings = JacocoReportSettings(
+  formats = Seq(JacocoReportFormats.HTML, JacocoReportFormats.XML)
+)
+
+lazy val commonJacocoExcludes: Seq[String] = Seq(
+//  "za.co.absa.springdocopenapiscala.*"
+)
+
 lazy val root = (project in file("."))
   .settings(
     name := "springdoc-openapi-scala",
     libraryDependencies ++= libraryDependencyList(scalaVersion.value),
-    crossScalaVersions := supportedScalaVersions
+    crossScalaVersions := supportedScalaVersions,
+    jacocoReportSettings := commonJacocoReportSettings.withTitle(s"SpringDoc OpenApi - scala:${scalaVersion.value}"),
+    jacocoExcludes := commonJacocoExcludes
   )
 
 lazy val simpleExample = (project in file("examples/simple"))

project/plugins.sbt

@@ -16,3 +16,25 @@
 
 addSbtPlugin("org.jetbrains.scala" % "sbt-ide-settings" % "1.1.1")
 addSbtPlugin("com.earldouglas" % "xsbt-web-plugin" % "4.2.4")
+
+// sbt-jacoco - workaround related dependencies required to download
+lazy val ow2Version = "9.5"
+lazy val jacocoVersion = "0.8.11-absa.1"
+val sbtJacocoVersion = "3.4.1-absa.4"
+val scalaArmVersion = "2.0"
+
+def jacocoUrl(artifactName: String): String = s"https://github.com/AbsaOSS/jacoco/releases/download/$jacocoVersion/org.jacoco.$artifactName-$jacocoVersion.jar"
+def ow2Url(artifactName: String): String = s"https://repo1.maven.org/maven2/org/ow2/asm/$artifactName/$ow2Version/$artifactName-$ow2Version.jar"
+def armUrl(scalaMajor: String): String = s"https://repo1.maven.org/maven2/com/jsuereth/scala-arm_$scalaMajor/$scalaArmVersion/scala-arm_$scalaMajor-$scalaArmVersion.jar"
+
+addSbtPlugin("com.jsuereth" %% "scala-arm" % scalaArmVersion from armUrl("2.11"))
+addSbtPlugin("com.jsuereth" %% "scala-arm" % scalaArmVersion from armUrl("2.12"))
+
+addSbtPlugin("za.co.absa.jacoco" % "report" % jacocoVersion from jacocoUrl("report"))
+addSbtPlugin("za.co.absa.jacoco" % "core" % jacocoVersion from jacocoUrl("core"))
+addSbtPlugin("za.co.absa.jacoco" % "agent" % jacocoVersion from jacocoUrl("agent"))
+addSbtPlugin("org.ow2.asm" % "asm" % ow2Version from ow2Url("asm"))
+addSbtPlugin("org.ow2.asm" % "asm-commons" % ow2Version from ow2Url("asm-commons"))
+addSbtPlugin("org.ow2.asm" % "asm-tree" % ow2Version from ow2Url("asm-tree"))
+
+addSbtPlugin("za.co.absa.sbt" % "sbt-jacoco" % sbtJacocoVersion from s"https://github.com/AbsaOSS/sbt-jacoco/releases/download/$sbtJacocoVersion/sbt-jacoco-$sbtJacocoVersion.jar")