DemaConsulting.VHDLTest 1.4.0

VHDLTest Tool

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

Installation

The following will add VHDLTest to a Dotnet tool manifest file:

dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local DEMAConsulting.VHDLTest

The tool can then be executed by:

dotnet vhdltest <arguments>

Options

Usage: VHDLTest [options] [tests]

Options:
  -h, --help                   Display help
  -v, --version                Display version
  --silent                     Silence console output
  --verbose                    Verbose output
  --validate                   Perform self-validation
  -c, --config <config.yaml>   Specify configuration
  -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:

• GHDL
• ModelSim
• Vivado
• ActiveHDL
• NVC

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
• VHDLTEST_NVC_PATH = path to NVC 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

Self Validation

Running self-validation produces a report containing the following information:

# DEMAConsulting.VHDLTest

| Information         | Value                                              |
| :------------------ | :------------------------------------------------- |
| VHDLTest Version    | <version>                                          |
| Machine Name        | <machine-name>                                     |
| OS Version          | <os-version>                                       |
| DotNet Runtime      | <dotnet-runtime-version>                           |
| Time Stamp          | <timestamp>                                        |

Tests:

- TestPasses: Passed
- TestFails: Passed

Validation Passed

On validation failure the tool will exit with a non-zero exit code.

This report may be useful in regulated industries requiring evidence of tool validation.