testbed/cocotb__cocotb/tests/pytest/test_runner.py

# Copyright cocotb contributors
# Licensed under the Revised BSD License, see LICENSE for details.
# SPDX-License-Identifier: BSD-3-Clause

import os
import sys

import cocotb
import pytest
from cocotb.runner import get_runner
from cocotb.triggers import Timer

pytestmark = pytest.mark.simulator_required

tests_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sim_build = os.path.join(os.path.dirname(os.path.abspath(__file__)), "sim_build")
sys.path.insert(0, os.path.join(tests_dir, "pytest"))


@cocotb.test()
async def cocotb_runner_test(dut):
    await Timer(1, "ns")

    WIDTH_IN = int(os.environ.get("WIDTH_IN", "8"))
    WIDTH_OUT = int(os.environ.get("WIDTH_OUT", "8"))

    assert WIDTH_IN == len(dut.data_in)
    assert WIDTH_OUT == len(dut.data_out)


@pytest.mark.parametrize(
    "parameters", [{"WIDTH_IN": "8", "WIDTH_OUT": "16"}, {"WIDTH_IN": "16"}]
)
@pytest.mark.parametrize("clean_build", [False, True])
def test_runner(parameters, clean_build):
    hdl_toplevel_lang = os.getenv("HDL_TOPLEVEL_LANG", "verilog")
    vhdl_gpi_interfaces = os.getenv("VHDL_GPI_INTERFACE", None)

    verilog_sources = []
    vhdl_sources = []

    if hdl_toplevel_lang == "verilog":
        verilog_sources = [os.path.join(tests_dir, "designs", "runner", "runner.v")]
        gpi_interfaces = ["vpi"]
    else:
        vhdl_sources = [os.path.join(tests_dir, "designs", "runner", "runner.vhdl")]
        gpi_interfaces = [vhdl_gpi_interfaces]

    sim = os.getenv("SIM", "icarus")
    runner = get_runner(sim)
    compile_args = []
    if sim == "xcelium":
        compile_args = ["-v93"]

    # Pre-make build directory for test file
    build_dir = (
        sim_build
        + "/test_runner/"
        + "_".join("{}={}".format(*i) for i in parameters.items())
    )
    os.makedirs(build_dir, exist_ok=True)
    open(build_dir + "/clean_test_file", "a").close()

    runner.build(
        verilog_sources=verilog_sources,
        vhdl_sources=vhdl_sources,
        hdl_toplevel="runner",
        parameters=parameters,
        defines={"DEFINE": 4},
        includes=[os.path.join(tests_dir, "designs", "basic_hierarchy_module")],
        build_args=compile_args,
        clean=clean_build,
        build_dir=build_dir,
    )

    runner.test(
        hdl_toplevel="runner",
        test_module="test_runner",
        gpi_interfaces=gpi_interfaces,
        extra_env=parameters,
    )

    # In case clean_build runner.build() must purge test directory completely,
    # with the test file inside
    if clean_build:
        assert not os.path.isfile(build_dir + "/clean_test_file")
    else:
        assert os.path.isfile(build_dir + "/clean_test_file")