VUnit is an open source unit testing framework for VHDL.
What is VUnit?
VUnit is an open source unit testing framework for VHDL/SystemVerilog released under the terms of Mozilla Public License, v. 2.0. It features the functionality needed to realize continuous and automated testing of your HDL code. VUnit doesn’t replace but rather complements traditional testing methodologies by supporting a “test early and often” approach through automation.
NOTE: SystemVerilog support is experimental.
The VUnit project mission is to apply best SW testing practises to the world of HDLs by providing the tools missing to adapt to such practises. The major missing piece is the unit testing framework, hence the name V(HDL)Unit. However, VUnit also provides supporting functionality not normally considered as a part of an unit testing framework.
- Builds on the commonly used xUnit architecture.
- Python test runner that enables powerful test administration, can handle fatal run-time errors (e.g. division by zero), and ensures test case independence.
- Scanners for identifying files, tests, file dependencies, and file changes enable for automatic (re)compilation and execution of test suites.
- Can run test cases in parallel to take advantage of multi-core machines.
- Scripting as well as command line support.
- Support for running same test suite with different generics.
- VHDL test runner which enables test execution for not fully supported simulators.
- Assertion checker library that extends VHDL built-in support (assert).
- Logging framework supporting display and file output, different log levels, filtering on level and design hierarchy, output formatting and multiple loggers. Spreadsheet tool integration.
- Location preprocessor that traces log and check calls back to file and line number.
- JUnit report files for better Jenkins integration.
VUnit depends on a number of components as listed below. Full VUnit functionality requires Python and a simulator supported by the VUnit Python test runner. However, VUnit can run with limited functionality entirely within VHDL which means that unsupported simulators can be used as well. Prototype work has been done to fully support other simulators but this work is yet to be completed and released.
- Mac OS X
- Python 2.7
- Python 3.3 or higher
- Aldec Riviera-PRO
- Tested with Riviera-PRO-2015.06 (x64/x86).
- Only VHDL 2008
- Aldec Active-HDL
- Tested with Active-HDL-10.2 (x64/x86)
- Only VHDL 2008
- Mentor Graphics ModelSim/Questa
- Tested with 10.1 - 10.3
- Only VHDL 2008
- Works with versions >= 0.33
- Tested with LLVM and mcode backends, gcc backend might work aswell.
- Integrated support for using GTKWave to view waveforms.
There are a number of ways to get started.
- The VUnit User Guide will guide users on how to use start using the basic features of VUnit but also provides information about more specific and advanced usage.
- The Check User Guide presents the check package.
- The Log User Guide presents the log package.
- Have a look at the examples under examples. The examples in logging and check are tutorials that should be single-stepped in your simulator.
- There are also various presentations of VUnit on YouTube. For example an introduction to unit testing (6 min) and a short introduction to VUnit (12 min).
Contributing in the form of code, feedback, ideas or bug reports are welcome. Before contributing code read our Development document.
Any bug reports, feature requests or questions about the usage of VUnit can be made by creating a new issue. The issue should be labeled accordingly using the built-in labels; bug, enhancement or question.
- Lars Asplund
- Olof Kraigher
VUnit except for OSVVM (see below) is released under the terms of Mozilla Public License, v. 2.0.
© 2014-2016 Lars Asplund, email@example.com.
OSVVM 2015.03 is redistributed with VUnit for your convenience. Minor modifications have been made to enable GHDL support. Derivative work is also located under examples/vhdl/osvvm_integration/src. These files are licensed under the terms of ARTISTIC License.
© 2010 - 2015 by SynthWorks Design Inc. All rights reserved.