Remove duplicate data from summary

src/dvsim/cli/admin.py

@@ -41,9 +41,16 @@ def gen(json_path: Path, output_dir: Path) -> None:
     from dvsim.sim.data import SimResultsSummary
     from dvsim.sim.report import gen_reports
 
-    results: SimResultsSummary = SimResultsSummary.load(path=json_path)
-
-    gen_reports(summary=results, path=output_dir)
+    summary: SimResultsSummary = SimResultsSummary.load(path=json_path)
+    flow_results = summary.load_flow_results(
+        base_path=json_path.parent,
+    )
+
+    gen_reports(
+        summary=summary,
+        flow_results=flow_results,
+        path=output_dir,
+    )
 
 
 if __name__ == "__main__":

src/dvsim/sim/data.py

@@ -169,7 +169,7 @@ def flattened(self) -> dict[str, float | None]:
         return items
 
 
-class FlowResults(BaseModel):
+class SimFlowResults(BaseModel):
     """Flow results data."""
 
     model_config = ConfigDict(frozen=True, extra="forbid")
@@ -181,10 +181,17 @@ class FlowResults(BaseModel):
     timestamp: datetime
     """Timestamp for when the test ran."""
 
+    build_seed: int | None
+    """Build seed."""
+    testplan_ref: str | None
+    """A reference (HTML link or relative HJSON path) to the testplan for this flow."""
+
     stages: Mapping[str, TestStage]
     """Results per test stage."""
     coverage: CoverageMetrics | None
     """Coverage metrics."""
+    cov_report_page: Path | None
+    """Optional path linking to the generated coverage report dashboard page."""
 
     failed_jobs: BucketedFailures
     """Bucketed failed job overview."""
@@ -196,46 +203,38 @@ class FlowResults(BaseModel):
     percent: float
     """Percentage test pass rate."""
 
-    @staticmethod
-    def load(path: Path) -> "FlowResults":
+    def summary(self) -> "SimFlowSummary":
         """Load results from JSON file.
 
-        Transform the fields of the loaded JSON into a more useful schema for
-        report generation.
+        Args:
+            path: to the json file to load.
+
+        """
+        return SimFlowSummary.model_validate_json(
+            json_data=self.model_dump_json(),
+        )
+
+    @staticmethod
+    def load(path: Path) -> "SimFlowResults":
+        """Load results from JSON file.
 
         Args:
             path: to the json file to load.
 
         """
-        return FlowResults.model_validate_json(path.read_text())
+        return SimFlowResults.model_validate_json(path.read_text())
 
 
-class SimFlowResults(BaseModel):
-    """Flow results data."""
+class SimFlowSummary(BaseModel):
+    """Flow results summary."""
 
-    model_config = ConfigDict(frozen=True, extra="forbid")
+    model_config = ConfigDict(frozen=True, extra="ignore")
 
     block: IPMeta
     """IP block metadata."""
-    tool: ToolMeta
-    """Tool used in the simulation run."""
-    timestamp: datetime
-    """Timestamp for when the test ran."""
-
-    build_seed: int | None
-    """Build seed."""
-    testplan_ref: str | None
-    """A reference (HTML link or relative HJSON path) to the testplan for this flow."""
 
-    stages: Mapping[str, TestStage]
-    """Results per test stage."""
     coverage: CoverageMetrics | None
     """Coverage metrics."""
-    cov_report_page: Path | None
-    """Optional path linking to the generated coverage report dashboard page."""
-
-    failed_jobs: BucketedFailures
-    """Bucketed failed job overview."""
 
     passed: int
     """Number of tests passed."""
@@ -245,17 +244,14 @@ class SimFlowResults(BaseModel):
     """Percentage test pass rate."""
 
     @staticmethod
-    def load(path: Path) -> "FlowResults":
+    def load(path: Path) -> "SimFlowSummary":
         """Load results from JSON file.
 
-        Transform the fields of the loaded JSON into a more useful schema for
-        report generation.
-
         Args:
             path: to the json file to load.
 
         """
-        return FlowResults.model_validate_json(path.read_text())
+        return SimFlowSummary.model_validate_json(path.read_text())
 
 
 class SimResultsSummary(BaseModel):
@@ -275,19 +271,33 @@ class SimResultsSummary(BaseModel):
     build_seed: int | None
     """Build seed."""
 
-    flow_results: Mapping[str, SimFlowResults]
-    """Flow results."""
+    flow_results: Mapping[str, SimFlowSummary]
+    """Flow results summary or full results."""
 
     report_path: Path
     """Path to the report JSON file."""
 
+    def load_flow_results(self, base_path: Path) -> Mapping[str, SimFlowResults]:
+        """Load the detailed results for the sim flows from their JSON files.
+
+        Args:
+            base_path: path to the directory containing the json files to load.
+
+        Returns:
+            Mapping of flow name to detailed simulation flow results.
+
+        """
+        return {
+            flow: SimFlowResults.load(
+                path=base_path / f"{flow}.json",
+            )
+            for flow in self.flow_results
+        }
+
     @staticmethod
     def load(path: Path) -> "SimResultsSummary":
         """Load results from JSON file.
 
-        Transform the fields of the loaded JSON into a more useful schema for
-        report generation.
-
         Args:
             path: to the json file to load.
 

src/dvsim/sim/flow.py

@@ -30,6 +30,7 @@
 from dvsim.sim.data import (
     IPMeta,
     SimFlowResults,
+    SimFlowSummary,
     SimResultsSummary,
     Testpoint,
     TestResult,
@@ -42,6 +43,7 @@
 from dvsim.testplan import Testplan
 from dvsim.tool.utils import get_sim_tool_plugin
 from dvsim.utils import TS_FORMAT, rm_path
+from dvsim.utils.fs import relative_to
 from dvsim.utils.git import git_commit_hash, git_https_url_with_commit
 
 __all__ = ("SimCfg",)
@@ -625,6 +627,7 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
             dvsim_version = None
 
         all_flow_results: Mapping[str, SimFlowResults] = {}
+        flow_summaries: Mapping[str, SimFlowSummary] = {}
 
         for item in self.cfgs:
             item_results = [
@@ -640,7 +643,9 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
 
             # Convert to lowercase to match filename
             block_result_index = item.variant_name.lower().replace("/", "_")
+
             all_flow_results[block_result_index] = flow_results
+            flow_summaries[block_result_index] = flow_results.summary()
 
             self.errors_seen |= item.errors_seen
 
@@ -672,13 +677,14 @@ def gen_results(self, results: Sequence[CompletedJobStatus]) -> None:
             version=dvsim_version,
             timestamp=timestamp,
             build_seed=build_seed,
-            flow_results=all_flow_results,
+            flow_results=flow_summaries,
             report_path=reports_dir,
         )
 
         # Generate all the JSON/HTML reports to the report area.
         gen_reports(
             summary=results_summary,
+            flow_results=all_flow_results,
             path=reports_dir,
         )
 
@@ -719,7 +725,11 @@ def _gen_json_results(
 
         # Build up a reference to the testplan, which might be overridden.
         if self.testplan_doc_path:
-            rel_path = Path(self.testplan_doc_path).relative_to(Path(self.proj_root))
+            rel_path = relative_to(
+                Path(self.testplan_doc_path),
+                Path(self.proj_root),
+            )
+
         else:
             # TODO: testplan variants frequently override `rel_path` for reporting
             # and build reasons, but do not update the `testplan_doc_path`, meaning

src/dvsim/sim/report.py

@@ -5,7 +5,7 @@
 """Generate reports."""
 
 from collections import defaultdict
-from collections.abc import Callable, Collection, Iterable
+from collections.abc import Callable, Collection, Iterable, Mapping
 from datetime import datetime
 from pathlib import Path
 from typing import Any, Protocol, TypeAlias
@@ -17,6 +17,7 @@
 from dvsim.sim.data import SimFlowResults, SimResultsSummary
 from dvsim.templates.render import render_static, render_template
 from dvsim.utils import TS_FORMAT_LONG
+from dvsim.utils.fs import relative_to
 
 __all__ = (
     "HtmlReportRenderer",
@@ -49,7 +50,12 @@ class ReportRenderer(Protocol):
 
     format_name: str
 
-    def render(self, summary: SimResultsSummary, outdir: Path | None = None) -> ReportArtifacts:
+    def render(
+        self,
+        summary: SimResultsSummary,
+        flow_results: Mapping[str, SimFlowResults],
+        outdir: Path | None = None,
+    ) -> ReportArtifacts:
         """Render a report of the sim flow results into output artifacts."""
         ...
 
@@ -59,14 +65,19 @@ class JsonReportRenderer:
 
     format_name = "json"
 
-    def render(self, summary: SimResultsSummary, outdir: Path | None = None) -> ReportArtifacts:
+    def render(
+        self,
+        summary: SimResultsSummary,
+        flow_results: Mapping[str, SimFlowResults],
+        outdir: Path | None = None,
+    ) -> ReportArtifacts:
         """Render a JSON report of the sim flow results into output artifacts."""
         if outdir is not None:
             outdir.mkdir(parents=True, exist_ok=True)
 
         artifacts = {}
 
-        for results in summary.flow_results.values():
+        for results in flow_results.values():
             file_name = results.block.variant_name()
             log.debug("Generating JSON report for '%s'", file_name)
             block_file = f"{file_name}.json"
@@ -88,15 +99,20 @@ class HtmlReportRenderer:
 
     format_name = "html"
 
-    def render(self, summary: SimResultsSummary, outdir: Path | None = None) -> ReportArtifacts:
+    def render(
+        self,
+        summary: SimResultsSummary,
+        flow_results: Mapping[str, SimFlowResults],
+        outdir: Path | None = None,
+    ) -> ReportArtifacts:
         """Render a HTML report of the sim flow results into output artifacts."""
         if outdir is not None:
             outdir.mkdir(parents=True, exist_ok=True)
 
         artifacts = {}
 
         # Generate block HTML pages
-        for results in summary.flow_results.values():
+        for results in flow_results.values():
             file_name = results.block.variant_name()
             log.debug("Generating HTML report for '%s'", file_name)
             block_file = f"{file_name}.html"
@@ -164,14 +180,19 @@ def __init__(self, html_link_base: Path | None = None, relative_to: Path | None
         self.html_link_base = html_link_base
         self.relative_to = relative_to
 
-    def render(self, summary: SimResultsSummary, outdir: Path | None = None) -> ReportArtifacts:
+    def render(
+        self,
+        summary: SimResultsSummary,
+        flow_results: Mapping[str, SimFlowResults],
+        outdir: Path | None = None,
+    ) -> ReportArtifacts:
         """Render a Markdown report of the sim flow results."""
         if outdir is not None:
             outdir.mkdir(parents=True, exist_ok=True)
 
         report_md = [
-            self.render_block(flow_result)["report.md"]
-            for flow_result in summary.flow_results.values()
+            self.render_block(results=flow_result)["report.md"]
+            for flow_result in flow_results.values()
         ]
         report_md.append(self.render_summary(summary)["report.md"])
 
@@ -184,7 +205,11 @@ def render(self, summary: SimResultsSummary, outdir: Path | None = None) -> Repo
     def render_block(self, results: SimFlowResults) -> ReportArtifacts:
         """Render a Markdown report of the sim flow results for a given block/flow."""
         # Generate block result metadata information
-        report_md = self.render_metadata(results.block, results.timestamp, results.build_seed)
+        report_md = self.render_metadata(
+            results.block,
+            results.timestamp,
+            results.build_seed,
+        )
         testplan_ref = (results.testplan_ref or "").strip()
         if len(results.stages) > 0 and testplan_ref:
             report_md += f"\n### [Testplan]({testplan_ref})"
@@ -398,9 +423,9 @@ def render_summary(self, summary: SimResultsSummary) -> ReportArtifacts:
 
             # Optionally display links to the block HTML reports, relative to the CWD
             if self.html_link_base is not None:
-                relative = self.relative_to if self.relative_to is not None else Path(Path.cwd())
+                relative = Path(self.relative_to) if self.relative_to is not None else Path.cwd()
                 block_report = self.html_link_base / f"{file_name}.html"
-                html_report_path = block_report.relative_to(relative)
+                html_report_path = relative_to(block_report, relative)
                 name_link = f"[{name.upper()}]({html_report_path!s})"
             else:
                 name_link = name.upper()
@@ -456,25 +481,34 @@ def display_report(
         sink(header + content + "\n")
 
 
-def gen_reports(summary: SimResultsSummary, path: Path) -> None:
+def gen_reports(
+    summary: SimResultsSummary,
+    flow_results: Mapping[str, SimFlowResults],
+    path: Path,
+) -> None:
     """Generate and display a full set of reports for the given regression run.
 
     This helper currently saves JSON and HTML reports to disk (relative to the given path),
     and outputs a Markdown report to the CLI.
 
     Args:
         summary: overview of the block results
+        flow_results: mapping flow names to detailed flow results
         path: output directory path
 
     """
     for renderer in (JsonReportRenderer(), HtmlReportRenderer()):
-        renderer.render(summary, outdir=path)
+        renderer.render(
+            summary=summary,
+            flow_results=flow_results,
+            outdir=path,
+        )
 
     renderer = MarkdownReportRenderer(path)
 
     # Per-block CLI results are displayed to the `INFO` log
     if log.isEnabledFor(log.INFO):
-        for flow_result in summary.flow_results.values():
+        for flow_result in flow_results.values():
             block_name = flow_result.block.variant_name()
             log.info("[results]: [%s]", block_name)
             cli_block = renderer.render_block(flow_result)