def _add_data_types(self, external=None):
"""
Add data types packages (sources corresponding to VHPIDIRECT arrays, or their placeholders)
:param external: struct to select whether to enable external models for 'string' and/or 'integer' vectors.
{'string': <VAL>, 'integer': <VAL>}. Allowed values are: None, False/True or
['path/to/custom/file'].
"""
self._add_files(join(VHDL_PATH, "data_types", "src", "*.vhd"))
use_ext = {"string": False, "integer": False}
files = {"string": None, "integer": None}
if external:
for ind, val in external.items():
if isinstance(val, bool):
use_ext[ind] = val
else:
use_ext[ind] = True
files[ind] = val
for _, val in use_ext.items():
if val and simulator_check(
lambda simclass: not simclass.supports_vhpi()):
raise RuntimeError(
"the selected simulator does not support VHPI; must use non-VHPI packages..."
)
ext_path = join(VHDL_PATH, "data_types", "src", "external")
def default_files(cond, type_str):
"""
Return name of VHDL file with default VHPIDIRECT foreign declarations.
"""
return [
join(
ext_path,
"external_" + type_str + "-" + ("" if cond else "no") +
"vhpi.vhd",
),
join(ext_path, "external_" + type_str + "-body.vhd"),
]
if not files["string"]:
files["string"] = default_files(use_ext["string"], "string")
if not files["integer"]:
files["integer"] = default_files(use_ext["integer"],
"integer_vector")
for _, val in files.items():
for name in val:
self._add_files(name)
class TestExternalRunScripts(unittest.TestCase):
"""
Verify that example projects run correctly
"""
def test_vhdl_uart_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "uart" / "run.py"))
@unittest.skipUnless(simulator_supports_verilog(), "Verilog")
def test_verilog_uart_example_project(self):
self.check(str(ROOT / "examples" / "verilog" / "uart" / "run.py"))
@unittest.skipUnless(simulator_supports_verilog(), "Verilog")
def test_verilog_ams_example(self):
self.check(
str(ROOT / "examples" / "verilog" / "verilog_ams" / "run.py"))
check_report(
self.report_file,
[
("passed", "lib.tb_dut.Test that pass"),
("failed", "lib.tb_dut.Test that fail"),
],
)
def test_vhdl_logging_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "logging" / "run.py"))
def test_vhdl_run_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "run" / "run.py"),
exit_code=1)
check_report(
self.report_file,
[
("passed", "lib.tb_with_watchdog.Test to_string for boolean"),
("passed",
"lib.tb_with_watchdog.Test that needs longer timeout"),
("passed", "lib.tb_standalone.Test to_string for boolean"),
("passed",
"lib.tb_with_test_cases.Test to_string for integer"),
("passed",
"lib.tb_with_test_cases.Test to_string for boolean"),
("passed", "lib.tb_with_lower_level_control.Test something"),
("passed",
"lib.tb_with_lower_level_control.Test something else"),
("passed", "lib.tb_running_test_case.Test scenario A"),
("passed", "lib.tb_running_test_case.Test scenario B"),
("passed", "lib.tb_running_test_case.Test something else"),
("passed", "lib.tb_minimal.all"),
("passed", "lib.tb_magic_paths.all"),
("failed", "lib.tb_with_watchdog.Test that stalls"),
(
"failed",
"lib.tb_with_watchdog.Test that stalling processes can inform why they caused a timeout",
),
(
"failed",
"lib.tb_counting_errors.Test that fails multiple times but doesn't stop",
),
(
"failed",
"lib.tb_standalone.Test that fails on VUnit check procedure",
),
("failed",
"lib.tb_many_ways_to_fail.Test that fails on an assert"),
(
"failed",
"lib.tb_many_ways_to_fail.Test that crashes on boundary problems",
),
(
"failed",
"lib.tb_many_ways_to_fail.Test that fails on VUnit check procedure",
),
],
)
def test_vhdl_third_party_integration_example_project(self):
self.check(
str(ROOT / "examples" / "vhdl" / "third_party_integration" /
"run.py"),
exit_code=1,
)
check_report(
self.report_file,
[
("passed",
"lib.tb_external_framework_integration.Test that pass"),
(
"failed",
"lib.tb_external_framework_integration.Test that stops the simulation on first error",
),
(
"failed",
"lib.tb_external_framework_integration.Test that doesn't stop the simulation on error",
),
],
)
def test_vhdl_check_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "check" / "run.py"))
@unittest.skipIf(
simulator_check(lambda simclass: not simclass.supports_coverage()),
"This simulator/backend does not support coverage",
)
def test_vhdl_coverage_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "coverage" / "run.py"))
def test_vhdl_generate_tests_example_project(self):
self.check(
str(ROOT / "examples" / "vhdl" / "generate_tests" / "run.py"))
check_report(
self.report_file,
[
("passed", "lib.tb_generated.data_width=1,sign=False.Test 1"),
("passed", "lib.tb_generated.data_width=1,sign=True.Test 1"),
("passed", "lib.tb_generated.data_width=2,sign=False.Test 1"),
("passed", "lib.tb_generated.data_width=2,sign=True.Test 1"),
("passed", "lib.tb_generated.data_width=3,sign=False.Test 1"),
("passed", "lib.tb_generated.data_width=3,sign=True.Test 1"),
("passed", "lib.tb_generated.data_width=4,sign=False.Test 1"),
("passed", "lib.tb_generated.data_width=4,sign=True.Test 1"),
("passed", "lib.tb_generated.data_width=16,sign=True.Test 2"),
],
)
def test_vhdl_composite_generics_example_project(self):
self.check(
str(ROOT / "examples" / "vhdl" / "composite_generics" / "run.py"))
check_report(
self.report_file,
[
("passed", "tb_lib.tb_composite_generics.VGA.Test 1"),
("passed", "tb_lib.tb_composite_generics.tiny.Test 1"),
],
)
@unittest.skipUnless(simulator_is("ghdl"),
"Support complex JSON strings as generic")
def test_vhdl_json4vhdl_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "json4vhdl" / "run.py"))
def test_vhdl_array_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "array" / "run.py"))
def test_vhdl_array_axis_vcs_example_project(self):
self.check(
str(ROOT / "examples" / "vhdl" / "array_axis_vcs" / "run.py"))
def test_vhdl_axi_dma_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "axi_dma" / "run.py"))
def test_vhdl_user_guide_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "user_guide" / "run.py"),
exit_code=1)
check_report(
self.report_file,
[
("passed", "lib.tb_example.all"),
("passed", "lib.tb_example_many.test_pass"),
("failed", "lib.tb_example_many.test_fail"),
],
)
@unittest.skipUnless(simulator_supports_verilog(), "Verilog")
def test_verilog_user_guide_example_project(self):
self.check(str(ROOT / "examples" / "verilog" / "user_guide" /
"run.py"),
exit_code=1)
check_report(
self.report_file,
[
("passed", "lib.tb_example_basic.all"),
("passed",
"lib.tb_example.Test that a successful test case passes"),
(
"failed",
"lib.tb_example.Test that a failing test case actually fails",
),
(
"failed",
"lib.tb_example.Test that a test case that takes too long time fails with a timeout",
),
],
)
def test_vhdl_com_example_project(self):
self.check(str(ROOT / "examples" / "vhdl" / "com" / "run.py"))
def test_array_vhdl_2008(self):
self.check(str(VHDL_PATH / "array" / "run.py"))
def test_data_types_vhdl_2008(self):
self.check(str(VHDL_PATH / "data_types" / "run.py"))
def test_data_types_vhdl_2002(self):
self.check(str(VHDL_PATH / "data_types" / "run.py"),
vhdl_standard="2002")
def test_data_types_vhdl_93(self):
self.check(str(VHDL_PATH / "data_types" / "run.py"),
vhdl_standard="93")
def test_random_vhdl_2008(self):
self.check(str(VHDL_PATH / "random" / "run.py"))
def test_check_vhdl_2008(self):
self.check(str(VHDL_PATH / "check" / "run.py"))
def test_check_vhdl_2002(self):
self.check(str(VHDL_PATH / "check" / "run.py"), vhdl_standard="2002")
def test_check_vhdl_93(self):
self.check(str(VHDL_PATH / "check" / "run.py"), vhdl_standard="93")
def test_logging_vhdl_2008(self):
self.check(str(VHDL_PATH / "logging" / "run.py"))
def test_logging_vhdl_2002(self):
self.check(str(VHDL_PATH / "logging" / "run.py"), vhdl_standard="2002")
def test_logging_vhdl_93(self):
self.check(str(VHDL_PATH / "logging" / "run.py"), vhdl_standard="93")
def test_run_vhdl_2008(self):
self.check(str(VHDL_PATH / "run" / "run.py"))
def test_run_vhdl_2002(self):
self.check(str(VHDL_PATH / "run" / "run.py"), vhdl_standard="2002")
def test_run_vhdl_93(self):
self.check(str(VHDL_PATH / "run" / "run.py"), vhdl_standard="93")
def test_string_ops_vhdl_2008(self):
self.check(str(VHDL_PATH / "string_ops" / "run.py"))
def test_string_ops_vhdl_2002(self):
self.check(str(VHDL_PATH / "string_ops" / "run.py"),
vhdl_standard="2002")
def test_string_ops_vhdl_93(self):
self.check(str(VHDL_PATH / "string_ops" / "run.py"),
vhdl_standard="93")
def test_dictionary_vhdl_2008(self):
self.check(str(VHDL_PATH / "dictionary" / "run.py"))
def test_dictionary_vhdl_2002(self):
self.check(str(VHDL_PATH / "dictionary" / "run.py"),
vhdl_standard="2002")
def test_dictionary_vhdl_93(self):
self.check(str(VHDL_PATH / "dictionary" / "run.py"),
vhdl_standard="93")
def test_path_vhdl_2008(self):
self.check(str(VHDL_PATH / "path" / "run.py"))
def test_path_vhdl_2002(self):
self.check(str(VHDL_PATH / "path" / "run.py"), vhdl_standard="2002")
def test_path_vhdl_93(self):
self.check(str(VHDL_PATH / "path" / "run.py"), vhdl_standard="93")
def test_com_vhdl_2008(self):
self.check(str(VHDL_PATH / "com" / "run.py"))
def setUp(self):
self.output_path = str(Path(__file__).parent / "external_run_out")
self.report_file = str(Path(self.output_path) / "xunit.xml")
def check(self,
run_file: Path,
args=None,
vhdl_standard="2008",
exit_code=0):
"""
Run external run file and verify exit code
"""
args = args if args is not None else []
new_env = environ.copy()
new_env["VUNIT_VHDL_STANDARD"] = vhdl_standard
retcode = call(
[
sys.executable,
str(run_file),
"--clean",
"--output-path=%s" % self.output_path,
"--xunit-xml=%s" % self.report_file,
] + args,
env=new_env,
)
self.assertEqual(retcode, exit_code)
"""
import sys
from os import environ
from pathlib import Path
from subprocess import call
import unittest
import pytest
from vunit.sim_if.common import has_simulator, simulator_check
ROOT = Path(__file__).parent.parent.parent
@unittest.skipIf(
not has_simulator()
or simulator_check(lambda simclass: not simclass.supports_vhpi()),
"A simulator/backend that supports interfacing with external C code is required",
)
class TestExamples(unittest.TestCase):
"""
Verify that example projects run correctly
"""
def setUp(self):
self.output_path = str(Path(__file__).parent / "examples_run_out")
self.report_file = str(Path(self.output_path) / "xunit.xml")
def check(self, run_file, args=None, vhdl_standard="2008", exit_code=0):
"""
Run external run file and verify exit code
"""
args = args if args is not None else []