test: add tests for the tool plugin system

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

Author: machshev

src/dvsim/tool/vcs.py

@@ -49,7 +49,7 @@ def get_cov_summary_table(cov_report_path: Path) -> tuple[Sequence[Sequence[str]
         raise SyntaxError(msg)
 
     @staticmethod
-    def get_job_runtime(log_text: list) -> tuple[float, str]:
+    def get_job_runtime(log_text: Sequence[str]) -> tuple[float, str]:
         """Return the job runtime (wall clock time) along with its units.
 
         EDA tools indicate how long the job ran in terms of CPU time in the log
@@ -74,7 +74,7 @@ def get_job_runtime(log_text: list) -> tuple[float, str]:
         raise RuntimeError(msg)
 
     @staticmethod
-    def get_simulated_time(log_text: list) -> tuple[float, str]:
+    def get_simulated_time(log_text: Sequence[str]) -> tuple[float, str]:
         """Return the simulated time along with its units.
 
         EDA tools indicate how long the design was simulated for in the log file.

src/dvsim/tool/xcelium.py

@@ -77,7 +77,7 @@ def get_cov_summary_table(cov_report_path: Path) -> tuple[Sequence[Sequence[str]
         raise SyntaxError(msg)
 
     @staticmethod
-    def get_job_runtime(log_text: list) -> tuple[float, str]:
+    def get_job_runtime(log_text: Sequence[str]) -> tuple[float, str]:
         """Return the job runtime (wall clock time) along with its units.
 
         EDA tools indicate how long the job ran in terms of CPU time in the log
@@ -103,7 +103,7 @@ def get_job_runtime(log_text: list) -> tuple[float, str]:
         raise RuntimeError(msg)
 
     @staticmethod
-    def get_simulated_time(log_text: list) -> tuple[float, str]:
+    def get_simulated_time(log_text: Sequence[str]) -> tuple[float, str]:
         """Return the simulated time along with its units.
 
         EDA tools indicate how long the design was simulated for in the log file.

tests/tool/__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
+
+"""Tests for EDA tool plugins and the plug-in system."""

tests/tool/test_utils.py

@@ -0,0 +1,34 @@
+# copyright lowrisc contributors (opentitan project).
+# licensed under the apache license, version 2.0, see license for details.
+# spdx-license-identifier: apache-2.0
+
+"""Test the EDA tool utilities."""
+
+import pytest
+from hamcrest import assert_that, equal_to, instance_of
+
+from dvsim.tool.sim import SimTool
+from dvsim.tool.utils import _SUPPORTED_SIM_TOOLS, get_sim_tool_plugin
+
+__all__ = ("TestEDAToolPlugins",)
+
+
+class TestEDAToolPlugins:
+    """Test the EDA tool plug-ins."""
+
+    @staticmethod
+    @pytest.mark.parametrize("tool", _SUPPORTED_SIM_TOOLS.keys())
+    def test_get_sim_tool_plugin(tool: str) -> None:
+        """Test that sim plugins can be retrieved correctly."""
+        assert_that(
+            get_sim_tool_plugin(tool),
+            equal_to(_SUPPORTED_SIM_TOOLS[tool]),
+        )
+
+    @staticmethod
+    @pytest.mark.parametrize("tool", _SUPPORTED_SIM_TOOLS.keys())
+    def test_plugins_implement_simtool_protocol(tool: str) -> None:
+        """Test that all sim plugins implement the SimTool interface."""
+        plugin = get_sim_tool_plugin(tool)
+
+        assert_that(plugin, instance_of(SimTool))