Display specific failing cocotb testcases

Author: mcejp

.gitlab-ci.yml

@@ -93,7 +93,7 @@ reports:
   image: python:3.10
 
   script:
-    - pip install "psycopg>=3"
+    - pip install junitparser "psycopg>=3"
     - ./tools/ci/save_build_stats.py
 
 

tools/ci/build_stats.html

@@ -79,7 +79,13 @@
       {% if build.sim.result == "pass" %}
       <td style="text-align: center" class="success">PASS</td>
       {% elif build.sim.result == "fail" %}
-      <td style="text-align: center" class="error">FAIL</td>
+      <td style="text-align: center" class="error">
+        {% if build.sim.failed_testcases | default(None) %}
+        <abbr title="Failed testcases:&#x0A;{{ build.sim.failed_testcases | join("\n") }}">FAIL</abbr>
+        {% else %}
+        FAIL
+        {% endif %}
+      </td>
       {% else %}
       <td style="text-align: center">?</td>
       {% endif %}

tools/ci/save_build_stats.py

@@ -17,6 +17,7 @@
 import logging
 import os
 
+from junitparser import JUnitXml
 import psycopg
 
 
@@ -30,17 +31,27 @@
 
 # Results of simulation
 
-try:
-    with open("results.xml", "rt") as f:
-        xml = f.read()
+if os.path.exists("results.xml"):       # ugh. fromfile() raises generic OSError
+                                        # instead of FileNotFoundError
+    xml = JUnitXml.fromfile("results.xml")
+
+    failures = []
+
+    for suite in xml:
+        for case in suite:
+            if any(r._tag == "failure" for r in case.result):
+                logger.info("%s:%s FAIL", case.classname, case.name)
+                failures.append(case.classname + ":" + case.name)
+            else:
+                logger.info("%s:%s PASS", case.classname, case.name)
 
-    if "<failure" not in xml:
+    if len(failures) > 0:
+        logger.info("cocotb FAIL")
+        results["sim"] = dict(result="fail", failed_testcases=failures)
+    else:
         logger.info("cocotb PASS")
         results["sim"] = dict(result="pass")
-    else:
-        logger.info("cocotb FAIL")
-        results["sim"] = dict(result="fail")
-except FileNotFoundError:
+else:
     logger.error("results.xml not found")
     results["sim"] = dict(result=None)