feat: add report generation from JSON

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

Author: machshev

pyproject.toml

@@ -63,6 +63,7 @@ nix = [
 
 [project.scripts]
 dvsim = "dvsim.cli:main"
+dvsim-admin = "dvsim.cli.admin:cli"
 
 ################
 # BUILD-SYSTEM #

src/dvsim/cli/__init__.py

@@ -4,6 +4,6 @@
 
 """DVSim CLI."""
 
-from dvsim.cli.main import main
+from dvsim.cli.run import main
 
 __all__ = ("main",)

src/dvsim/cli/admin.py

@@ -0,0 +1,48 @@
+# Copyright lowRISC contributors (OpenTitan project).
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+"""DVSim CLI main entry point."""
+
+from pathlib import Path
+
+import click
+
+from dvsim.report.data import ResultsSummary
+from dvsim.report.generate import gen_block_report
+
+
+@click.group()
+def cli() -> None:
+    """DVSim Administration tool.
+
+    Temporary tool for administration tasks for a DVSim project. The commands
+    here are experimental and may change at any time. As functionality
+    stabilises it will be moved over to the main `dvsim` command.
+    """
+
+
+@cli.group()
+def report() -> None:
+    """Reporting helper commands."""
+
+
+@report.command()
+@click.argument(
+    "json_path",
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
+)
+@click.argument(
+    "output_dir",
+    type=click.Path(file_okay=False, dir_okay=True, path_type=Path),
+)
+def gen(json_path: Path, output_dir: Path) -> None:
+    """Generate a report from a existing results JSON."""
+    from dvsim.report.generate import gen_summary_report
+
+    results: ResultsSummary = ResultsSummary.load(path=json_path)
+
+    gen_summary_report(summary=results, path=output_dir)
+
+    for flow_result in results.flow_results.values():
+        gen_block_report(flow_result, path=output_dir)

src/dvsim/cli/main.py

@@ -821,7 +821,7 @@ def parse_args():
     return args
 
 
-def run() -> None:
+def main() -> None:
     """DVSim CLI entry point."""
     args = parse_args()