Finalizing PR

- translation of junit into annotation is now done in Gradle
- update wrapper to 9.1.0 for Java 25 support
- rebase on main
- put checkstyle markdown report into separate file

Author: wadoon

.github/junit2annotations.py

@@ -56,12 +56,11 @@ jobs:
       - name: Build with Gradle
         run: ./gradlew --parallel --continue checkstyleMain
 
-      - name: Copy Sarif
+      - name: Merge sarif files into single file.
         run: ./gradlew --parallel --continue sarifCopy
 
       - run: "ls build/sarif-results/*"
 
-
       - name: "Job summary"
         run: "cat */build/reports/checkstyle/main.md >> $GITHUB_STEP_SUMMARY"
 

.github/workflows/code_quality.yml

@@ -73,6 +73,9 @@ jobs:
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v5
 
+      - name: JUnit into Github Annotations
+        run: ./gradlew junitAsAnnotations
+
   integration-tests:
     env:
       GH_TOKEN: ${{ github.token }}
@@ -110,4 +113,7 @@ jobs:
             **/build/test-results/*/*.xml
             key.core/build/reports/runallproofs/*
             **/build/reports/
-      - run: "python .github/junit2annotations.py"
+
+      - name: JUnit into Github Annotations
+        run: ./gradlew junitAsAnnotations
+

.github/workflows/tests.yml

@@ -1,5 +1,3 @@
-
-
 plugins {
     //Support for IntelliJ IDEA
     //https://docs.gradle.org/current/userguide/idea_plugin.html
@@ -104,7 +102,7 @@ subprojects {
         testImplementation("org.junit.jupiter:junit-jupiter-params")
         testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
         testRuntimeOnly("org.junit.platform:junit-platform-launcher")
-        testImplementation ("org.assertj:assertj-core:3.26.3")
+        testImplementation("org.assertj:assertj-core:3.26.3")
         testImplementation project(':key.util')
 
         // test fixtures
@@ -253,7 +251,7 @@ subprojects {
         }
 
         doLast {
-            checkstyleMarkdownReport(
+            CheckstyleMarkdownReport.report(
                     layout.buildDirectory.dir("reports/checkstyle/main.xml").get().asFile,
                     layout.buildDirectory.dir("reports/checkstyle/main.md").get().asFile)
         }
@@ -523,32 +521,15 @@ tasks.register('sarifCopy', SarifJoiner) {
     outputFile.set(layout.buildDirectory.file("sarif-results/checkstyle.sarif"))
 }
 
-def checkstyleMarkdownReport(File xmlFile, File targetFile) {
-    if(!xmlFile.exists()) return
-    def root = new groovy.xml.XmlSlurper().parseText(xmlFile.text)
-    def out = new PrintWriter(targetFile)
-
-
-    def sha= System.getenv("GITHUB_SHA") ?: "main"
-    def host = System.getenv("GITHUB_SERVER_URL") ?: "https://github.com"
-    def repo = System.getenv("GITHUB_REPOSITORY") ?: "keyproject/key"
-    def baseUrl = "$host/$repo/blob/$sha"
-    try {
-        //out.write("### Checkstyle Report\n\n")
-        out.write("\n\n")
-
-        for(xmlFileNode in root.file) {
-            def f = file(xmlFileNode.@name.toString())
-            def path = projectDir.relativePath(f)
-            out.write("#### $path\n\n")
-            def url="$baseUrl/$path"
-            for(error in xmlFileNode.error) {
-                out.write("\n* ${error.@severity} [${error.@message} @${error.@line}:${error.@column}]($url#L${error.@line})")
-            }
-            out.write("\n\n")
+tasks.register("junitAsAnnotations") {
+    def source = files(fileTree(dir: '.').matching {
+        include "*/build/test-results/test/TEST-*xml" }
+    )
+    inputs.files(source)
+
+    doLast {
+        source.asList().forEach {
+            JUnitGithubAnnotations.readAndPrint(it.toPath())
         }
     }
-    finally {
-        out.close()
-    }
 }

build.gradle

@@ -10,7 +10,7 @@ repositories {
 }
 
 kotlin {
-    jvmToolchain(21)
+    //jvmToolchain(21)
 }
 
 dependencies {

buildSrc/build.gradle.kts

@@ -0,0 +1,49 @@
+import org.w3c.dom.Element
+import java.io.PrintWriter
+import java.nio.file.Path
+import java.nio.file.Paths
+import javax.xml.parsers.DocumentBuilderFactory
+import kotlin.io.path.exists
+
+object CheckstyleMarkdownReport {
+    @JvmStatic
+    fun report(xmlFile: Path, targetFile: Path, projectDir: Path) {
+        if (!xmlFile.exists()) return
+
+        // get variables either from the environment
+        val sha = System.getenv("GITHUB_SHA") ?: "main"
+        val host = System.getenv("GITHUB_SERVER_URL") ?: "https://github.com"
+        val repo = System.getenv("GITHUB_REPOSITORY") ?: "keyproject/key"
+        val baseUrl = "$host/$repo/blob/$sha"
+
+        val docBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder()
+        val doc = docBuilder.parse(xmlFile.toFile())
+        doc.documentElement.normalize()
+
+        PrintWriter(targetFile.toFile()).use { out ->
+            out.write("\n\n")
+
+            val files = doc.getElementsByTagName("file")
+            for (i in 0 until files.length) {
+                val fileNode = files.item(i) as Element
+                val filePath = Paths.get(fileNode.getAttribute("name"))
+                val relativePath = projectDir.relativize(filePath).toString()
+                val url = "$baseUrl/$relativePath"
+
+                out.write("#### $relativePath\n\n")
+
+                val errors = fileNode.getElementsByTagName("error")
+                for (j in 0 until errors.length) {
+                    val error = errors.item(j) as Element
+                    val severity = error.getAttribute("severity")
+                    val message = error.getAttribute("message")
+                    val line = error.getAttribute("line")
+                    val column = error.getAttribute("column")
+                    out.write("\n* $severity [$message @$line:$column]")
+                }
+
+                out.write("\n\n")
+            }
+        }
+    }
+}

buildSrc/src/main/kotlin/CheckstyleMarkdownReport.kt

@@ -0,0 +1,58 @@
+import org.w3c.dom.NodeList
+import java.nio.file.Path
+import javax.xml.parsers.DocumentBuilderFactory
+import javax.xml.xpath.XPathConstants
+import javax.xml.xpath.XPathFactory
+import kotlin.io.path.extension
+import kotlin.io.path.name
+import kotlin.io.path.walk
+
+object JUnitGithubAnnotations {
+    private val xqryTestcase by lazy {
+        val xPath = XPathFactory.newInstance().newXPath()
+        val expression = "/testsuite/testcase[./failure]"
+        xPath.compile(expression)
+    }
+
+    private val xqryFailureMessage by lazy {
+        val xPath = XPathFactory.newInstance().newXPath()
+        val expression = "./failure/@message"
+        xPath.compile(expression)
+    }
+
+    @JvmStatic
+    fun readAndPrint(f: Path) {
+        val builder = DocumentBuilderFactory.newInstance().newDocumentBuilder()
+        val doc = builder.parse(f.toFile())
+        val nodeList = xqryTestcase.evaluate(doc, XPathConstants.NODESET) as NodeList
+
+        if (nodeList.length <= 0) {
+            return
+        }
+
+
+        // module name assuming <mod>/build/test-results/test/<file>.xml
+        val base = f.parent.parent.parent.parent.name
+        for (i in 0 until nodeList.length) {
+            val node = nodeList.item(i)
+            // failure in test case
+            val failure = xqryFailureMessage.evaluate(node, XPathConstants.STRING) as String?
+            val attributes = node.attributes
+            val caseName = attributes.getNamedItem("name").textContent
+            val classname = attributes.getNamedItem("classname").textContent
+            val filename = "$base/${classname.replace(".", "/")}"
+            val message = failure?.take(80) ?: ""
+            // ::error file={name},line={line},endLine={endLine}, ={title}::{message}
+            print("::error title=Testcase-missed,file=$filename::Error in test case '$caseName' and $message")
+        }
+    }
+
+    @JvmStatic
+    fun readAndPrintAll(root: Path) {
+        val reports = root.fileSystem.getPathMatcher("glob:TEST-*xml")
+        root.walk()
+            .filter { it.extension == "xml" }
+            .filter { reports.matches(it) }
+            .forEach { readAndPrint(it) }
+    }
+}

buildSrc/src/main/kotlin/JUnitGithubAnnotations.kt

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME