a9653c8497
* wip * reorg * update sv int * apb4 working * apb3 working * version bump + ignore runner warning * remove redundant check * adding log on failure * cleaning up verilator version issue * devcontainer * Fix missing libpython in GitHub Actions CI environment (#21) * Initial plan * Install libpython in GitHub Actions for cocotb tests Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: arnavsacheti <36746504+arnavsacheti@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Tests
The bus decoder exporter includes comprehensive test suites to validate both the Python implementation and the generated SystemVerilog RTL.
Unit Tests
The unit test suite is built around pytest and exercises the Python implementation
directly using the systemrdl-compiler
package to elaborate inline SystemRDL snippets.
Install dependencies
Create an isolated environment if desired and install the minimal requirements:
# Using uv (recommended)
uv sync --group test
# Or using pip
python -m pip install -e . parameterized pytest pytest-cov pytest-xdist
Running the suite
Invoke pytest from the repository root (or the tests directory) and point it
at the unit tests:
pytest tests/unit
Pytest will automatically discover tests that follow the test_*.py naming
pattern and can make use of the compile_rdl fixture defined in
tests/unit/conftest.py to compile inline SystemRDL sources.
Cocotb Integration Tests
The cocotb test suite validates the functionality of generated SystemVerilog RTL through simulation. These tests generate bus decoders for different CPU interfaces (APB3, APB4, AXI4-Lite) and verify that read/write operations work correctly.
Install dependencies
# Install with cocotb support using uv (recommended)
uv sync --group test
# Or using pip
python -m pip install -e . parameterized pytest pytest-cov pytest-xdist cocotb cocotb-bus
# Install HDL simulator (choose one)
apt-get install iverilog # Icarus Verilog
apt-get install verilator # Verilator
Running the tests
Integration tests (no simulator required)
These tests validate code generation without requiring an HDL simulator:
pytest tests/cocotb/testbenches/test_integration.py -v
Example code generation
Run examples to see generated code for different configurations:
python tests/cocotb/examples.py
Simulation layout
Simulation-oriented tests are grouped by CPU interface under
tests/cocotb/<cpuif>/<group>/. For example, the APB4 smoke test lives in
tests/cocotb/apb4/smoke/ alongside its pytest runner module. Each runner
compiles the appropriate SystemRDL design, adds the interface wrapper from
hdl-src/, and invokes cocotb via Verilator.
Full simulation tests (requires simulator)
To execute the smoke tests for every supported interface:
pytest tests/cocotb/*/smoke/test_runner.py -v
To target a single interface, point pytest at that runner module:
pytest tests/cocotb/apb3/smoke/test_runner.py -v
pytest tests/cocotb/apb4/smoke/test_runner.py -v
pytest tests/cocotb/axi4lite/smoke/test_runner.py -v
For more information about cocotb tests, see tests/cocotb/README.md.