Refactor to better support extensions of VHDL configurations.

Author: LarsAsplund

docs/py/vunit.rst

@@ -30,6 +30,14 @@ Test
 
 .. autoclass:: vunit.ui.test.Test()
 
+ConfigurationList
+-----------------
+
+.. autoclass:: vunit.ui.configuration.ConfigurationList()
+   :special-members: __iter__
+   :inherited-members:
+
+
 Configuration
 -------------
 

examples/vhdl/vhdl_configuration/run.py

@@ -19,23 +19,30 @@
 # VHDL configurations are detected automatically and are treated as a special
 # case of the broader VUnit configuration concept. As such the configuration
 # can be extended beyond the capabilities of a pure VHDL configuration. For example,
-# by adding a post_check function. The exception is generics since VHDL doesn't allow
-# generics to be combined with configurations. Workarounds for this limitation can be
-# found in the handling_generics_limitation directory
+# by adding a pre_config or post_check function hooks. The exception is generics since VHDL
+# doesn't allow generics to be combined with configurations.
+# Workarounds for this limitation can be found in the handling_generics_limitation directory
 
 # Get the VHDL-defined configurations from test or testbench objects using a pattern matching
 # configurations of interest.
 tb = lib.test_bench("tb_selecting_dut_with_vhdl_configuration")
-configurations = tb.get_configs("dff_*")
+configs = tb.get_configs("dff_*")
 
 # Remember to run the run script with the -v flag to see the message from the dummy post_check
-def post_check(output_path):
-    print("Running post-check")
+def make_hook(msg):
+    def hook(output_path):
+        print(msg)
 
-    return True
+        return True
 
+    return hook
 
-configurations.set_post_check(post_check)
+
+configs.set_post_check(make_hook("Common post_check"))
+
+# You can also loop over the matching configurations
+for config in configs:
+    config.set_pre_config(make_hook(f"pre_config for {config.name}"))
 
 # The testbenches in the handling_generics_limitation directory are examples of how the generics
 # limitation of VHDL configurations can be worked around. This allow us to create configurations

tests/acceptance/artificial/vhdl/run.py

@@ -96,7 +96,12 @@ def post_check(output_path):
     tb = ui.library("lib").test_bench("tb_with_vhdl_configuration")
     tb.get_configs("cfg*").set_post_check(make_post_check("arch1"))
     tb.test("test1").get_configs("cfg2").set_post_check(make_post_check("arch2"))
-    tb.test("test2").get_configs("cfg2").set_post_check(make_post_check("arch2"))
+    for config in tb.test("test2").get_configs():
+        if config.name == "cfg2":
+            config.set_post_check(make_post_check("arch2"))
+    tb.test("test1").delete_config("cfg1")
+    tb.add_config("foo")
+    tb.delete_config("foo")
 
 
 configure_tb_with_generic_config()

tests/acceptance/test_artificial.py

@@ -245,10 +245,6 @@ def test_exit_0_flag(self):
         "failed",
         "lib.tb_assert_stop_level.Report failure when VHDL assert stop level = failure",
     ),
-    (
-        "passed",
-        "lib.tb_with_vhdl_configuration.cfg1.test1",
-    ),
     (
         "passed",
         "lib.tb_with_vhdl_configuration.cfg1.test2",

tests/unit/test_configuration.py

@@ -46,11 +46,11 @@ def test_error_on_setting_illegal_value_sim_option(self):
             self.assertRaises(ValueError, config.set_sim_option, "vhdl_assert_stop_level", "illegal")
 
     def test_error_on_both_generics_and_vhdl_configuration(self):
-        with _create_config(vhdl_configuration_name="cfg") as config:
+        with _create_config(vhdl_config_name="cfg") as config:
             self.assertRaises(GenericAndVHDLConfigurationException, config.set_generic, "foo", "bar")
 
         with _create_config(generics=dict(foo=17)) as config:
-            self.assertRaises(GenericAndVHDLConfigurationException, config.set_vhdl_configuration_name, "bar")
+            self.assertRaises(GenericAndVHDLConfigurationException, config.set_vhdl_config_name, "bar")
 
     def test_sim_option_is_not_mutated(self):
         with _create_config() as config:

tests/unit/test_incisive_interface.py

@@ -967,7 +967,7 @@ def test_configuration_and_entity_selection(self, find_cds_root_irun, find_cds_r
         with create_tempdir() as tempdir:
             design_unit = Entity("tb_entity", file_name=str(Path(tempdir) / "file.vhd"))
             design_unit.generic_names = ["runner_cfg"]
-            config = Configuration("name", design_unit, vhdl_configuration_name="cfg")
+            config = Configuration("name", design_unit, vhdl_config_name="cfg")
             simif = IncisiveInterface(prefix="prefix", output_path=self.output_path)
             self.assertEqual(simif._select_vhdl_top(config), "cfg")  # pylint: disable=protected-access
             config = Configuration("name", design_unit)
@@ -1002,5 +1002,5 @@ def make_config(sim_options=None, generics=None, verilog=False):
 
     cfg.sim_options = {} if sim_options is None else sim_options
     cfg.generics = {} if generics is None else generics
-    cfg.vhdl_configuration_name = None
+    cfg.vhdl_config_name = None
     return cfg

tests/unit/test_test_suites.py

@@ -216,7 +216,7 @@ def get_simulator_output_path(self, output_path):
 
             for expect_runner_cfg_generic in [False, True]:
                 config = Configuration(
-                    "name", design_unit, vhdl_configuration_name=None if expect_runner_cfg_generic else "cfg"
+                    "name", design_unit, vhdl_config_name=None if expect_runner_cfg_generic else "cfg"
                 )
                 sim_if = TestSimIf(output_path, gui=False, expect_runner_cfg_generic=expect_runner_cfg_generic)
 

vunit/configuration.py

@@ -43,14 +43,14 @@ def __init__(  # pylint: disable=too-many-arguments
         pre_config=None,
         post_check=None,
         attributes=None,
-        vhdl_configuration_name=None,
+        vhdl_config_name=None,
     ):
         self.name = name
         self._design_unit = design_unit
         self.generics = {} if generics is None else generics
         self.sim_options = {} if sim_options is None else sim_options
         self.attributes = {} if attributes is None else attributes
-        self.vhdl_configuration_name = vhdl_configuration_name
+        self.vhdl_config_name = vhdl_config_name
 
         self.tb_path = str(Path(design_unit.original_file_name).parent)
 
@@ -70,7 +70,7 @@ def copy(self):
             pre_config=self.pre_config,
             post_check=self.post_check,
             attributes=self.attributes.copy(),
-            vhdl_configuration_name=self.vhdl_configuration_name,
+            vhdl_config_name=self.vhdl_config_name,
         )
 
     @property
@@ -109,20 +109,20 @@ def set_attribute(self, name, value):
         else:
             raise AttributeException
 
-    def set_vhdl_configuration_name(self, name):
+    def set_vhdl_config_name(self, name):
         """
         Set VHDL configuration name
         """
         if self.generics:
             raise GenericAndVHDLConfigurationException("Generics can't be used with VHDL configurations.")
 
-        self.vhdl_configuration_name = name
+        self.vhdl_config_name = name
 
     def set_generic(self, name, value):
         """
         Set generic
         """
-        if self.vhdl_configuration_name:
+        if self.vhdl_config_name:
             raise GenericAndVHDLConfigurationException("Generics can't be used with VHDL configurations.")
         if name not in self._design_unit.generic_names:
             LOGGER.warning(
@@ -210,7 +210,10 @@ def get_configuration_dicts():
 
     def set_attribute(self, name, value):
         """
-        Set attribute
+        Set attribute.
+
+        :param name: Attribute name.
+        :param value: Attribute value.
         """
         self._check_enabled()
         for configs in self.get_configuration_dicts():
@@ -219,7 +222,10 @@ def set_attribute(self, name, value):
 
     def set_generic(self, name, value):
         """
-        Set generic
+        Set generic.
+
+        :param name: Generic name.
+        :param value: Generic value.
         """
         self._check_enabled()
         for configs in self.get_configuration_dicts():
@@ -228,8 +234,10 @@ def set_generic(self, name, value):
 
     def set_sim_option(self, name, value, overwrite=True):
         """
-        Set sim option
+        Set simulation option
 
+        :param name: Simulation option name.
+        :param value: Simulation option value.
         :param overwrite: To overwrite the option or append to the existing value
         """
         self._check_enabled()
@@ -243,6 +251,8 @@ def set_sim_option(self, name, value, overwrite=True):
     def set_pre_config(self, value):
         """
         Set pre_config function
+
+        :param value: pre_config function.
         """
         self._check_enabled()
         for configs in self.get_configuration_dicts():
@@ -252,6 +262,8 @@ def set_pre_config(self, value):
     def set_post_check(self, value):
         """
         Set post_check function
+
+        :param value: post_check function.
         """
         self._check_enabled()
         for configs in self.get_configuration_dicts():
@@ -266,10 +278,10 @@ def add_config(  # pylint: disable=too-many-arguments, too-many-branches
         post_check=None,
         sim_options=None,
         attributes=None,
-        vhdl_configuration_name=None,
+        vhdl_config_name=None,
     ):
         """
-        Add a configuration copying unset fields from the default configuration:
+        Add a configuration copying unset fields from the default configuration.
         """
         self._check_enabled()
 
@@ -291,7 +303,7 @@ def add_config(  # pylint: disable=too-many-arguments, too-many-branches
                 config.post_check = post_check
 
             if generics is not None:
-                if config.vhdl_configuration_name:
+                if config.vhdl_config_name:
                     raise GenericAndVHDLConfigurationException
                 config.generics.update(generics)
 
@@ -304,9 +316,22 @@ def add_config(  # pylint: disable=too-many-arguments, too-many-branches
                         raise AttributeException
                 config.attributes.update(attributes)
 
-            if vhdl_configuration_name is not None:
+            if vhdl_config_name is not None:
                 if config.generics:
                     raise GenericAndVHDLConfigurationException
-                config.vhdl_configuration_name = vhdl_configuration_name
+                config.vhdl_config_name = vhdl_config_name
 
             configs[config.name] = config
+
+    def delete_config(self, name):
+        """
+        Delete a configuration.
+        """
+        found_config = False
+        for configs in self.get_configuration_dicts():
+            if name in configs:
+                found_config = True
+                del configs[name]
+
+        if not found_config:
+            raise RuntimeError(f"Configuration name {name!s} not defined")

vunit/sim_if/activehdl.py

@@ -238,12 +238,12 @@ def _create_load_function(self, config, output_path):
             config.library_name,
         ]
 
-        if config.vhdl_configuration_name is None:
+        if config.vhdl_config_name is None:
             vsim_flags.append(config.entity_name)
             if config.architecture_name is not None:
                 vsim_flags.append(config.architecture_name)
         else:
-            vsim_flags.append(config.vhdl_configuration_name)
+            vsim_flags.append(config.vhdl_config_name)
 
         if config.sim_options.get("enable_coverage", False):
             coverage_file_path = str(Path(output_path) / "coverage.acdb")

vunit/sim_if/ghdl.py

@@ -286,8 +286,8 @@ def _get_command(self, config, output_path, elaborate_only, ghdl_e, wave_file):
             # Enable coverage in linker
             cmd += ["-Wl,-lgcov"]
 
-        if config.vhdl_configuration_name is not None:
-            cmd += [config.vhdl_configuration_name]
+        if config.vhdl_config_name is not None:
+            cmd += [config.vhdl_config_name]
         else:
             cmd += [config.entity_name, config.architecture_name]