feat: Add DVSim version to generated reports

Add the version that was used to run DVSim to the generated block
and summary reports, with a link to the tag of the relevant Github
release for that version (only provided that the version can be found).

Signed-off-by: Alex Jones <[email protected]>

Author: AlexJones0

src/dvsim/sim/data.py

@@ -233,6 +233,9 @@ class SimResultsSummary(BaseModel):
     top: IPMeta
     """Meta data for the top level config."""
 
+    version: str | None
+    """The version of DVSim being used, if applicable."""
+
     timestamp: datetime
     """Run time stamp."""
 

src/dvsim/sim/flow.py

@@ -9,6 +9,7 @@
 from collections import OrderedDict, defaultdict
 from collections.abc import Mapping, Sequence
 from datetime import datetime, timezone
+from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
 from typing import ClassVar
 
@@ -638,6 +639,12 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
                 .isoformat()
             )
 
+            try:
+                dvsim_version = version("dvsim").strip()
+            except PackageNotFoundError as e:
+                log.debug("DVSim package not found: %s", str(e))
+                dvsim_version = None
+
             results_summary = SimResultsSummary(
                 top=IPMeta(
                     name=self.name,
@@ -646,6 +653,7 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
                     branch=self.branch,
                     url=url,
                 ),
+                version=dvsim_version,
                 timestamp=timestamp,
                 flow_results=all_flow_results,
                 report_path=reports_dir,

src/dvsim/sim/report.py

@@ -17,7 +17,7 @@
 )
 
 
-def gen_block_report(results: SimFlowResults, path: Path) -> None:
+def gen_block_report(results: SimFlowResults, path: Path, version: str | None = None) -> None:
     """Generate a block report.
 
     Args:
@@ -42,7 +42,7 @@ def gen_block_report(results: SimFlowResults, path: Path) -> None:
     (path / f"{file_name}.html").write_text(
         render_template(
             path="reports/block_report.html",
-            data={"results": results},
+            data={"results": results, "version": version},
         ),
     )
 
@@ -99,4 +99,4 @@ def gen_reports(summary: SimResultsSummary, path: Path) -> None:
     gen_summary_report(summary=summary, path=path)
 
     for flow_result in summary.flow_results.values():
-        gen_block_report(results=flow_result, path=path)
+        gen_block_report(results=flow_result, path=path, version=summary.version)

src/dvsim/templates/reports/block_report.html

@@ -40,6 +40,12 @@ <h2>Simulation Results: {{ block.name }}</h2>
             <span class="badge text-bg-secondary">
                 {{ timestamp.strftime("%d/%m/%Y %H:%M:%S") }}
             </span>
+            {% if version %}
+            <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
+                href="https://github.com/lowRISC/dvsim/releases/tag/v{{ version }}">
+                DVSim: v{{ version }}
+            </a>
+            {% endif %}
             <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
                href="{{ block.url }}">
                 sha: {{ block.commit[:7] }}

src/dvsim/templates/reports/summary_report.html

@@ -6,6 +6,7 @@
 -->
 {% set top = summary.top %}
 {% set timestamp = summary.timestamp %}
+{% set version = summary.version %}
 <div class="container-md"> 
     <div class="row">
         <div class="col">
@@ -36,6 +37,12 @@ <h2>Simulation Results: {{ top.name }}</h2>
             <span class="badge text-bg-secondary">
                 {{ timestamp.strftime("%d/%m/%Y %H:%M:%S") }}
             </span>
+            {% if version %}
+            <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
+                href="https://github.com/lowRISC/dvsim/releases/tag/v{{ version }}">
+                DVSim: v{{ version }}
+            </a>
+            {% endif %}
             <a class="badge text-bg-secondary link-underline link-underline-opacity-0"
                 href="{{ top.url }}">
                 sha: {{ top.commit[:7] }}