Skip to content

ScenarioSync CLI

Anton Shcherbyna edited this page Aug 15, 2023 · 8 revisions

Usage

scenariosync <command>

Commands

Command Notes
init This command will create an empty ScenarioSync configuration file ./scenariosync.json.user
push Create or update exist features from LightBDD FeaturesReport.xml to Azure DevOps Root Test Suite
clean Delete all Test Suites and Test Cases from Root Azure DevOps Test Suite

Config file "scenariosync.json.user"

Config file

{
  "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"
}
Field Notes
projectUrl [required]
Url to Azure DevOps project in a format "https://dev.azure.com/organization-name/project-name"
patToken [required]
Azure DevOps user account "Personal access token"
testPlanId [required]
Azure DevOps Test Plan Id, defined in URL "https://dev.azure.com/organization-name/project-name/_testPlans/define?planId=1" as "planId" query param
reportPath [required]
Path to "FeaturesReport.xml" LightBDD xml report
rootTestSuite [optional]
Root Test Suite name where Light BDD scenarios will be created. Default value: "LightBddSync"

Examples

Create empty scenariosync config file

dotnet scenariosync init

Create/update scenarios to Azure Devops 'LightBddSync' Root Test Suite

dotnet scenariosync push

Remove all scenarios the 'LightBddSync' Root TestSuite from Azure Devops

dotnet scenariosync clean