refactor: report use the local css/js

machshev · machshev · commit 182e9cbfaf08 · 2025-12-19T15:37:23.000Z
Add a static file renderer to go alongside the jinja2 renderer for the
static dependencies that do no need templating. This essentially creates
a copy of the files in the output directory.

Now we have the css/js dependencies locally generated we can update the
report template to use them.

Signed-off-by: James McCorrie &lt;james.mccorrie@lowrisc.org&gt;
diff --git a/src/dvsim/report/generate.py b/src/dvsim/report/generate.py
@@ -8,7 +8,7 @@
 
 from dvsim.logging import log
 from dvsim.report.data import FlowResults, ResultsSummary
-from dvsim.templates.render import render_template
+from dvsim.templates.render import render_static, render_template
 
 __all__ = (
     "gen_block_report",
@@ -63,7 +63,16 @@ def gen_summary_report(summary: ResultsSummary, path: Path) -> None:
     (path / "index.json").write_text(summary.model_dump_json())
 
     # Generate style CSS
-    (path / "style.css").write_text(render_template(path="reports/style.css"))
+    for name in (
+        "css/style.css",
+        "css/bootstrap.min.css",
+        "js/bootstrap.bundle.min.js",
+        "js/htmx.min.js",
+    ):
+        output = path / name
+
+        output.parent.mkdir(parents=True, exist_ok=True)
+        output.write_text(render_static(path=name))
 
     # HTMX wrapper
     (path / "index.html").write_text(render_template(path="reports/wrapper.html"))
diff --git a/src/dvsim/templates/render.py b/src/dvsim/templates/render.py
@@ -9,6 +9,7 @@
 """
 
 from collections.abc import Mapping
+from importlib import resources
 
 from jinja2 import Environment, PackageLoader, select_autoescape
 
@@ -17,6 +18,22 @@
 _env: Environment | None = None
 
 
+def render_static(path: str) -> str:
+    """Render static files packaged with DVSim.
+
+    Args:
+        path: relative path to the DVSim template directory
+
+    Returns:
+        string containing the static file content
+
+    """
+    return resources.read_text(
+        "dvsim",
+        f"templates/static/{path}",
+    )
+
+
 def render_template(path: str, data: Mapping[str, object] | None = None) -> str:
     """Render a template packaged with DVSim.
 
diff --git a/src/dvsim/templates/reports/wrapper.html b/src/dvsim/templates/reports/wrapper.html
@@ -10,12 +10,9 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>Simulation Results</title>
-    <script src="https://unpkg.com/htmx.org@2.0.4"></script>
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
-          rel="stylesheet"
-          integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
-          crossorigin="anonymous">
-    <link href="style.css" rel="stylesheet">
+    <script src="js/htmx.min.js"></script>
+    <link href="css/bootstrap.min.css" rel="stylesheet">
+    <link href="css/style.css" rel="stylesheet">
 </head>
 <body>
 
@@ -35,8 +32,6 @@
      hx-trigger="load"
      hx-target="#report-content"></div>
 
-<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
-        integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
-        crossorigin="anonymous"></script>
+<script src="js/bootstrap.bundle.min.js"></script>
 </body>
 </html>
diff --git a/src/dvsim/templates/static/css/style.css b/src/dvsim/templates/static/css/style.css
