Reorganize test dir to ensure test of installed pkg

tests/lib/simulators/__init__.py

@@ -0,0 +1,33 @@
+from typing import Type, TYPE_CHECKING, List
+
+if TYPE_CHECKING:
+    from ..sim_testcase import SimTestCase
+
+class Simulator:
+
+    def __init__(self, testcase_cls: 'Type[SimTestCase]' = None, testcase_cls_inst: 'SimTestCase' = None) -> None:
+        self.testcase_cls = testcase_cls
+        self.testcase_cls_inst = testcase_cls_inst
+
+    @property
+    def tb_files(self) -> List[str]:
+        files = []
+        files.extend(self.testcase_cls.cpuif.get_sim_files())
+        files.append("regblock_pkg.sv")
+        files.append("regblock.sv")
+        files.append("tb.sv")
+
+        return files
+
+    def compile(self) -> None:
+        raise NotImplementedError
+
+    def run(self, plusargs:List[str] = None) -> None:
+        raise NotImplementedError
+
+class StubSimulator(Simulator):
+    def compile(self) -> None:
+        pass
+
+    def run(self, plusargs:List[str] = None) -> None:
+        pass

tests/lib/simulators/questa.py

@@ -0,0 +1,64 @@
+from typing import List
+import subprocess
+import os
+
+from . import Simulator
+
+class Questa(Simulator):
+    def compile(self) -> None:
+        cmd = [
+            "vlog", "-sv", "-quiet", "-l", "build.log",
+
+            "+incdir+%s" % os.path.join(os.path.dirname(__file__), ".."),
+
+            # Use strict LRM conformance
+            "-svinputport=net",
+
+            # all warnings are errors
+            "-warning", "error",
+
+            # Ignore noisy warning about vopt-time checking of always_comb/always_latch
+            "-suppress", "2583",
+        ]
+
+        # Add source files
+        cmd.extend(self.tb_files)
+
+        # Run command!
+        subprocess.run(cmd, check=True)
+
+
+    def run(self, plusargs:List[str] = None) -> None:
+        plusargs = plusargs or []
+
+        test_name = self.testcase_cls_inst.request.node.name
+
+        # call vsim
+        cmd = [
+            "vsim", "-quiet",
+            "-voptargs=+acc",
+            "-msgmode", "both",
+            "-do", "set WildcardFilter [lsearch -not -all -inline $WildcardFilter Memory]",
+            "-do", "log -r /*;",
+            "-do", "run -all; exit;",
+            "-c",
+            "-l", "%s.log" % test_name,
+            "-wlf", "%s.wlf" % test_name,
+            "tb",
+        ]
+        for plusarg in plusargs:
+            cmd.append("+" + plusarg)
+        subprocess.run(cmd, check=True)
+
+        self.assertSimLogPass("%s.log" % test_name)
+
+
+    def assertSimLogPass(self, path: str):
+        self.testcase_cls_inst.assertTrue(os.path.isfile(path))
+
+        with open(path, encoding="utf-8") as f:
+            for line in f:
+                if line.startswith("# ** Error"):
+                    self.testcase_cls_inst.fail(line)
+                elif line.startswith("# ** Fatal"):
+                    self.testcase_cls_inst.fail(line)

tests/lib/simulators/xilinx.py

@@ -0,0 +1,61 @@
+from typing import List
+import subprocess
+import os
+
+from . import Simulator
+
+class Xilinx(Simulator):
+    """
+    Don't bother using the Xilinx simulator... Its buggy and extraordinarily slow.
+    As observed in v2021.1, clocking block assignments do not seem to actually simulate
+    correctly - assignment statements get ignored or the values get mangled.
+
+    Keeping this here in case someday it works better...
+    """
+    def compile(self) -> None:
+        cmd = [
+            "xvlog", "--sv",
+            "--include", os.path.join(os.path.dirname(__file__), ".."),
+        ]
+        cmd.extend(self.tb_files)
+        subprocess.run(cmd, check=True)
+
+        cmd = [
+            "xelab",
+            "--timescale", "1ns/1ps",
+            "--debug", "all",
+            "tb",
+        ]
+        subprocess.run(cmd, check=True)
+
+
+    def run(self, plusargs:List[str] = None) -> None:
+        plusargs = plusargs or []
+
+        test_name = self.testcase_cls_inst.request.node.name
+
+        # call vsim
+        cmd = [
+            "xsim",
+            "--R",
+            "--log", "%s.log" % test_name,
+            "tb",
+        ]
+
+        for plusarg in plusargs:
+            cmd.append("--testplusarg")
+            cmd.append(plusarg)
+        subprocess.run(cmd, check=True)
+
+        self.assertSimLogPass("%s.log" % test_name)
+
+
+    def assertSimLogPass(self, path: str):
+        self.testcase_cls_inst.assertTrue(os.path.isfile(path))
+
+        with open(path, encoding="utf-8") as f:
+            for line in f:
+                if line.startswith("Error:"):
+                    self.testcase_cls_inst.fail(line)
+                elif line.startswith("Fatal:"):
+                    self.testcase_cls_inst.fail(line)