DEMAConsulting.VHDLTest 0.1.0-beta.3

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of DEMAConsulting.VHDLTest.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet tool install --global DEMAConsulting.VHDLTest --version 0.1.0-beta.3
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local DEMAConsulting.VHDLTest --version 0.1.0-beta.3
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=DEMAConsulting.VHDLTest&version=0.1.0-beta.3&prerelease
nuke :add-package DEMAConsulting.VHDLTest --version 0.1.0-beta.3

VHDLTest

This tool runs VHDL test benches and generates standard test results files.

Options

Usage: VHDLTest [options] [tests]

Options:
  -h|-?|--help                 Display help
  -v|--version                 Display version
  -c|--config <config.yaml>    Specify configuration
    |--verbose                 Verbose output
  -r|--results <out.trx>       Specify test results file
  -s|--simulator <name>        Specify simulator
  -0|--exit-0                  Exit with code 0 if test fail
  --                           End of options

Supported Simulators

The current list of supported simulators are:

Installing

VHDLTest is distributed as a dotnet tool through NuGet.org and can be installed globally:

dotnet tool install -g DEMAConsulting.VHDLTest

VHDLTest --help

Additionally it can be installed as a local tool in the working folder:

dotnet tool install DEMAConsulting.VHDLTest

dotnet VHDLTest --help

Configuration

VHDLTest needs a YAML configuration file specifying the VHDL files and test benches.

# List of VHDL source files
files:
 - full_adder.vhd
 - full_adder_pass_tb.vhd
 - full_adder_fail_tb.vhd
 - half_adder.vhd
 - half_adder_pass_tb.vhd
 - half_adder_fail_tb.vhd

# List of test benches to execute
tests:
 - full_adder_pass_tb
 - full_adder_fail_tb
 - half_adder_pass_tb
 - half_adder_fail_tb

Running Tests

Before running the tests, it may be necessary to configure where the simulators are installed. This can be done through environment variables:

  • VHDLTEST_GHDL_PATH = path to GHDL folder
  • VHDLTEST_MODELSIM_PATH = path to ModelSim folder
  • VHDLTEST_VIVADO_PATH = path to Vivado folder
  • VHDLTEST_ACTIVEHDL_PATH = path to ActiveHDL folder

To run the tests, execute VHDLTest with the name of the configuration file.

dotnet VHDLTest --config test_suite.yaml

A test results file can be generated when working in CI environments.

dotnet VHDLTest --config test_suite.yaml --results test_results.trx
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
0.1.0-beta.4 52 5/20/2024
0.1.0-beta.3 190 11/17/2023
0.1.0-beta.2 53 11/17/2023
0.1.0-beta.1 52 11/16/2023