Pushing scenario changes to Test Cases
SpecSync can synchronize scenarios and scenario execution results with Jira Test Cases. The most commonly used command to achieve this is to upload (push) the scenario changes to Test Cases that is provided using the SpecSync push command.
The SpecSync push command processed all scenarios in the local feature set (e.g. the features folder of your project), detects if there were any change since the last synchronization and updates the Test Case if necessary.
You can find all available command line options for the push command in the push command line reference. The configuration options related to push are in the synchronization section of the configuration file.
The connection between the scenario and the Test Case in Jira is established with a test case link tag. By default the link tag uses the format @tc:P01-T1234, but both the tc prefix and the separator : can be configured (with synchronization/tagPrefixSeparators and synchronization/linkLabelSeparator), so you can also have test case links that use different format, e.g. @TestCase=P01-T1234. In the documentation we use the default test case link tag format.
Depending on the changes of the scenario, the push command performs different actions in Jira as the following table shows.
| Changes | Actions |
|---|---|
The scenario is new (not yet linked to a Test Case) | A new Test Case work item is created and the scenario is tagged with a link tag (e.g. |
The scenario is linked and up-to-date with the Test Case | No action is taken |
The scenario has been changed since the last synchronization | The Test Case is updated with the changes. (No change in the feature file.) |
The scenario has been synchronized, but since the last synchronization the Test Case has been updated. | The push command by default overwrites the changes of the Test Case fields that are maintained by SpecSync (e.g. title, steps, tags). The changes in other fields (e.g. description) are not changed. A different conflict handling method can also be configured. See Synchronization conflict resolution for details. In case you would like to preserve the changes of the fields maintained by SpecSync, you have to use the pull command first. |
The scenario has been removed | SpecSync does not delete the related Test Case. |
The SpecSync push command needs to modify the feature file when a new scenario is synchronized. The feature file change has to be preserved in the source control (commit & push), otherwise when other users perform a push, Test Case duplicates will be created.
When performing the push on a build pipeline, or in any other cases where local changes cannot be preserved, the push command has to be invoked with the --disableLocalChanges switch. More information about using SpecSync in build pipelines can be found in the Use SpecSync from build or release pipeline guide.
You can perform the push operation with the --linkOnly flag so that it only links new scenarios and does not update existing Test Cases.
SpecSync operations, including the push command supports "dry-run" mode using the --dryRun command line option. In dry-run mode, no change is made neither to Jira nor to the feature files, so you can test the impact of an operation without making an actual change.
Test Case fields updated by the push command
This documentation page is in progress. Please check back later.
Last updated