Quick Start

Install

Install the VCD-Generator as a dotnet tool

dotnet tool install --global vcdg

Annotate NUnit tests

Annotate your NUnit tests with the Test attribute including a Property key-value pair,

• Key: REQUIREMENT-ID
• Value: the unique identifier of your requirement listed in the input requirements spreadsheet

[TestFixture]
public class ACoolTestFixture()
{
  [Test(Description = "a very fancy test"), Property("REQUIREMENT-ID", "REQ-01")]
  public void Some_fance_test()
  {
    // ... test test test
  }
}

Note Make use of the Property attribute which provides a key-value pair. For the VCD-Generator to work provide at least the following Property("REQUIREMENT-ID", "your-requirement-id")

Run Tests

Run the unit tests using the following command:

dotnet test VCD-Generator.sln --logger:"nunit;LogFilePath=TestResults/{assembly}.Result.xml" -- NUnit.ShowInternalProperties=true

Generate Report

Run the vcdg tool and generate the report

vcdg -rf VCD-Generator.Tests/Data/Requirements.xlsx --requirements-sheet-name requirements --requirements-id-column Identifier --requirements-text-column "Requirement Text" --source-directory . --output-report vcd-report.xlsx

Inspect

Open the vcd-report.xlsx file and put a smile on your face