[ci] add urg report to ci

Signed-off-by: Avimitin <[email protected]>
chipsalliance · Oct 7, 2024 · 3408b3e · 3408b3e
1 parent bb244c5
commit 3408b3e
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/.github/workflows/vcs.yml b/.github/workflows/vcs.yml
@@ -101,9 +101,12 @@ jobs:
       - name: "Print step summary"
         run: |
           nix run ".#ci-helper" -- postCI \
+            --urg-report-file-path ./urg-report.md \
             --cycle-update-file-path ./cycle-update.md \
             --failed-tests-file-path ./failed-tests.md \
             --emu-type vcs
+          cat ./urg-report.md >> $GITHUB_STEP_SUMMARY
+          echo >> $GITHUB_STEP_SUMMARY
           cat ./cycle-update.md >> $GITHUB_STEP_SUMMARY
           echo >> $GITHUB_STEP_SUMMARY
           cat ./failed-tests.md >> $GITHUB_STEP_SUMMARY

diff --git a/script/ci/src/Main.scala b/script/ci/src/Main.scala
@@ -214,6 +214,10 @@ object Main:
       name = "cycle-update-file-path",
       doc = "specify the cycle update markdown file output path"
     ) cycleUpdateFilePath: String,
+    @arg(
+      name = "urg-report-file-path",
+      doc = "specify the urg report markdown file output path"
+    ) urgReportFilePath:   Option[String],
     @arg(
       name = "emu-type",
       doc = "Specify emulation type"
@@ -231,6 +235,9 @@ object Main:
       "## Cycle Update\n"
     )
 
+    if urgReportFilePath.nonEmpty then
+      os.write(os.Path(urgReportFilePath.get, os.pwd), "# Coverage report\n")
+
     os.walk(os.pwd / ".github" / caseDir)
       .filter(_.last == "default.json")
       .foreach: file =>
@@ -281,6 +288,23 @@ object Main:
             allCycleUpdates.mkString("\n") + "\n"
           )
 
+        if urgReportFilePath.nonEmpty then
+          Logger.info("Filtering urg report")
+          val finalMdPath     = os.Path(urgReportFilePath.get, os.pwd)
+          val urgAssertFile   = emuResultPath / "urgReport" / "asserts.txt"
+          val heading         = "^Summary for Cover Properties$".r
+          val coverSummaryStr =
+            os.read(urgAssertFile)
+              .lines()
+              .dropWhile(!heading.matches(_))
+              .takeWhile(_.distinct != "-")
+              .toArray
+              .mkString("\n")
+          os.write.append(finalMdPath, s"### Coverage for $config \n")
+          os.write.append(finalMdPath, "```text\n")
+          os.write.append(finalMdPath, coverSummaryStr)
+          os.write.append(finalMdPath, "\n```\n")
+
         os.write.over(file, ujson.write(cycleRecord, indent = 2))
   end postCI