Getting started

ScenarioSync is a synchronization tool that can be invoked from the command line. This guide shows you step-by-step how the synchronization tool can be configured.

Preparation

1. Install dotnet 6 or higher.
2. For setting up ScenarioSync for Azure DevOps, you need a LightBDD test framework project and an Azure DevOps project with Test Plan.
3. For a synchronization target we use an Azure DevOps project: https://dev.azure.com/organization-name/project-name. (An Azure DevOps project for testing ScenarioSync can be created for free from the Azure DevOps website, use a Basic plan User License.

Installation and first test cases import

In our guide, we will use a LightBDD.XUnit2 example that uses LightBDD framework with XUnit. The sample project can be found there GitHub.

1. Open the terminal and clone Demo project from the GitHub repository

git clone https://github.com/khdevnet/LightBDD.ScenarioSync.Demo.git

2. Open the project directory "LightBDD.ScenarioSync.Demo" in the terminal and run tests

dotnet test

3. In the project directory "LightBDD.ScenarioSync.Demo" install the ScenarioSync dotnet tool.

dotnet new tool-manifest

dotnet tool install --local LightBDD.ScenarioSync.Cli

4. Create scenariossync tool config file, or create it manually

dotnet scenariosync init

5. Update the configurations file with your settings. More details.

{
  "projectUrl": "https://dev.azure.com/organization-name/project-name",
  "patToken": "personal token with permissions TestManagement write\u0026read, WorkItems write\u0026read",
  "testPlanId": 1,
  "reportPath": "./Reports/FeaturesReport.xml",
  "rootTestSuite": "LightBddSync"
}

6. Synchronize scenarios with Azure DevOps Test Plan

dotnet scenariosync push