feat: add ResultsSummary model

At the moment we have a JSON file for each of the flow config objects,
alongside the HTML reports. The results summary page which ties them all
together is HTML only. There is no way of getting the information
programmatically, without doing something like parsing the HTML... which
is error prone and messy.

The ResultsSummary is a Pydantic model which can then be dumped to JSON.

Signed-off-by: James McCorrie <[email protected]>

Author: machshev

src/dvsim/report/__init__.py

@@ -0,0 +1,5 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Job result reporting."""

src/dvsim/report/data.py

@@ -0,0 +1,62 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Report data models."""
+
+from collections.abc import Mapping
+from datetime import datetime
+from pathlib import Path
+
+from pydantic import BaseModel, ConfigDict
+
+__all__ = (
+    "IPMeta",
+    "ResultsSummary",
+)
+
+
+class IPMeta(BaseModel):
+    """Meta data for an IP block."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    name: str
+    variant: str | None = None
+    commit: str
+    branch: str
+    url: str
+
+
+class ResultsSummary(BaseModel):
+    """Summary of results."""
+
+    model_config = ConfigDict(frozen=True, extra="forbid")
+
+    top: IPMeta
+    """Meta data for the top level config."""
+
+    timestamp: datetime
+    """Run time stamp."""
+
+    report_index: Mapping[str, Path]
+    """Index of the IP block reports."""
+
+    report_path: Path
+    """Path to the report JSON file."""
+
+    @staticmethod
+    def load(path: Path) -> "ResultsSummary":
+        """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.
+
+        Returns:
+            The loaded ResultsSummary from JSON.
+
+        """
+        return ResultsSummary.model_validate_json(path.read_text())