Added support for running testbenches depending on a set of user-prov…

[LarsAsplund]

…ided source files.

The intended use case is to feed VUnit with files that has been changed since some point in time. The changes are typically provided by the version control system.

The API is:

    def run_dependent(self, source_files: List[Union[str, Path]]) -> None:
        """
        Run testbenches depending on the provided source files.

        Test patterns on the command line will add to the depending testbenches.

        :param source_files: List of :class:`str` or :class:`pathlib.Path` items,
                             each representing the relative or absolute path to
                             the source file.
        :returns: None
        """

[LarsAsplund]

@LukasVik Is this compatible with the similar function in TSFPGA?

[LukasVik]

Yes this would simplify it a lot. Good initiative! Can a testbench file be passed as argument also? Or is it limited to “source”/“implementation” files? Does it work when location/check preprocessing is enabled also? From e.g. a git diff you would have the original file location, not the preprocessed file location. Will that work as expected? So if I understand it correctly, one would call this new “run_dependent()” method and it adds to the test filter. But one would still call “main()” after to actually execute the tests? If so I think the verbiage is a little misleading. Perhaps “add_dependents_to_test_filter”? Thanks!

…

On Sun, 26 Jan 2025 at 17:37, Lars Asplund ***@***.***> wrote: @LukasVik <https://github.com/LukasVik> Is this compatible with the similar function in TSFPGA? — Reply to this email directly, view it on GitHub <#1095 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACOEO6YS3BS3TOEVTNRQBED2MUFMPAVCNFSM6AAAAABV4TG252VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJUGQ4TONBRGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[LarsAsplund]

@LukasVik

Yes, a testbench can also be passed. The testbench is dependent on itself.

Note that there are important changes that VUnit can't detect directly. Let's say you have no changes to your HDL files but there's a stimuli file to tb_x that changed. In that case tb_x should be simulated. The way to deal with that is to process the changes reported by your version control system. If the stimuli file has changed, tb_x is added to the list of files.

Preprocessing works. VUnit keeps track of both the original file name and the preprocessed file name and the user-provided files are compared with the original.

Your understanding of run_dependent is correct. Agree that the name is a bit misleading and should be changed. I'm thinking about include_dependent_in_test_pattern because it makes it easier to also add a exclude_dependent_from_test_pattern.

[LukasVik]

Sounds great!

Note that there are important changes that VUnit can't detect directly. Let's say you have no changes to your HDL files but there's a stimuli file to tb_x that changed. In that case tb_x should be simulated. The way to deal with that is to process the changes reported by your version control system. If the stimuli file has changed, tb_x is added to the list of files.

Yes makes sense. In the tsfpga class (https://github.com/tsfpga/tsfpga/blob/main/tsfpga/git_simulation_subset.py) we detect changes in the regs_*.toml/json/yaml and trigger based on that. There are probably other cases like that but I agree that all that needs to be handled outside of VUnit.

Preprocessing works. VUnit keeps track of both the original file name and the preprocessed file name and the user-provided files are compared with the original.

Great, a lot of the complexity in the tsfpga class is the handling of original vs processed path. Nice to get rid of that.

Your understanding of run_dependent is correct. Agree that the name is a bit misleading and should be changed. I'm thinking about include_dependent_in_test_pattern because it makes it easier to also add a exclude_dependent_from_test_pattern.

Cool. I agree with the naming.

[LukasVik]

Looks overall good to me, it's a good addtion. Some minor comments.