Setup and Configure
Last updated
Was this helpful?
Last updated
Was this helpful?
Once you have installed SpecSync for Azure DevOps tool, you need to configure it. This means you have to create a SpecSync configuration file (specsync.json) that contains the Azure DevOps project connection details and other synchronization settings.
SpecSync has to be configured for every feature file set. Feature file set is a folder that contains feature files that you want to synchronize as one batch.
Each feature file set will have its own SpecSync configuration file (specsync.json). For projects with multiple feature file sets, you can use as well.
It is up to you how you define your feature file sets. The following table contains a few usual setup variations.
.NET solution with a single SpecFlow project
The SpecFlow project folder (e.g. MyProject.Specs)
.NET solution with multiple SpecFlow projects
Each SpecFlow project folder (e.g. MyProject.BackOffice.Specs and MyProject.ClientApp.Specs)
node.js app with Cucumber.js
The parent folder of the features folder (e.g. /src/test/)
node.js app with multiple feature file sets
The parent folders of the features folders (e.g. /src/test/backoffice/ and /src/test/clientapp/)
Java app with Cucumber Java
The parent folder of the features folder (e.g. /src/test/resources/)
You can also consider setting the features folder itself as a root of the feature file set (e.g. /src/test/resources/features/ instead of /src/test/resources/).
The easiest way to initialize the configuration file and configure the most important settings is to use the SpecSync init command. To use the command open a command window or bash shell and change the current directory to the root folder of the feature file set and invoke the following command.
It is recommended to let the init command test the authentication to the Azure DevOps project to make sure the connection is configured properly.
When the SpecSync configuration file is complete, you can perform the first synchronization task and verify the results using the push command.
For larger feature file sets it is recommended to make the first synchronization only for a few selected scenarios tagged with a particular tag. You can even temporarily tag a few scenarios in order to test the synchronization. In our example we assume that the selected scenarios are tagged with @specsync_test.
The synchronization should run successfully and SpecSync should create Test Cases in Azure DevOps for the selected scenarios and link to them using a tag.
SpecSync can synchronize scenarios to Azure DevOps Test Cases and publish test execution results without any additional NuGet package.
v2.3
v2.4
v3.0
v3.1
v3.3
v3.4.*
2.*
3.4.*
The init command will ask a few questions in order the setup the connection to the Azure DevOps project, like the project URL and the authentication details. If you are unsure about what is exactly your Azure DevOps project URL, please check the page. You can fine more information about the authentication options in the page.
The init command configures the settings that are enough for the first synchronization. SpecSync comes with useful default values for all settings, but you can still review the and extend the if you need to. It is recommended to think about whether you would like to or consider .
To use the command open a command window or bash shell and change the current directory to the root folder of the feature file set and invoke the following command. For all command line option of the push command, please check the .
In case of errors, you can retry the synchronization with an additional --verbose option that displays additional diagnostic information. If this does not help, please check the page or contact .
There is a special way to publish test results that require you to install a SpecFlow plugin as a NuGet package. This special way, the "Test Suite based execution with Scenario Outline wrappers" automation strategy is described in detail in the that describes the conditions when this strategy has to be used.
The exact NuGet package to be installed depends on the SpecFlow version of your project. For example for SpecFlow v2.4.*, install . The following table contains the supported SpecFlow versions and the related plugin packages.
For Reqnroll we provide a single package: that can be used with Reqnroll 2.1 or later. You might need to use a different version of the plugin depending on the SpecSync and Reqnroll version you use.