Added support for VCI and VC belonging to different libraries.

Improved compliance tests to detect lack of as_sync function and added missing functions to VUnit VCIs

Author: LarsAsplund

tests/unit/test_compliance_test.py

@@ -29,6 +29,10 @@ class TestComplianceTest(TestCase):  # pylint: disable=too-many-public-methods
     def setUp(self):
         self.tmp_dir = Path(__file__).parent / "vc_tmp"
         renew_path(str(self.tmp_dir))
+        self.vc_dir = self.tmp_dir / "vc"
+        renew_path(str(self.vc_dir))
+        self.vci_dir = self.tmp_dir / "vci"
+        renew_path(str(self.vci_dir))
         self.vc_contents = """
 library ieee
 use ieee.std_logic_1164.all;
@@ -45,7 +49,7 @@ def setUp(self):
 
 end entity;
 """
-        self.vc_path = self.make_file("vc.vhd", self.vc_contents)
+        self.vc_path = self.make_file("vc.vhd", self.vc_contents, self.vc_dir)
 
         self.vci_contents = """
 package vc_pkg is
@@ -59,32 +63,38 @@ def setUp(self):
     checker : checker_t := null_checker;
     unexpected_msg_type_policy : unexpected_msg_type_policy_t := fail
   ) return vc_handle_t;
+
+  function as_sync(handle : vc_handle_t) return sync_handle_t;
 end package;
 """
-        self.vci_path = self.make_file("vci.vhd", self.vci_contents)
+        self.vci_path = self.make_file("vci.vhd", self.vci_contents, self.vci_dir)
 
         self.ui = VUnit.from_argv([])
 
         self.vc_lib = self.ui.add_library("vc_lib")
-        self.vc_lib.add_source_files(str(self.tmp_dir / "*.vhd"))
+        self.vc_lib.add_source_files(str(self.vc_dir / "*.vhd"))
+
+        self.vci_lib = self.ui.add_library("vci_lib")
+        self.vci_lib.add_source_files(str(self.vci_dir / "*.vhd"))
 
     def tearDown(self):
         if self.tmp_dir.exists():
             rmtree(self.tmp_dir)
 
-    def make_file(self, file_name, contents):
+    def make_file(self, file_name, contents, directory=None):
         """
         Create a file in the temporary directory with contents
         Returns the absolute path to the file.
         """
-        full_file_name = (self.tmp_dir / file_name).resolve()
+        directory = directory if directory is not None else self.tmp_dir
+        full_file_name = (directory / file_name).resolve()
         with full_file_name.open("w") as outfile:
             outfile.write(contents)
         return str(full_file_name)
 
     @mock.patch("vunit.vc.verification_component_interface.LOGGER.error")
     def test_not_finding_vc(self, error_mock):
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         self.assertRaises(
             SystemExit, VerificationComponent.find, self.vc_lib, "other_vc", vci
         )
@@ -95,7 +105,7 @@ def test_not_finding_vci(self, error_mock):
         self.assertRaises(
             SystemExit,
             VerificationComponentInterface.find,
-            self.vc_lib,
+            self.vci_lib,
             "other_vc_pkg",
             "vc_handle_t",
         )
@@ -113,15 +123,15 @@ def test_failing_on_multiple_entities(self, error_mock):
 end entity;
 """
         self.vc_lib.add_source_file(self.make_file("vc1_2.vhd", vc_contents))
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         self.assertRaises(
             SystemExit, VerificationComponent.find, self.vc_lib, "vc1", vci
         )
         error_mock.assert_called_once_with(
             "%s must contain a single VC entity", self.tmp_dir / "vc1_2.vhd"
         )
 
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         self.assertRaises(
             SystemExit, VerificationComponent.find, self.vc_lib, "vc2", vci
         )
@@ -167,7 +177,7 @@ def test_evaluating_vc_generics(self, error_mock):
 end entity;
 """
         self.vc_lib.add_source_file(self.make_file("vc1.vhd", vc1_contents))
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         self.assertRaises(
             SystemExit, VerificationComponent.find, self.vc_lib, "vc1", vci
         )
@@ -179,7 +189,7 @@ def test_evaluating_vc_generics(self, error_mock):
 end entity;
 """
         self.vc_lib.add_source_file(self.make_file("vc2.vhd", vc2_contents))
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         self.assertRaises(
             SystemExit, VerificationComponent.find, self.vc_lib, "vc2", vci
         )
@@ -191,7 +201,7 @@ def test_evaluating_vc_generics(self, error_mock):
 end entity;
 """
         self.vc_lib.add_source_file(self.make_file("vc3.vhd", vc3_contents))
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         self.assertRaises(
             SystemExit, VerificationComponent.find, self.vc_lib, "vc3", vci
         )
@@ -206,6 +216,7 @@ def test_failing_with_no_constructor(self, error_mock):
   end record;
 
   impure function create_vc return vc_handle_t;
+  function as_sync(handle : vc_handle_t) return sync_handle_t;
 end package;
 """
         self.vc_lib.add_source_file(self.make_file("other_vci.vhd", vci_contents))
@@ -230,6 +241,8 @@ def test_failing_with_wrong_constructor_return_type(self, error_mock):
   end record;
 
   impure function new_vc return vc_t;
+  function as_sync(handle : vc_handle_t) return sync_handle_t;
+
 end package;
 """
         self.vc_lib.add_source_file(self.make_file("other_vci.vhd", vci_contents))
@@ -300,6 +313,7 @@ def test_failing_on_incorrect_constructor_parameters(self, error_mock):
                 vci_contents[:-2]
                 + """
   ) return vc_handle_t;
+  function as_sync(handle : vc_handle_t) return sync_handle_t;
 end package;
 """
             )
@@ -348,6 +362,7 @@ def test_failing_on_non_private_handle_elements(self, error_mock):
     checker : checker_t := null_checker;
     unexpected_msg_type_policy : unexpected_msg_type_policy_t := fail
   ) return vc_handle_t;
+  function as_sync(handle : vc_handle_t) return sync_handle_t;
 end package;
 """
 
@@ -378,6 +393,7 @@ def test_failing_on_missing_handle_record(self, error_mock):
     checker : checker_t := null_checker;
     unexpected_msg_type_policy : unexpected_msg_type_policy_t := fail
   ) return vc_handle_t;
+  function as_sync(handle : vc_handle_t) return sync_handle_t;
 end package;
 """
 
@@ -432,6 +448,7 @@ def test_error_on_missing_default_value(self):
                 vci_contents[:-2]
                 + """
   ) return vc_handle_t;
+  function as_sync(handle : vc_handle_t) return sync_handle_t;
 end package;
 """
             )
@@ -472,11 +489,11 @@ def test_create_vhdl_testbench_template_references(self):
 
         vc_path = self.make_file("vc2.vhd", vc_contents)
         template, _ = VerificationComponent.create_vhdl_testbench_template(
-            "vc_lib", vc_path, self.vci_path
+            "vc_lib", "vc_lib", vc_path, self.vci_path
         )
         template = VHDLDesignFile.parse(template)
         refs = template.references
-        self.assertEqual(len(refs), 13)
+        self.assertEqual(len(refs), 14)
         self.assertIn(VHDLReference("library", "vunit_lib"), refs)
         self.assertIn(VHDLReference("library", "vc_lib"), refs)
         self.assertIn(VHDLReference("library", "a_lib"), refs)
@@ -485,6 +502,7 @@ def test_create_vhdl_testbench_template_references(self):
         self.assertIn(VHDLReference("package", "vc_lib", "vc_pkg", "all"), refs)
         self.assertIn(VHDLReference("package", "a_lib", "x", "y"), refs)
         self.assertIn(VHDLReference("package", "vunit_lib", "sync_pkg", "all"), refs)
+        self.assertIn(VHDLReference("package", "vunit_lib", "vc_pkg", "all"), refs)
         self.assertIn(VHDLReference("context", "vc_lib", "spam"), refs)
         self.assertIn(VHDLReference("context", "a_lib", "eggs"), refs)
         self.assertIn(VHDLReference("context", "vunit_lib", "vunit_context"), refs)
@@ -510,7 +528,7 @@ def test_template_with_wrong_name(self):
 
         template_path = self.make_file("template.vhd", template_contents)
 
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         vc = VerificationComponent.find(self.vc_lib, "vc", vci)
         self.assertRaises(RuntimeError, vc.create_vhdl_testbench, template_path)
 
@@ -532,7 +550,7 @@ def test_template_missing_contructor(self):
 
         template_path = self.make_file("template.vhd", template_contents)
 
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         vc = VerificationComponent.find(self.vc_lib, "vc", vci)
         self.assertRaises(RuntimeError, vc.create_vhdl_testbench, template_path)
 
@@ -555,7 +573,7 @@ def test_template_missing_runner_cfg(self):
 
         template_path = self.make_file("template.vhd", template_contents)
 
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         vc = VerificationComponent.find(self.vc_lib, "vc", vci)
         self.assertRaises(RuntimeError, vc.create_vhdl_testbench, template_path)
 
@@ -578,7 +596,7 @@ def test_template_missing_test_runner(self):
 
         template_path = self.make_file("template.vhd", template_contents)
 
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         vc = VerificationComponent.find(self.vc_lib, "vc", vci)
         self.assertRaises(RuntimeError, vc.create_vhdl_testbench, template_path)
 
@@ -667,7 +685,9 @@ def test_creating_template_with_specified_vc_lib(self):
             [
                 "compliance_test.py",
                 "create-vc",
-                "-l",
+                "--vc-lib-name",
+                "my_vc_lib",
+                "--vci-lib-name",
                 "my_vc_lib",
                 self.vc_path,
                 self.vci_path,
@@ -688,7 +708,7 @@ def test_creating_template_with_specified_vc_lib(self):
     def test_adding_vhdl_testbench(self):
         vc_test_lib = self.ui.add_library("vc_test_lib")
 
-        vci = VerificationComponentInterface.find(self.vc_lib, "vc_pkg", "vc_handle_t")
+        vci = VerificationComponentInterface.find(self.vci_lib, "vc_pkg", "vc_handle_t")
         vc = VerificationComponent.find(self.vc_lib, "vc", vci)
 
         vc.add_vhdl_testbench(vc_test_lib, str(self.tmp_dir / "compliance_test"))

vunit/vc/compliance_test.py

@@ -18,7 +18,7 @@
 def _create_vc_template(args):
     """Creates VC testbench template from args."""
     template_code, vc_name = VerificationComponent.create_vhdl_testbench_template(
-        args.vc_lib_name, args.vc_path, args.vci_path
+        args.vc_lib_name, args.vci_lib_name, args.vc_path, args.vci_path
     )
     if not template_code or not vc_name:
         sys.exit(1)
@@ -46,21 +46,21 @@ def _create_vci_template(args):
         template_code,
         vci_name,
     ) = VerificationComponentInterface.create_vhdl_testbench_template(
-        args.vc_lib_name, args.vci_path, args.vc_handle_t
+        args.vci_lib_name, args.vci_path, args.vc_handle_t
     )
     if not template_code or not vci_name:
         sys.exit(1)
 
     if not args.output_path:
-        output_dir = args.vci_path.parent / ".vc" / vci_name
+        output_dir = args.vc_path.parent / ".vc" / vci_name
         if not output_dir.exists():
             output_dir.mkdir(parents=True)
 
         output_path = output_dir / ("tb_%s_compliance_template.vhd" % args.vc_handle_t)
     elif args.output_path.is_dir():
         output_dir = args.output_path / vci_name
         if not output_dir.exists():
-            output_dir.mkdir(parents=True)
+            output_dir.exists(parents=True)
         output_path = output_dir / ("tb_%s_compliance_template.vhd" % args.vc_handle_t)
     else:
         output_path = args.output_path
@@ -79,9 +79,13 @@ def create_vc_parser(subparsers):
             "create-vc", help="Creates a VC compliance test template"
         )
         parser.add_argument(
-            "-l",
             "--vc-lib-name",
-            help="Name of library hosting the VC and the VCI (default: vc_lib)",
+            help="Name of library hosting the VC (default: vc_lib)",
+            default="vc_lib",
+        )
+        parser.add_argument(
+            "--vci-lib-name",
+            help="Name of library hosting the VCI (default: vc_lib)",
             default="vc_lib",
         )
         parser.add_argument(
@@ -102,9 +106,8 @@ def create_vci_parser(subparsers):
             "create-vci", help="Creates a VCI compliance test template"
         )
         parser.add_argument(
-            "-l",
-            "--vc-lib-name",
-            help="Name of library hosting the VC and the VCI (default: vc_lib)",
+            "--vci-lib-name",
+            help="Name of library hosting the VCI (default: vc_lib)",
             default="vc_lib",
         )
         parser.add_argument(

vunit/vc/verification_component.py

@@ -99,11 +99,12 @@ def validate(vc_path):
             return vc_code
 
     @staticmethod
-    def create_vhdl_testbench_template(vc_lib_name, vc_path, vci_path):
+    def create_vhdl_testbench_template(vc_lib_name, vci_lib_name, vc_path, vci_path):
         """
         Creates a template for a VC compliance testbench.
 
-        :param vc_lib_name: Name of the library containing the verification component and its interface.
+        :param vc_lib_name: Name of the library containing the verification component.
+        :param vci_lib_name: Name of the library containing the verification component interface.
         :param vc_path: Path to the file containing the verification component entity.
         :param vci_path: Path to the file containing the verification component interface package.
 
@@ -209,8 +210,9 @@ def create_signal_declarations_and_vc_instantiation(vc_entity, vc_lib_name):
 
         initial_package_refs = set(
             [
+                "vunit_lib.vc_pkg.all",
                 "vunit_lib.sync_pkg.all",
-                "%s.%s.all" % (vc_lib_name, vci_code.packages[0].identifier),
+                "%s.%s.all" % (vci_lib_name, vci_code.packages[0].identifier),
             ]
         )
         context_items = create_context_items(
@@ -385,6 +387,7 @@ def update_generics(code):
         else:
             template_code, _ = self.create_vhdl_testbench_template(
                 self.vc_facade.library,
+                self.vci.vci_facade.library,
                 self.vc_facade.source_file.name,
                 self.vci.vci_facade.source_file.name,
             )