Changelog

The How to upgrade to a newer version of SpecSync guide contains information about how to upgrade to a newer version.

For planned features in future releases please check the Release Model and Roadmap page.

Due to an Azure DevOps issue, SpecSync might fail with JsonSerializationException when publishing test results using multi-suite publish. Please update to v3.4.18 or later. That version uses a different method so it is not affected by the issue. See more at the Troubleshooting guide. The fix has been also ported back to v3.3 as v3.3.17. (#1357)

v5.0.0 - COMING SOON! PREVIEW AVAILABLE!

The preview of the new v5 release is available! Please note that according to our versioning policy, we do not recommend using preview releases for production.

The usage of SpecSync plugins in the latest v5 preview release is temporarily disabled. Please check back at for an updated preview to try v5 with plugins.

All fixes of SpecSync v3.4.25 are included in this release.

For detailed instructions on how to upgrade please check the Migrating from SpecSync v3 to v5 guide.

New features

• SpecSync switches to semantic versioning. (#1233)

  • From this version, the major version number (currently 5) represents compatibility range and breaking changes.

  • The minor version number (currently 0) always denotes non-breaking changes and feature additions.

  • The patch number will only be used for release hot-fixes.

  • The SpecSync plugins will be versioned according to the main version: a plugin version 5.4.1 is compatible with any SpecSync v5.* versions.

  • Both SpecSync for Azure DevOps and SpecSync for Jira will use the same versioning scheme and the plugins are cross-compatible between these products.

  • We recommend to always upgrade to the latest minor and patch version within the same major version.

• Configuration upgrade wizard: The specsync upgrade command analyzes your configuration file, applies the necessary changes for deprecated settings and offers configuring new features. The upgrade command should be used primarily for major version upgrades, but can be re-invoked any time to configure optional features. See Configuration wizards for details. (#1279)

• Synchronizing Test Cases to different Test Suite hierarchies with the "hierarchy synchronization" feature. There are built-in hierarchy configuration options (folders, FoldersAndFiles, FoldersAndDocumentNames, tag, levels, single) for the most common hierarchy types but you can also choose custom for defining a custom hierarchy structure (similarly to the deprecated addTestCasesToSuites customization). With enterprise license, you can configure multiple hierarchies and use more than 20 nodes (Test Suites) within a hierarchy. The hierarchies can be configured using the hierarchies top-level configuration setting. See Synchronizing Test Case hierarchies using Test Suites for details. (#322)

• Improved integration to Azure DevOps pipelines:

  • When a SpecSync command fails, it automatically fails the pipeline task without using non-zero exit codes. This produces cleaner error messages. The non-zero exit codes can be forced with --forceExitCode command line option. (#1110)

  • SpecSync v5 does not fail the Azure DevOps pipelines automatically for warnings, but registers the warning to the pipeline result instead. If you want to fail the pipelines for warnings, use the --treatWarningsAsErrors option. (#1110)

  • The log file produced by the --log command line option is automatically included to the pipeline build logs. (#1216)

  • The pipeline output log uses colors

• There are new options to maintain "remote scope". Remote scope is a piece of information in Azure DevOps that is used to detect if a local test case has been removed. Configuring a remote scope is optional, but if it is not specified SpecSync will not be able to detect removed local test cases and could not mark the related Test Cases and remove them from the suite hierarchies. The remote scope is now configured using the remote/scope configuration setting. So far the only way to configure remote scope was to set a Test Suite in the remote/testSuite configuration section. See Remote scope for details. There are more options now to use remote scope: (#1282)

  • Configure a testSuite remote scope that stores the information in a single Test Suite that is managed by SpecSync and you cannot include additional Test Cases to it. The Suite cannot be reused for other SpecSync configurations. This is the option that was available earlier.

  • Configure a managedQuery remote scope that stores the information in a shared query within the .SpecSync.Internal folder. (recommended) (#1278)

  • Configure a tag remote scope that uses a tag specsync:<configuration-key> to know if a Test Case was managed by SpecSync. (#588)

• The SpecSync configurations can be identified with a "configuration key". The configuration key can be specified in the configurationKey setting of the configuration file. The configuration key is included in the Test Case change comments, so SpecSync is able to detect and provide a warning by default when a Test Case is synchronized from multiple SpecSync configurations. This behavior can be changed by the synchronization/push/configurationConflictResolution setting. The configuration key is also used for marking Test Cases of deleted local test cases (scenarios) and also by tag remote scope. Specifying a configuration key is optional, but recommended. See Configuration key for details. (#1387)

• The command line options supports completion using the "dotnet-suggest" tool. Detailed setup guide will be provided soon. (#1487)

• Allow suppressing warnings with either the toolSettings/suppressWarnings configuration setting. You an specify warning codes in an array, e.g. "suppressWarnings": ["W5113", "W5126"] (#1158)

• Support for license keys as an alternative of license files. The license key can be specified in the toolSettings/license configuration setting or with the --license command line option. The configuration setting supports loading the value from environment variable with {env:ENV_VAR}. You can use the specsync upgrade command to convert your license file to license key, but you can also ask support to get your license key. License files are still supported. (#1266)

• Allow treating warnings as errors for greater security by setting the toolSettings/treatWarningsAsErrors setting to true or using the --treatWarningsAsErrors command line option. (#1477)

• The publishTestResults/publishAttachmentsForPassingTests configuration setting controls which attachments should be published for passing tests. In the prior releases both the files attached to the test results (e.g. screenshots) and the test output were attached to the result. Publishing the test output attachments causes performance issues therefore, you can control now which attachments of the passing tests should be published. The possible options are none - no attachments are published for passing tests, files - only file attachments are published (default), all - both file attachments and test output are attached. In prior releases all attachments were published, so the default behavior is a breaking change. Note: this setting and the changes of defaults does not affect publishing failing tests. (#1485)

Improvements

• Allow glob pattern syntax for test result file names (--testResult, -r option) (#1071)

• Improve logging to better explain why test results are filtered out for publish-test-results command (#1588)

• Improve usability of file pattern conditions by hinting potential causes for not processing any local test cases (#1262)

• Automatically enable verbose mode if --diag is used, except for timing diag category (#1524)

• Console options that supported multiple values and so far allowed semicolon-separated list now allow using the options multiple times. The semicolon-separated value list is still supported. Affected options: --testResult, -r, --diag, --attachedFile, --hierarchy (#1487)

• Improved error handling if Git URL is used for project URL. (#1484)

• Add error codes for all errors (#1476)

• Allow using {test-case-id} placeholder in field updates and test result settings. (#1358)

• The --testRunSetting and --testResultSetting command line options are now available for publish-test-result command. (#974)

• Added skipWithWarning and overwriteWithWarning conflict resolution methods, skip will not report a warning (#1395, #1391)

• Improve display of warning summary (#1393)

• Detect when local and remote test case have been updated in the same way and reset hash (#1389)

• Include configuring Test Case hierarchy synchronization and remote scope in the configuration wizards (init, upgrade). (#1388, #1386)

• Improved coloring of console output (#1385)

• Improved performance of Test Suite operations (#1320)

• Text values can be converted to fields that accept Markdown (e.g. test result comment) using the TextToMarkdown value loader. (#1475)

• Various stability and maintainability improvements (#1548, #1587, #1588, #1535, #1534, #1533, #1532, #1525, #1511, #1512, #1480, #1467, #1468, #816, #1205, #1394, #1384, #1280)

Deprecation notices

The following settings are still usable with the new version but provide a warning. The deprecated settings will be removed in the next major release.

Most of the deprecated settings are automatically fixed by invoking the new specsync upgrade command.

• The configuration setting customizations/customFieldUpdates has been replaced by synchronization/fieldUpdates. See Update Test Case fields feature description for details. (#1589)

• The configuration setting ``addTestCasesToSuites customization has been replaced by hierarchies. (#1322)

• The configuration setting local/tags has been renamed to local/condition (#1529)

• The configuration settings publishTestResult/testResult/filePath and publishTestResult/testResult/files have been replaced by publishTestResults/testResults/sources (#1462)

• The configuration setting publishTestResult/testResult/fileFormat has been replaced by publishTestResults/testResults/resultFormat (#1462)

• The ignore and forceOverride conflict resolution method has been replaced with with overwrite (#1392, #1390)

• The command line option --diagCategories has been replaced by --diag (#1523)

• The command line option --tagFilter has been replaced by --filter (#1491)

• The command line option --attachedFiles has been replaced by --attachedFile (#1495)

• The command line option --testResultFile has been replaced by --testResult (#1461)

• The command line option --testResultFileFormat has been replaced by --testResultFormat (#1461)

• The command line option --testPlanId has been replaced by --testPlan. With the --testPlan option you can specify ID values using the #1234 format. (#1459)

• The command line options --buildId, --buildNumber, --buildFlavor, --buildPlatform has been replaced by the --testRunSetting option. The settings can be used in --testRunSetting buildId=123 format. (#1460)

• When SpecSync is used with .NET 6 or .NET 7, a warning is displayed. The official support of these frameworks have been ended by Microsoft so it is not recommended to use SpecSync with these. Please note that the .NET framework used for SpecSync does not have to be the same as the .NET framework of the synchronized project. (#1471)

Breaking changes

• Some older Azure DevOps sever versions are not supported anymore. The official support of these Azure DevOps versions have been ended by Microsoft. Please use SpecSync v3.4 to connect to these older server versions.

  • Team Foundation Server 2017 (support ended: January, 2022) (#939)

  • Team Foundation Server 2018 (support ended: January, 2023) (#1283)

  • Azure DevOps Server 2019 (support ended: April, 2024) (#1456)

• The SpecSync command line execution support for .NET 3.1 and .NET 5 has been removed. The official support of these frameworks have been ended by Microsoft so it is not recommended to use SpecSync with these. To continue using these frameworks, please use SpecSync 3.4. Please note that the .NET framework used for SpecSync does not have to be the same as the .NET framework of the synchronized project. (#872)

• SpecSync v5 does not fail the Azure DevOps pipelines automatically for warnings, but registers the warning to the pipeline result instead. If you want to fail the pipelines for warnings, use the --treatWarningsAsErrors option.

• The default behavior for publishing attachments for the passing tests has been changed (see #1485). In the prior releases both the files attached to the test results (e.g. screenshots) and the test output were attached to the result. According to the new default, only file attachments are published for passing tests. The behavior can be controlled by the publishTestResults/publishAttachmentsForPassingTests setting. The setting all represents the previous default. Note: this setting and the changes of defaults does not affect publishing failing tests. (#1485)

• The exit code of the command line tool for errors is not always 10 anymore, but in range between 10 and 19. (#1478)

• In previous releases when a Test Suite name was used without specifying a Test Plan, SpecSync used the Test Suite from the first Test Plan it found. This has been changed to search through all Test Plans and report an error if the Test Suite name is not unique. To avoid name collisions, it is recommended to specify the Test Plan and refer to the Test Suite by path. (#1474)

• The synchronization behavior of "automated test" settings of Test Cases has changed. So far when the synchronization/automation/enabled setting was not set to true, SpecSync always cleaned these fields, except when toolSettings/doNotSynchronizeAutomationUnlessEnabled was set to true. Now this is the default behavior. If you need to clean the automation fields, use the synchronization/automation/condition setting or synchronization/fieldUpdates. (#1464)

• The scenario outlines that contain quoted parameter placeholders ("<param>" or '<param>') are synchronized differently because in the prior releases an additional space has been inserted in the Azure DevOps Test Case step before the closing quote ("@param "). The additional space is not inserted anymore because of the fix #1146. The change will be applied when the Test Case is changing otherwise or when the synchronization is invoked with the --force option.

• The escaping behavior in conditions have changed: the escape character (\) escapes only a specified set of characters (\, (, ), ;, ', ", ) instead of all characters. This helps for specifying Windows paths in conditions. (#1473)

• The v1 hash calculation that has been used by SpecSync v3.3 has been deprecated. When a Test Case has not been updated since v3.3 upgrading to this release will cause a one-time change in the Test Case to reset the hash to the current hash calculation version. (#899)

• The console options that have been deprecated in earlier releases are removed now: --baseFolder, --buildServerMode. (#1490, #1492)

• The configuration settings that have been deprecated earlier are removed now: publishTestResults/ignoreNotExecutedTests, local/featureFileSource/*, synchronization/link[]/targetWorkItemType, toolSettings/testCaseWorkItemName, toolSettings/testSuiteWorkItemName, customizations/synchronizeLinkedArtifactTitles/linkLabelSeparator, publishTestResults/createSubResults, publishTestResults/runName, publishTestResults/runComment, publishTestResults/runType, publishTestResults/testResultComment (#1457)

• The legacy Test Plan / Test Suite based test execution for old SpecFlow versions (v3.8 or earlier) and for SpecFlow v4 beta is not supported anymore. SpecFlow v3.9 is still supported. Note: this change does not impact normal feature file synchronization, that still works with all SpecFlow versions. To use the legacy execution mode for the older SpecFlow versions, please use SpecSync v3.4. (#1455)

Plugin API improvements

The API improvements will be listed soon.

Bug Fixes

• Fix: Source file filter conditions might not work with mixed path separators (#1528)

• Fix: Whitespace is added after a parameter in Azure DevOps if the parameter is quoted or followed by a non-parameter character (#1146)

• Fix: Misleading error message when invalid ADO reference type is configured (#1482)

v3.4.25 - 2025/02/26

Improvements

• Support for Cucumber messages .ndjson result files. Use -f cucumberMessagesNdjson to load result from this files. (#351, #1509)

• Allow publishing test results even if no matching results found. To enable this feature set publishTestResults/publishEmptyResults to true in the configuration. (#1345)

v3.4.24 - 2025/02/12

Bug fixes

• Fix: Requirement synchronization customization: {requirement-acceptance-criteria} placeholder includes separator text (#1488)

• Fix: Compatibility errors of SpecSync.AzureDevOps.TestSuiteBasedExecution.Reqnroll plugin (#1496, #1500, #1501)

Improvements

• Requirement synchronization customization: Apply automatic description de-indentation for recognizing acceptance criteria (#1497)

v3.4.23 - 2025/01/21

Bug fixes

• Fix: Unhandled exception when PAT scope is incorrect (#1479)

• Fix: Unhandled error when scenario outline examples does not have a table (#1483)

• Fix: Unhandled error when invalid Test Plan ID specified (#1481)

Improvements

• Reqnroll plugin to enable using "scenario-outline-wrappers" for legacy Test Suite based execution. Use the Reqnroll plugin SpecSync.AzureDevOps.TestSuiteBasedExecution.Reqnroll to use the feature. (#1486)

v3.4.22 - 2025/01/13

Bug fixes

• Fix: Error E0020 The 'GetTestCasesInScope' method on remote scope can only be used when it is not dirty. when --dryRun is used (#1472)

• Fix: The "removed" Test Cases are not included in the sync summary line (#1330)

• Fix: Plugin versions are displayed with commit info (#1333)

• Fix: Source file filtering does not work on Windows when * or . is used after backslash (e.g. $sourceFile ~ Features\*.feature) (#1371)

• Fix: Misleading error message when publish test results command is invoked with a non-existing Test Suite (#1329)

• Fix: Synchronizing to a non existing Test Suite using "path" setting fails with internal error (#1327)

v3.4.21 - 2025/01/09

Note: The release v3.4.21 contains a fix with a negative side-effect when --dryRun is used. Please upgrade to v3.4.22 or later.

Bug fixes

• Fix: Unhandled error during suite update with AddTestCasesToSuites customization (#1470)

v3.4.20 - 2025/01/07

Bug fixes

• Fix: Scenario outline test results are not published with Reqnroll 2.1 and MsTest (#1466)

v3.4.19 - 2024/11/21

Improvements

• Support for .NET 9: The .NET tool installation now works on systems that only have .NET 9.0 SDK. (#1239)

• Support for establishing non-tracked links via synchronization/links[]/disableTracking setting. With that you can disable automatic removal of links when the corresponding tag has been deleted. (#1370)

• Force processing removals of local test cases on filter with toolSettings/forceProcessingRemovalsOnFilter. (#1373)

• Update dependencies to address know vulnerabilities (#1375)

• Various stability and maintainability improvements (#1369)

v3.4.18 - 2024/10/25

Improvements

• Allow "LinkOnChange" for "requirementSynchronization" customization (#1364)

• Synchronize requirements from Rules and allow parsing acceptance criteria from description for "requirementSynchronization" customization (#1363)

• Support for processing JUnit XML TestCase Properties (#1355)

• Include app version in log file (#1314)

• Improve error messages for filter condition errors (E1051) when used for file path filtering (#1290)

• Improve handling invalid credentials from user config (#1285)

• Various stability and maintainability improvements (#1359, #1318, #1319)

New Plugins

See all plugins available on nuget.org in the plugin list

• SpecSync.Plugin.OnlyPublishTestResults: This plugin can be used in cases when you would like to publish test results with SpecSync for Test Cases that were not synchronized by SpecSync, but created manually or with other tools. See plugin GitHub repository (#1360)

Plugin Improvements

• SpecSync.Plugin.GenericTestResultMatcher v1.2.0:

  • Match for test result properties and allow using {test-case-id} placeholder (#1356)

• SpecSync.Plugin.ExcelTestSource v1.1.0:

  • allow defining first step in test case row, improve flexibility, allow id prefix (#1342)

  • make column names parametrizable (#1341)

• SpecSync.Plugin.ExcelTestResults v1.3.0 (since v1.0.0):

  • If ID matches, should not try matching other fields (#1362)

  • Support for custom outcome values (#1348)

  • Support for non-Gherkin test source (#1347)

  • Treat empty outcome as "NotExecuted" (#1346)

  • Support ID prefix (#1338)

  • Fix: ID values formatted as number are not supported (#1337)

  • Skip rows without identifier (#1336)

  • Test result format error & parameter errors are reported incorrectly (#1335)

  • Fix: Error loading ExcelTestResults plugin (#1332)

Bug fixes

• Fix: Unhandled JsonSerializationException error when publishing test results using multi-suite publish (#1357)

• Fix: Unhandled exception (NullReferenceException) during synchronization of scenarios (#1366)

• Fix: The "Processing [file]" heading is displayed twice in log (#1361)

v3.4.17 - 2024/05/23

Improvements

• GenericTestResultMatcher Plugin v1.1.0: Allow matching standard console output (StdOut) by general matcher plugin (#1286)

Bug fixes

• Fix: Synchronization might fail with E1107 when a Test Case has not been updated since v3.3 (uses v1 hash) (#1317)

v3.4.16 - 2024/05/13

Improvements

• The files and folders are processed in a usual file processing order (folders first, underscore has priority) (#1275)

• MarkdownToHtml value loader that can be used to update custom fields from Markdown source (e.g. feature description). Usage: {feature-description:MarkdownToHtml} or {{!MarkdownToHtml}}A *Markdown* feature description: {feature-description}. The relevant Markdown extras from Markdig can be also used. (#1277)

• Update Azure.Identity dependency to address know vulnerability (#1295)

• Support for Scenario Outline parameter values in Behave test results (#1293)

• Support for linking Hyperlinks. To use it, you need to specify a link tag prefix with relationship as Hyperlink. You can include the full URL in the tag (e.g. @url:https://www.specsolutions.eu/specsync/) or you can specify a link template in the configuration (e.g. "linkTemplate": "https://docs.specsolutions.eu/specsync/{id}") and use the tag only for the relevant part of the link (e.g. @doc:features/plugin-list). (See details in linking feature page.) (#810)

• Beta: Support for synchronizing requirements from feature files. More details in later releases (#1267)

v3.4.15 - 2024/03/05

Improvements

• Support for Reqnroll, a fork & reboot of the SpecFlow project (#1272)

• Support for Azure Service Principal authentication (#1268)

• Allow specifying authentication method explicitly in configuration (#1265)

• Display a note in the verbose log if an environment variable was resolved to empty because it did not exist (#1270)

• Allow using {env:ENV_VAR} placeholders in authentication related configuration settings (#1269)

• Various stability and maintainability improvements (#1252, #1254, #1256, #1255)

v3.4.14 - 2023/12/07

Note: The release v3.3.13 has been revoked due to a release issue.

Bug fixes

• Fix: Test result files are processed multiple times with --configOverride, --testRunSetting or --testResultSetting command line options used (#1247)

• Fix: Build information is displayed after the version number (#1244)

• Fix: Unable to find attachment warning when publishing test results with TestRunTrx loader (#1251)

v3.4.12 - 2023/11/29

Improvements

• Support for .NET 8: The .NET tool installation now works on systems that only have .NET 8.0 SDK. (#1239)

• Warning when SpecSync is used with .NET Core 3.1 (#1243)

• Various stability and maintainability improvements (#1240, #1242)

v3.4.11 - 2023/11/22

Bug fixes

• Fix: xUnit test result loading error for wider scenario outline examples tables when using xunit.runner.visualstudio v2.5 (#1236)

• Fix: Configuration load error: "Unable to find a constructor to use for type SpecSync.Configuration.ConfigurationWarning" when --configOverride is used (#1238)

v3.4.10 - 2023/11/11

Improvements

• NUnit Plugin v1.0.2: Allow loading NUnit XML (v2, v3) test result files (#1232)

• Various stability and maintainability improvements (#1230)

Bug fixes

• Fix: NUnit Plugin: NullReferenceException when loading NUnit XML v3 result files (#1231)

v3.4.9 - 2023/11/06

Improvements

• Support for step-level results with Python Behave XML result files (#1226)

• Various stability and maintainability improvements (#1224)

v3.4.8 - 2023/10/17

New features

• Interactive conflict resolution when both the local and the remote test case has changed. The change provides an improved resolution for pull and the interactive resolution can also be used (optionally) for push. You can configure the conflict resolution method separately for push and pull and you can choose from methods: forceOverride, interactive, error, skip, ignore. Choosing for the error method can be also used to get notified about conflicting changes on the server. With the --force command line option, the changes can be overridden independently of the configured method. See Synchronization conflict resolution for details. (#613)

• Allow specifying Test Suites with path (e.g. Ordering/Card Payment), so you can refer to the hierarchy of the suites and allows creating hierarchy of suites. The path might contain suite names separated by /. When the suite does not exist, SpecSync builds up the hierarchy in the selected Test Plan. The path setting can be used in remote/testSuite, publishTestResults/testSuite, customizations/addTestCasesToSuites/testSuites and customizations/multiSuitePublishTestResults/suites settings. (#1173, #1184)

• Allow specifying Test Plan with name. In all places where testPlanId could be specified, there is a new testPlan setting that can be used to specify the Test Plan name (e.g. "testPlan": "Regression Plan") or a Test Plan ID (e.g. "testPlan": "#5678"). The testPlanId can still be used but deprecated and going to be removed in a future version. (#1183)

• Re-publishing existing Azure DevOps Test Run for the synchronized Test Cases (testRunTrx test result format). This is useful when the tests are run with the VSTest task, that deletes the local test result files in some cases. The test result loader loads the details from the Test Run with ID in the VSTEST_TESTRUNID environment variable or from the ID specified as result on the command line, e.g. -r 2345. See How to publish test results from pipelines using the VSTest task for details. (#1166)

Improvements

• Display unique ID for warnings. Now all warnings can be better identified with a code, like W5133. The next major release (v3.5) will provide further features for fine-grain handling of warnings. (#1210)

• Allow specifying default Test Plan for Add Test Cases to Suites customization to avoid setting the same plan for every suite. See customizations/addTestCasesToSuites for details. (#1185)

• The VSTestForSpecSync Azure DevOps pipeline task has been upgraded to match VsTest v3.225. The new task version is v3.225.1. See How to use the SpecSync Azure DevOps pipeline tasks for details. Please note that the VSTest rerun function for SpecFlow xUnit and NUnit has been reduced in VSTest v3, so consider to keep using the VSTestForSpecSync v1 if you use these systems, or switch to the testRunTrx loader described in the linked guide. (#1220)

• Reminder of using preview release that is released more than 90 days ago. Do not allow using preview releases released more than 180 days ago. (#1202)

• Improvements for plugin development:

  • Allow plugin Test Result Loaders to set DataRow on the test result (#1209)

• Various stability and maintainability improvements (#1204, #1211, #1170, #1172, #1206, #1215)

Bug fixes

• Fix: Data driven test results are detected as "rerun attempts" when test framework does not provide information about the executed data row (#1208)

• Fix: Hyperlinks included in the output (project URL, Test Run URL) cannot be opened from YAML pipeline output (#1180)

• Fix: No warning is shown when the VsTestForSpecSync task cannot remove the pipeline association from the published Test Run. In these cases it is recommended to use the testRunTrx test result loader. See How to publish test results from pipelines using the VSTest task for details. (#1169)

• Fix: "Request Entity Too Large" error during publish-test-results. (#1203)

v3.4.7 - 2023/08/16

New Plugins

See all plugins available on nuget.org in the plugin list

• SpecSync.Plugin.TestNGTestSource: This plugin can be used to synchronize Java TestNG test methods and publish test result files. See related guide and the plugin GitHub repository (#1143)

Improvements

• Show hint about the 'Add Test Cases to Suites' customization if there are too many Test Cases removed from Suite (#1109)

• Use BuildId if both BuildId and BuildNumber is provided & show error for non-unique build numbers (#1142)

• Better error messages for errors reported as "unhandled" (#1149, #1155, #1152, #1157, #1151, #1154, #1153, #1156)

• Various stability and maintainability improvements (#1159, #1148, #1147, #1140)

Bug fixes

• Fix: JUnitXml: Test Cases (represented as <testsuite>) with failing steps (represented as <testcase>) should be treated as failed, even if the last one passed (#1083)

• Fix: Unhandled error when Gherkin file contains comments in description (#1157)

• Fix: Existing Test Case links might be removed then there are at least 3 existing untracked links that becomes tracked (#1141)

• Fix: Excel Test Source plugin does not work with SpecSync v3.4.6 (#1139)

• Fix: Added whitespaces around parametrized Test Case quoted parameters are not restored during pull (#1138)

v3.4.6 - 2023/06/09

Bug fixes

• Fix: Not supported local tags are removed during pull if they are used in fieldUpdates (#1119)

• Fix: Pull removes tags that have been handled by field updates (#1111)

• Fix: IndexOutOfRangeException when Scenario Outline is pulled without data iterations (#1120)

v3.4.5 - 2023/06/07

New features

• Allow not synchronizing Test Case automation settings. For that the toolSettings/doNotSynchronizeAutomationUnlessEnabled configuration setting has to be set to true and the synchronization/automation/enabled configuration setting to false or leave it unset. (#1099)

• Allow not synchronizing Test Case title. See Customization: Do not synchronize title for details. (#1081)

• Allow updating Test Case automation settings with custom values using fieldUpdates. See Update automation fields for details. (#1101)

• Errors are reported with an error ID that can be shared with support and used to search solutions in the documentation (#1082)

• SpecSync Feed: SpecSync can load and display important service outages, hints and tips (#1037)

Improvements

• Output warnings and errors in a way that is recognized by Azure DevOps pipeline as error/warning (#1039)

• Support "Ignore non-supported local tags customization" for pull. The not supported tags are not removed. (#1107)

• List test case synchronization errors at the end, like warnings (#1086)

• Various stability and maintainability improvements (#1035, #1089, #1078, #1067, #1040)

Bug fixes

• Fix: Linking GitHub Pull Request to a newly created Test Case does not work (#1113)

• Fix: Attachments are not shown on the Azure DevOps pipeline "Tests" tab for scenario outlines and reruns (#1074)

• Fix: The error message does not contain the file name if test results are specified with a folder name, the format is not specified and there is a non-TRX file in the folder (#1070)

• Fix: Postman Test Source plugin (v1.0.3) now supports more usage patterns of the pm.test calls (#1079)

• Fix: Improve error handling of various unhandled errors (#1085)

v3.4.4 - 2023/03/30

New features

• Additional template placeholders for accessing remote server related settings ({remote-project-url}, {remote-server-url}, {remote-project-name}). See full list of available placeholders in the field updates reference. (#1024)

• Local test case conditions can be filtered for test name using $name = 'My scenario' syntax. The name filter can be combined with tag or source file filter as well, e.g. $sourceFile ~ **/Addition.feature and $name = 'Basic addition' This applies to all condition configuration settings and can also be used with the --tagFilter command line option. See all possibilities for local test case conditions in the feature description. (#1025)

• Introducing the generic --filter command line option that can be used to filter for both tags, names and source files. E.g. --filter '@basic and $sourceFile ~ **/Addition.feature and $name = "Basic addition"'.

New Plugins

See all plugins available on nuget.org in the plugin list

• SpecSync.Plugin.PostmanTestSource: This plugin can be used to synchronize a tests from a Postman collection and publish results executed with Newman. See related guide and the plugin GitHub repository (#1032)

Improvements

• Improvements for plugin development:

  • Base classes for REST API connections (#1017, #1023)

  • More flexibility for JUnitXml parsers (#1018, #1031)

  • More flexibility for JsonFileWriter (#1019)

  • Allow registering value loaders (#1020)

  • Allow deserializing parameters (#1021)

• Various stability and maintainability improvements (#1013, #1033)

Bug fixes

• Fix: Config source types might be calculated incorrectly (#1015)

• Fix: PyTest: Incorrect outcome published for dynamically skipped tests (#1027)

• Fix: Unhandled error is shown when a Test Suite is not found (#1029)

v3.4.3 - 2023/03/06

New features

• Customization: Add Test Cases to Suites. See feature description for details. (#1004)

Improvements

• Show Test Plan ID in the log (#1005)

• C# Plugins: make keyword parser customizable, allow accessing NUnit/MsTest namespaces (#997)

• Improve error message for unknown file source (#977)

• Ensure the personal access token (PAT) is used as password for ADO authentication to have better compatibility with some proxies (#987)

• Detect Base64 text embeddings in CucumberJson results (#991)

• Detect local test case to be up-to-date if it has only non-relevant remote changes (#982)

• Various stability and maintainability improvements (#981, #995, #1000)

Bug fixes

• Fix: NUnit v2 XML test result "Failure" is not recognized (#1001)

• Fix: Test Suite scope update might fail in dry-run mode (#998)

• Fix: Using tags with different casing might cause unnecessary updates (#936)

• Fix: Test result attachments missing for scenario outlines with a single iteration (#990)

• Fix: TRX test attachments are not found when test execution has been performed on a different OS than the publishing (#984)

• Fix: Gherkin comments are not allowed in description (#978)

v3.4.2 - 2023/02/14

Improvements

• Do not remove Test Cases from suite if the push command is executed with filter (#954)

• Render {testrun-url} as link in run/result comments (#970)

• Allow newline ({br}) and environment variable ({env:MY_ENV}) placeholders in run/result parameters (#957)

• Handle TAB characters for C# test sources (#950)

• No harmful change should be performed when the license file is not specified, but the number of scenarios exceed the free license limit (#944)

• Use provided file name for Cucumber JSON attachments (#960)

• Various stability and maintainability improvements (#691, #973, #955)

New Plugins

See all plugins available on nuget.org in the plugin list

• SpecSync.Plugin.NUnitTestSource: Allows synchronizing "C# NUNit Tests" and publish results from TRX result files. See plugin details and usage in the SpecSync plugins GitHub repository (#962)

Bug fixes

• Fix: Environment variables are not allowed anymore for local/featureFileSource/filePath and local/featureFileSource/folder (#947)

• Fix: Text file attachments ("text/plain" mime type) are included in STDOUT instead of publishing as attachment with Cucumber JSON format (Cypress) (#959)

• Fix: Test Cases might be removed from the configured suite after an unhandled or general error (#963)

• Fix: Attachments from before/after hooks are not published with Cypress (#958)

v3.4.1 - 2022/01/16

Improvements

• Include suite name in the "unable to create suite" error message. (#933)

• Allow '-' in tag prefixes (#930)

• Support for Azure DevOps 2022 Server (#940)

• Various stability and maintainability improvements (#942)

Bug fixes

• Fix: Incorrect Gherkin might be produced when Test Case step action or expected result field contains multiple lines (#923)

• Fix: Custom field with value null is overridden unnecessarily to '' (#934)

• Fix: Test Case might be updated always although it is up-to-date (#935)

v3.4.0 - 2022/12/21

All fixes of SpecSync v3.3.11 are included in this release.

New features

• Support updating Test Case fields that are not updated automatically by SpecSync using the fieldUpdates configuration. See feature description for details. (#737)

• In all expressions where you can specify a local test case condition (synchronization/automation/condition, customizations/resetTestCaseState/condition, synchronization/fieldUpdates[]/condition, synchronization/fieldUpdates[]/conditionalValue/*), you can now also specify source file path conditions as well using the $sourceFile ~ path/**/myfeature.feature format. E.g. the following expression selects scenarios that are tagged with @important and are in the pricing folder or any sub-folders below: @important and $sourceFile ~ pricing/. See Local test case conditions for details. (#878)

• Add/remove link tags on pull when Test Case links changed. SpecSync attempts to use the best tag prefix if there are multiple available by selecting the first with matching targetType or the first of the ones without targetType otherwise. (#807)

• SpecSync plugins can now be loaded from NuGet packages that are distributed through nuget.org, custom NuGet feeds or from local folders. See SpecSync plugin documentation for examples and further details. There is also a list of plugins available on nuget.org. (#814)

• The tag prefix separator (:) and the link label separator (;) can be customized now with synchronization/tagPrefixSeparators and synchronization/linkLabelSeparator. With that you can allow tags like @TestCase=1234. You can specify multiple tag prefix separators as well. SpecSync will use the first one to create new tags. (#773)

• Allow skip publishing test results for local test cases using the --tagFilter and --sourceFileFilter options. (#853)

• For custom placeholder in field updates, different "value loaders" can be specified. Value loaders can transform the value. E.g. if the HTML loader is used in a field update as {scenario-description:HTML}, it will replace the white space and new line characters of the scenario description with the necessary HTML elements. The following value loaders are supported: (#781)

  • HTML - encodes HTML tags, transforms whitespaces to HTML newlines and non-breaking spaces.

  • HtmlEncode - encodes HTML tags.

  • Unix - replaces Windows-style path separators (\) with Unix-style ones (/)

  • Windows - replaces Unix-style path separators (/) with Windows-style ones (\)

• Support Cucumber Java Surefire XML report (#795)

• Support for SpecFlow v4.0 (#901)

• Support for .NET 7: The .NET tool installation now works on systems that only have .NET 7.0 SDK. (#868)

New Plugins

See all plugins available on nuget.org in the plugin list

• SpecSync.Plugin.ScenarioOutlinePerExamplesTestCase: Plugin that synchronizes scenario outline examples blocks as individual test cases. See plugin details and usage in the SpecSync plugins GitHub repository (#718)

• SpecSync.Plugin.ExcelTestSource: This plugin can be used to synchronize a local test cases from Excel file using the format that Azure DevOps uses when you export Test Cases to CSV. See plugin details and usage in the SpecSync plugins GitHub repository

• SpecSync.Plugin.MsTestTestSource: Allows synchronizing "C# MsTest Tests" and publish results from TRX result files. See plugin details and usage in the SpecSync plugins GitHub repository

• SpecSync.Plugin.GenericTestResultMatcher: A SpecSync plugin that can be used to override test result matching rules. See plugin details and usage in the SpecSync plugins GitHub repository

Improvements

• The SpecSync Docker image is now based on the latest stable Ubuntu image (ubuntu:22.04) (#696)

• SpecSync now retries saving the Test Case if it has been modified while processing. (#614)

• Unrecognized elements in the configuration files are reported as warnings. (#806)

• Do not report items that are skipped because of scope by default. Using the verbose option (--verbose or -v) reports the skipped items as well. (#818)

• The user-specific configuration file got a separate JSON schema: https://schemas.specsolutions.eu/specsync-user-config-latest.json (#859)

• The type of the linked work items can be restricted using the synchronization/link[]/targetType or the customizations/linkOnChange/links[]/targetType configuration settings. (#822, #867)

• Filter, scope and other conditions are satisfied if there is at least one scenario outline examples that satisfies the condition. (#717)

• Improve performance of filtered / scoped command executions (#856)

• Detecting non-interactive user session for operations require user input and automatically cancel to avoid blocking process (#891)

• Improved publish-test-results reporting (#915)

• Improve progress indication for publish test results (#889)

• The test results with not executed outcome (NotExecuted, NotApplicable, NotRunnable, NotImpacted) are not published by default as they might hide earlier results of the Test Case. In order to force including them, the publishTestResults/includeNotExecutedTests setting can be used. (#894)

• The product name (SpecSync for Azure DevOps or SpecSync for Jira) is visible in the license file when opened in a text editor. (#876)

• Various stability and maintainability improvements (#911, #837, #808, #898, #880, #874, #834, #821, #832)

Deprecation notices

• The configuration setting publishTestResults/ignoreNotExecutedTests has been deprecated as ignoring test results with not executed outcome is the default now. (In order to force including them, the publishTestResults/includeNotExecutedTests setting can be used.) (#894)

• The configuration settings local/featureFileSource/type, local/featureFileSource/filePath and local/featureFileSource/folder are moved to the local group and renamed to local/projectType, local/projectFilePath, local/folder. The old settings work, but show a warning. (#873)

• The .NET 5 framework is out of support and will not receive security updates in the future (see https://aka.ms/dotnet-core-support). SpecSync versions released after 31/3/2023 will not run with .NET 5. Please use SpecSync with .NET 6 or any of the other supported platforms. (#919)

• The configuration setting synchronization/link[]/targetWorkItemType has been renamed to synchronization/link[]/targetType and SpecSync now verifies if a valid work item type has been specified when linking. The old setting works, but shows a warning. The additional verification is performed even if the old setting was used. (#822)

• The configuration settings toolSettings/testCaseWorkItemName and toolSettings/testSuiteWorkItemName are moved to /remote/azureDevOps/testCaseWorkItemName and remote/azureDevOps/testSuiteWorkItemName. The old settings work, but show a warning. (#862)

• The configuration setting customizations/synchronizeLinkedArtifactTitles/linkLabelSeparator has been moved to synchronization/linkLabelSeparator. The old settings work, but show a warning. (#850)

• The configuration setting publishTestResults/createSubResults has been removed, because SpecSync always needs to publish sub-results anyway for the proper test result reporting in Azure DevOps. (#801)

• The configuration settings publishTestResults/runName, publishTestResults/runComment, publishTestResults/runType, publishTestResults/testResultComment have been moved to publishTestResults/testRunSettings/name, publishTestResults/testRunSettings/comment, publishTestResults/testRunSettings/runType and publishTestResults/testResultSettings/comment. The old settings work, but show a warning. (#804)

Breaking changes

• If the configuration file contained entries that are not recognized by SpecSync (these were ignored so far), you will receive warnings about these settings. Please remove these settings to eliminate the warning. (#806)

• The test results with not executed outcome are not published by default. In order to force including them (the earlier behavior), the publishTestResults/includeNotExecutedTests setting can be used. (#894)

• The default link-label separator has been changed from : to ;. To continue using : as link label separator, please set synchronization/linkLabelSeparator. (#861)

• The tag prefixes specified in synchronization/links[]/tagPrefix are ensured to contain only word characters (letters, numbers, underscore). (#849)

• The support for Test Plan / Test Suite based test execution for SpecFlow 3.0 has been removed. SpecSync can still be used with any SpecFlow versions using the "publish-test-results" command (#903)

• Tag predicates in local test case conditions must start with '@'. Earlier tag predicates were also accepted, but from this version the @ has to be used, even if the local test case does not use this prefix for tags. (#877)

• The value specified as synchronization/link[]/targetWorkItemType (now renamed to synchronization/link[]/targetType) is used now to verify if the type of the linked work item. The verification is performed when establishing new links. To disable the verification and allow linking any work item types please remove this setting. (#822)

• Test Suite settings cannot be specified in user-specific configuration file anymore. The can be specified in project-specific configuration files or shared parent config files still. (#863)

• The "pull" command now adds and removes local test case tags based on the links of the Test Case. (#807)

• Settings that have been deprecated earlier are removed now (#805)

  • automation/skipForTags - use automation/condition instead

  • links[]/mode - was not used

  • local/featureFileSource/type=listFile - use folder as local/projectType in combination with local/sourceFiles instead

  • local/featureFileSource/type=stdIn - use folder as local/projectType in combination with local/sourceFiles instead

Plugin API improvements

• SpecSync plugins can now be loaded from NuGet packages that are distributed through nuget.org, custom NuGet feeds or from local folders. (#814)

• SpecSync plugins will support SpecSync for Jira as well, from the next SpecSync for Jira version (v1.2). (#902)

  • The plugin dependency package has been renamed from SpecSync.AzureDevOps.PluginDependencies to SpecSync.PluginDependencies.

  • The plugin API namespace has been renamed from SpecSync.AzureDevOps.* to SpecSync.*. (#833)

• Plugins can change the configuration via the PluginInitializeArgs.Configuration property (#857)

• Various improvements in plugin API (#857, #809)

  • BddProjectLoaderArgs.FeatureFileSource has been renamed to BddProjectLoaderArgs.LocalConfiguration

  • TagServices is available as ITagServices

  • ISpecSyncTracer.TraceWarning signature now contains a single TraceWarningItem parameter. (#815)

  • IKeywordParser can signal parsing errors and no keyword cases: the method ParseStepKeyword has been replaced by TryParseStepKeyword. (#792)

  • Link tags now can contain non-numeric values as well

  • ITagServices.GetTagData requires ITestCaseSyncContext instead of ILocalTestCase

  • LinkData.WorkItemId (int) has been replaced by LinkData.WorkItemIdentifier (WorkItemIdentifier)

  • LinkData.IsSpecSyncLink is replaced by LinkData.IsTrackedLink

  • LinkData default constructor has been removed (related properties are get-only)

  • TestCaseLink constructor takes TestCaseIdentifier instead of int

  • DotNetProjectLoader.CreateProjectReader takes BddProjectLoaderArgs argument

  • DotNetProjectReader and SpecFlowProjectReader constructor takes ISpecSyncTracer argument

  • IKeywordParser has a new method: GetPrimaryLocalTestCaseParametersKeyword

• Plugin dependencies are automatically loaded from the plugin folder (#908)

• Support for custom automation details with plugins by implementing the IAutomationSettingsProvider interface on the ILocalTestCase implementation (#909)

• Improvements in plugin dependency SpecSync.AzureDevOps.PluginDependency.CSharpSource:

  • Support for updating links in C# files. (#851)

  • Support for synchronizing descriptions from C# doc comments. (#843)

Bug Fixes

• Fix: Wait on stats calls block execution (#914)

• Fix: Plugins cannot be loaded with console app (#910)

• Fix: File paths in tags are not normalized on Linux and macOS (#912)

• Fix: Different hash is calculated when running on Windows or macOS/Linux causing unnecessary updates (#881)

• Fix: Plugins might be reported twice (#864)

• Fix: Pull command generates invalid scenario outlines for non-English feature files (#811)

v3.3.17 - 2024/10/28

Bug fixes

• Fix: Unhandled JsonSerializationException error when publishing test results using multi-suite publish (#1357)

v3.3.16 - 2023/10/13

Bug fixes

• Fix: "Request Entity Too Large" error during publish-test-results (#1203)

v3.3.15 - 2023/09/01

Improvements

• Various stability and maintainability improvements (#1035)

Bug fixes

• Fix: License ID is displayed instead of support code for renewed licenses (#1164)

• Fix: Attachments are not shown on the Azure DevOps pipeline "Tests" tab for scenario outlines and reruns (#1074)

v3.3.14 - 2023/03/30

Improvements

• Various stability and maintainability improvements (#1013, #1033)

Bug fixes

• Fix: Config source types might be calculated incorrectly (#1015)

• Fix: PyTest: Incorrect outcome published for dynamically skipped tests (#1027)

v3.3.13 - 2023/03/01

Improvements

• Ensure the personal access token (PAT) is used as password for ADO authentication to have better compatibility with some proxies (#987)

• Detect Base64 text embeddings in CucumberJson results (#991)

• Various stability and maintainability improvements (#914, #691, #995, #1000)

Bug fixes

• Fix: Test result attachments missing for scenario outlines with a single iteration (#990)

• Fix: TRX test attachments are not found when test execution has been performed on a different OS than the publishing (#984)

v3.3.12 - 2023/01/30

Improvements

• Include suite name in the "unable to create suite" error message. (#933)

• Support for Azure DevOps 2022 Server (#940)

• Use provided file name for Cucumber JSON attachments (#960)

• Various stability and maintainability improvements (#942)

Bug fixes

• Fix: Incorrect Gherkin might be produced when Test Case step action or expected result field contains multiple lines (#923)

• Fix: Custom field with value null is overridden unnecessarily to '' (#934)

• Fix: Test Case might be updated always although it is up-to-date (#935)

• Fix: Text file attachments ("text/plain" mime type) are included in STDOUT instead of publishing as attachment with Cucumber JSON format (Cypress) (#959)

• Fix: Attachments from before/after hooks are not published with Cypress (#958)

• Fix: Test Cases might be removed from the configured suite after an unhandled or general error (#963)

v3.3.11 - 2022/12/19

Bug fixes

• Fix: Scenario test results of pytest-playwright are not found (#917)

v3.3.10 - 2022/12/12

Note: The release v3.3.9 has been revoked due to a release issue.

Bug fixes

• Fix: Push command fails when invoked with --dryRun, a Test Suite is configured and there are multiple unlinked scenarios (#900)

• Fix: Cucumber JUnit XML report does not find additional scenario outline examples with recent Cucumber version (#796)

• Fix: Cucumber JSON scenario outline results are incorrectly detected as re-runs (#904)

• Fix: Cucumber test results might not be detected when scenario outline placeholder is used in the title (#472)

v3.3.8 - 2022/12/07

Bug fixes

• Fix: Configuration files are reported twice when configOverride is used (#890)

• Fix: Background step results might not be loaded from Cucumber JSON result (#819)

• Fix: local/featureFileSource setting cannot be overridden in a child config file (#798)

• Fix: Diagnostic output for configuration is not available (#797)

• Fix: Invalid Gherkin file created after pulling a Test Case with a "|" in a data table (#817)

• Fix: SpecSync might ask for password when version command is used (#848)

• Fix: Configuration override values cannot contain equals sign (#770)

• Fix: SpecSync Plugins: NoKeywordParser produces invalid TestSourceData (#791)

Improvements

• SpecSync NuGet packages are signed with Code Signing Certificate of Spec Solutions Kft., thumbprint: dd5e69f05ef38c016508380ca0d2294dbbe1ba69 (#882)

• Allow not publishing test results that are not executed using publishTestResults/ignoreNotExecutedTests (#893)

• Package for common C# test source plugin dependencies: SpecSync.AzureDevOps.PluginDependency.CSharpSource (#793)

• Allow using Client Certificates automatically from Windows Credential store for remote servers use mTLS (#838)

v3.3.7 - 2022/08/24

Bug fixes

• Fix: Indentation is not kept when tagging scenarios (#754)

• Fix: Relation already exists error when linking Azure DevOps pull requests (#762)

Improvements

• Support linking GitHub Pull Requests (#761)

v3.3.6 - 2022/07/13

Bug fixes

• Fix: Duration in Cucumber JSON results is interpreted incorrectly (#748)

• Fix: Publishing tests executed by the VsTest re-run setting is not supported. (This fix changes the default for the publishTestResults/createSubResults to true.) (#745)

Improvements

• Allow specifying empty "Action" value (#734)

v3.3.5 - 2022/06/09

Bug fixes

• Fix: Synchronize linked artifact titles customization does not link scenario if it contains only a requirement link tag (#731)

Improvements

• Treat test result attachment upload errors as warnings: Ignore test result attachments that are too large (#727)

• Allow placeholders ({testrun-id}, {testrun-url}) in test run and test result comment (#724)

• Show created Test Run URL in output (#732)

v3.3.4 - 2022/05/13

Bug fixes

• Fix: XML/HTML tags replaced to parameters in normal scenarios (not scenario outlines) (#712)

• Fix: Handle PAT expiration GSSAPI error as normal error (#715)

• Fix: .NET projects with special wildcard includes cannot be processed (#720)

• Fix: The reported parameter usages are shifted in the published results when parameter list pseudo step is used (#716)

Improvements

• Customization: Synchronize linked artifact titles. This customization can be used to synchronize linked artifact (Work Item) titles back to the local test case tags in @story:1234:This_is_the_story_title format. The link tags are only updated when the scenario is otherwise changed or when the --force option is used. (#714)

v3.3.3 - 2022/05/04

Bug fixes

• Fix: Allow disabling release pipeline association for publish-test-results command with the new --disablePipelineAssociation command line option. (#707)

Improvements

• Allow enabling timing diagnostics (#708)

v3.3.2 - 2022/04/28

Bug fixes

• Fix: Strong name validation failed error when using the SpecSync.AzureDevOps.Console package (#695)

• Fix: Init command does not work when config file name is specified in the command line (#686)

Improvements

• Allow specifying additional work item clones for re-link in a CSV file using the --workItemClonesFile option. (#663)

• Display .NET version information in verbose mode (#694)

• The SpecSync Docker images now provide a specsync executable for simpler usage (it is a symbolic link to the executable SpecSync4AzureDevOps). (#682)

• The SpecSync Docker images are now based on the ubuntu:20.04 image (#697)

• Smaller improvements for work item identity and console handling (#681, #687)

v3.3.1 - 2022/03/10

Bug fixes

• Fix: Test execution history is not displayed in the History tab of the Test Run (#653)

• Fix: Tests appear multiple times in the 'Tests' tab of the pipeline result when the VsTest task is used. To fix this there is a new "SpecSync Tools" Azure DevOps extension, that contains a task "Visual Studio Test for SpecSync" that is a modified version of the VsTest task that does not display the result in the 'Tests' tab. (See How to use the SpecSync Azure DevOps pipeline tasks for details.) (#655)

v3.3.0 - 2022/02/21

New features

• Attach files to Test Cases using tags. (See feature documentation for details.) (#489)

• Dry-run mode: all commands of SpecSync support a --dryRun option. With this option used no changes will be made neither to Azure DevOps nor to the feature files. This option is useful for testing the impact of an operation without making an actual change. (#115)

• Re-link: a new SpecSync command that supports re-linking all scenarios after the Test Cases have been cloned using the Azure DevOps "Copy Test Plan" or "Copy Test Suite" features. (See feature documentation for details.) (#499)

• Source files local scope: The set of scenarios considered for synchronization ("local scope") can be now also specified by specifying the set of feature files using the local/sourceFiles setting in the configuration file. (See Excluding scenarios from synchronization for details.) (#587)

• Filter for feature files: when performing a push or pull command, the execution can be limited to a set of feature files using the --sourceFileFilter option. (See Filters and scopes for details.) (#492)

Improvements

• Display more details about the synchronization command (e.g. how many Test Cases have been modified, how many Test Cases were up-to-date) (#583)

• Link-only flag for push: you can specify a --linkOnly flag to the push command, that skips updating the existing Test Cases, but creates and links new Test Cases for the new scenarios. (#633)

• Create-only flag for pull: you can specify a --createOnly flag to the pull command, that skips updating the existing scenarios, but creates new scenarios (in new feature files) for the new Test Cases. (#303)

• The "Automated Test Type" Test Case field is better used: The default value (Unit Test) for the "Automated Test Type" Test Case field has been changed. The new default value is Gherkin for non-SpecFlow projects and SpecFlow for SpecFlow projects. The default value of the field can be changed using the synchronization/automation/automatedTestType setting in the configuration file. The change is performed with the next change of the Test Case or can be forced by running the push command with an additional --force flag. (#550)

• Work item link tracking: The work item links created by SpecSync are tracked now. This means that if a link was established by SpecSync and the related scenario tag is removed from the feature file, the link will also be removed at the next synchronization. The links created manually or by an earlier version of SpecSync are never removed. (#570)

• All scenario outline examples columns are preserved. If you had a scenario outline with an examples table that contained a column (e.g. "description") that was not used anywhere in the steps, this column was not synchronized to Azure DevOps. Now in this case an additional pseudo-test step is added to the Test Case, in order to preserve all parameters. This behavior can be forced to all scenario outlines or completely disabled using the synchronization/format/showParameterListStep configuration setting. (#569)

• Support for Gherkin v22: tagged rules, rule-specific backgrounds (#497)

• Support for Background steps in pull (#611)

• Improved change detection for scenarios (new hash algorithm) (#111)

• Improved possibilities for SpecSync plugins

  • Allow analyzing custom keyword (#552)

  • Allow using class name and method name in test result matchers for detecting data row (#603)

  • Customizable base classes for writing custom test source plugins easier (#557)

  • The test result matcher infrastructure has been adapted to the other "provider-style" services and TestResultMatcher has been renamed to TestResultMatcherProvider on the plugin interface (#647)

  • More functions defined on the ILocalTestCaseContainerUpdater interface (#648)

Breaking changes

• The scenario hash that is calculated for the Test Cases (saved to the history) is not backwards compatible with v3.2 (see #111). This means that once a Test Case has been updated with v3.3, when downgrading to v3.2 an additional change will be recorded for the Test Cases. With the normal usage (no downgrade) the change has no impact.

• The support for running SpecFlow v2 scenarios using the Test Plan / Test Suite based execution has been removed (ie there is no update provided for the related SpecFlow plugins). You can still publish results from SpecFlow v2 projects using the "publish-test-results" command and can use the v3.2 plugins in combination with the v3.3 synchronizer if necessary. (#571)

• As the default value of the "Automated Test Type" Test Case field has been changed (see #550), you need to explicitly set the synchronization/automation/automatedTestType setting to Unit Test (the old default value), when your processes were dependent on the old "Automated Test Type" value. Usually this value is only informational, so the change will have no impact.

• For scenario outlines with examples table that has columns not used in the steps, SpecSync will automatically add a pseudo-step by default to preserve these values (see #569). If this causes any problems, the feature can be disabled by setting the synchronization/format/showParameterListStep configuration setting to never.

• The target framework of the SpecSync SpecFlow plugins has been updated to use .NET Framework 4.7.2 instead of 4.7.1. This should have no impact on the usage. (The SpecSync.AzureDevops.Console package still depends on .NET Framework 4.6.2, this wasn't changed.) (#566)

• The listFile and the stdIn values in the local/featureFileSource/type configuration setting are deprecated and will be removed in a future version. It is recommended to use folder value in combination with sourceFiles setting (#587) instead.

• The synchronization/links[]/mode setting is deprecated and will be removed in a future version with the introduction of link synchronization (#570). As the mode had only one possible value, this change will have no impact. Please remove the setting.

• Because of the improved possibilities for SpecSync plugins, the SpecSync plugins created for v3.2 have to be adapted slightly.

Bug Fixes

• Fix: Feature tags are duplicated at the scenario on pull (#612)

• Fix: Test Case parameters are not cleared when a Scenario Outline is changed to a normal Scenario (#641)

• Fix: When only non-SpecSync managed fields changed in ADO, but these fields are updated with a customization, scenario is detected to be up-to-date even with --force (392)

v3.2.13 - 2022/03/10

Bug fixes

• Fix: Test execution history is not displayed in the History tab of the Test Run (#653)

• Fix: Tests appear multiple times in the 'Tests' tab of the pipeline result when the VsTest task is used. To fix this there is a new "SpecSync Tools" Azure DevOps extension, that contains a task "Visual Studio Test for SpecSync" that is a modified version of the VsTest task that does not display the result in the 'Tests' tab. (See How to use the SpecSync Azure DevOps pipeline tasks for details.) (#655)

v3.2.12 - 2022/02/07

Bug fixes

• Fix: Test Configuration might not be resolved by name when there are more than 200 configurations specified in the project (#629)

• Fix: The relativeResultsDirectory attribute of the UnitTestResult element of the TRX file is not used to find attachments (#635)

v3.2.11 - 2022/01/18

Bug fixes

• Fix: Scenario outline xUnit result might not be found in TRX file when more data is provided in the examples table (#623)

• Fix: String values cannot be set wrapped by quotes for config override (#610)

• Fix: Config file path is not included in JSON deserialization error messages (#535)

v3.2.10 - 2021/12/16

Bug fixes

• Fix: When the specified Test Suite does not exists, an unnecessary ADO request is made (#582)

• Fix: Scenario Outline results cannot be published when SpecFlow generator is configured with allowRowTests=false for xUnit and NUnit (#602)

v3.2.9 - 2021/12/08

Improvements

• The Ignore non-supported local tags customization has been extended to allow specifying the not-supported tags instead of the supported tags in order to handle cases where you want to skip synchronizing certain tags. (#568)

• Override any configuration setting from command line using the --configOverride option. See Override configuration setting from command line for details. (#578)

v3.2.8 - 2021/11/22

Improvements

• Support for .NET 6 framework when installed as a .NET tool. (#565)

v3.2.7 - 2021/11/04

Improvements

• Customization: Ignore non-supported local tags. This customization is useful when the Azure DevOps settings does not allow creating new tags for normal users. With the customization you can specify those tags that are supported in the Azure DevOps project and SpecSync will ignore all other local (scenario) tags. (#538)

• Display currently enabled customizations on the output (#545)

• Allow specifying value for the Automated Test Type field of the Test Case (to override the default Unit Test) and be able to select custom as automation strategy (useful for non .NET projects) (#549)

• Show error if multiple scenarios are linked to the same Test Case (#546)

• Show error if a scenario has multiple Test Case tags (#553)

• Support for NUnit v2 XML test result file format (#554)

Bug fixes

• Fix: Additional space included to the Test Case title or parts of the title is missing when the local test case title contains a colon and synchronized from a plugin (#551)

• Fix: JSON schema for the configuration file does not allow : in tag expressions (#536)

v3.2.6 - 2021/09/09

Improvements

• Use build/release queue user as test "run by" identity (#510)

• Support for SpecFlow v3.8, v3.9 (#531)

Bug fixes

• Fix: Last test result indicator is not visible in Azure DevOps test suite screen for ADO2019 or earlier (#530)

• Fix: Suite name requires to be unique across all plans even is test plan specified (#513)

• Fix: Test result publishing might not publish results to Test Plans with more than 200 Test Suites (#496)

• Fix: Duplicate test results published with multi-suite publish customization (#502)

• Fix: Test results are not associated with the result when invoked from a release pipeline (#507)

v3.2.5 - 2021/07/01

Improvements

• Show license info in "version" command. With the option --bare, only the version number is displayed. (See version command.) (#462)

• Show custom value for empty "expected result" using synchronization/format/emptyExpectedResultValue setting. (See format settings.) (#456)

• Allow specifying additional labels for work item links in tags, separated by a semicolon, like @bug:456:argument_error_for_empty_input. (See Linking Work Items using tags.) (#460)

Bug fixes

• Fix: Behave test results not detected when scenario outline placeholder is used in the title (#470)

• Fix: Unable to create link for PRs in another project (#458)

• Fix: Unhandled error "Value cannot be null. (Parameter 'gherkinDialect')" for invalid feature files (#469)

v3.2.4 - 2021/05/21

Bug fixes

• Fix: Test statistics are not displayed on stage summary for staged builds (#448)

• Fix: Published tests are not displayed in the "Tests" tab of the build result (see Use SpecSync from build or release pipeline for details) (#453)

v3.2.3 - 2021/04/29

Improvements

• Include interface code documentation for plugin dependencies (#450)

Bug fixes

• Fix: Error during synchronization for very long project, feature or scenario names (#439)

• Fix: Python Behave skipped status is not mapped, pending is not recognized (#427)

• Fix: Incorrect run completion time published when publishing from a different time zone as the tests run (#445)

• Fix: Attached images are not numbered using test case step number, when useExpectedResult is enabled (#440)

• Fix: Zip packages use incompatible path references for Linux (#437)

• Fix: Synchronizing scenarios with "<" character causes the test case to display incorrectly (#451)

v3.2.2 - 2021/03/16

Improvements

• Display more diagnostic information when no test results were published (#425)

Bug fixes

• Fix: Test step results are published incorrectly when useExpectedResult format option is enabled and the scenario has more than 2 Then step (#422)

v3.2.1 - 2021/03/09

New features

• Customization: Automatically link changed Test Cases (#412)

Improvements

• Support SpecSync plugins in .NET Framework runner (SpecSync.AzureDevOps.Console package). (#415)

• Support for Jest with jest-cucumber. You need to use jestCucumberXml as a publish format. (#395)

• SpecFlow step-level messages are displayed in the test result (#402)

• SpecFlow+ Runner results can be published with Free and Standard editions (#404)

• Support for SpecFlow v3.7 (#414)

Bug fixes

• Fix: Multi-line step messages are displayed without line separators (#411)

• Fix: Invalid ADO parameter data causes synchronization to stop (#413)

v3.2.0 - 2021/01/26

New features

• Publish execution result details as Test Run iterations with step results and the standard output of the tests is also attached to the test result. Step results are published only if the result format supports it (currently for SpecFlow results and Cucumber JSON). (#317, #318)

• Support for new test result formats: Cucumber JSON (works with all Cucumbers), Cucumber.js XML and Cypress JSON files. See all supported formats at in the Compatibility page. (#349, #341)

• Support publishing test result attachments. Currently supported for TRX and Cucumber JSON result formats. (#122, #360)

• Customization: Allow reset Test Case state after change as a separate work item update based on tags. This is useful for example when the Test Case has to be marked as Ready if the scenario is tagged with @ready, but when work item updates are not allowed in Ready state. See Customization: Reset Test Case state after change for details. (#378)

• Support .NET 5. The SpecSync .NET Core Tool package now also contains a .NET 5 version. The .NET Core 3.1 is still available and can also be used. (#340)

Improvements

• Support for linking pull requests using tags. To link a pull request, you have to configure a link synchronization with a prefix and with relationship set to Pull Request. (#388)

• Allow publishing multiple test result files. The test results from the multiple files are going to be merged and published as a single test run. You can list multiple files and directories using the -r (--testResultFile) option separated by semicolons (;). See Publishing test result files for details. (#343)

• Support for SpecFlow v3.5 (#353)

• Support for SpecFlow v3.6 (#391)

• Improved custom update templates: remove description indent, allow scenario/feature source text to be used, allow Rule name and description to be used, can use Gherkin-independent placeholder names (#347, #323)

• Allow environment variables to be used in custom update and custom default template in {env:ENV_VARIABLE_NAME} format. (#348)

• Improve error message in case of insufficient PAT authorization scope issue (#124)

• Use folder file source when SpecSync is invoked from a non-dotnet folder and improve error message if it is invoked from the wrong folder. This way you can start using SpecSync for non-dotnet projects without specifying local settings in configuration. (#342)

• Allow setting System.History field (appears as "Discussion" in Azure DevOps) with custom field updates (#324)

• Use the test configuration of the test suite if there is only one assigned by default for publishing test results. Supported only with Azure DevOps Services, on older versions the configuration has to be specified explicitly with the -c (--testConfiguration) option or in the config file. (#321)

• Displaying release date, warn if an outdated release is used (#375)

• State change (synchronization/state/setValueOnChangeTo) can be limited to scenarios using tag expressions. Can be used together with the Reset Test Case state customization. (#379)

• Improve error reporting of publish-test-results (#350)

Breaking changes

• Make sub-result publish optional. Because of the improved iteration details publishing (see above), SpecSync will not automatically publish Scenario Outline iterations as sub-results (sub-results are not displayed on Azure DevOps UI, but can be retrieved using the Azure DevOps API). Publishing sub-results can be enabled with publishTestResults/createSubResults. (#339)

• Use condition instead skipForTags in synchronization/automation configuration setting. The condition should contain the negated expression of the skipForTags, e.g. not @manual. (#381)

Bug Fixes

• Fix: Circular parent config files causes Stack Overflow (#316)

• Fix: Too long examples lines might cause xUnit TRX results unable to load (#361)

• Fix: SDK-style .NET project files with explicitly listed feature file references using wildcards are not supported (#216)

• Fix: SpecSync assemblies have non-real date in PE header timestamp (#368)

v3.1.2 - 2021/03/09

Improvements

• Support SpecSync plugins in .NET Framework runner (SpecSync.AzureDevOps.Console package). (#415)

• Improve error message in case of insufficient PAT authorization scope issue (#124)

• Displaying release date, warn if an outdated release is used (#375)

Bug Fixes

• Fix: Circular parent config files causes Stack Overflow (#316)

• Fix: Invalid ADO parameter data causes synchronization to stop (#413)

v3.1.1 - 2021/01/05

Improvements

• Parameters of Scenario Outlines are not visible in published test results if there are only one example. (#320)

• Support localized Azure DevOps processes: set toolSettings/testCaseWorkItemName and toolSettings/testSuiteWorkItemName configuration settings (#315)

Bug Fixes

• Fix: Test Cases synchronized from non-SpecFlow project cannot be marked as automated (#345)

• Fix: Test Run automation status is not set on TFS2017 (#352)

v3.1.0 - 2020/10/26

New features & improvements

• SpecSync plugin support. See SpecSync Plugins for details. (#110)

• Allow users to enter their credentials interactively in the .NET Core based installations (#298)

• Allow users to save their user name or PAT to the user-specific configuration if they have entered them interactively (#297)

• Non-zero exit code is returned on warnings (#285)

• Force SpecSync tool to exit with zero exit code even in case of warnings using the --zeroExitCodeForWarnings flag. (#301)

• Ignore specified Azure DevOps Test Case tags (they are not going to be removed even if there is no corresponding tag on the scenario) See Customization: Ignoring Test Case Tags for details. (#305)

• Allow ignoring SSL certificate errors for a trusted certificate (#290)

• Show warning when feature files have became invalid after synchronization (#286)

• Diagnostic categories can be specified on command line. The support team might ask you to configure this for diagnosing special integration issues. (#234)

• Allow specifying the SpecSync compatibility version in configuration files. The compatibility version specifies the SpecSync version that the configuration file was created for. The new SpecSync features can be used even if the compatibility version is older than the current version, but if the default values of some settings change in the future, SpecSync will not apply these default unless the compatibility version is updated. (#312)

• Allow to override Run Type setting of the published Test Run (handling automation mismatch error) (#125)

Breaking changes

• The setting --baseFolder becomes obsolete. It can be still used in v3.1 but it is going to be removed in a future release. As an alternative, you can set the working directory of the SpecSync tool. (#311)

• The setting --diag becomes obsolete. It can be still used in v3.1 but it is going to be removed in a future release. As an alternative, you should use the equivalent --verbose (or -v) options. (#309)

Bug Fixes

All bug fixes od v3.0.3 are also included in this release.

• Fix: Test Case change is not detected if it only contains a link removal and there are no other field changes

• Fix: Make "assemblyBasedExecution" strategy as default (#313)

v3.0.3 - 2020/10/23

Improvements

• --verbose option also displays diagnostic messages (equivalent to --diag). The --diag option will become obsolete in v3.1. (#310)

• Display config file being used (#304)

• Suggest checking the troubleshooting page on error (#227)

Bug Fixes

• Fix: Misleading error message when the SpecFlow tools folder is not configured/detected correctly (#300)

• Fix: Should load user-specific config file even if ignoreParentConfig is set to true (#306)

• Fix: When multi-suite-publish customization is used, the enforcement of specifying a Test Suite is unnecessary (#299)

• Fix: Test cases with more than 200 history item cause synchronization error (#123)

• Fix: Package name is displayed instead of product name in the command line tool (#307)

v3.0.2 - 2020/09/03

v3.0.1 released earlier on the same day has been deprecated due to a bug for specifying log files. Please use v3.0.2.

Improvements

• Display Support Code: There is a 5-letter support code displayed in the synchronization output for licensed users. Please provide the support code for reporting incidents or license renewal.

• Publish official SpecSync Docker image: There are pre-built official Docker images available at https://hub.docker.com/r/specsolutions/specsync that are ready-to-use for synchronizing scenarios or publishing test results. See Install as Docker image for details.

• Improvement: detect unchanged Test Case steps and do not show them in Test Case history

• Set "Run By" field on publish-test-results

• Support SpecFlow v3.4 with Test Suite based execution with Scenario Outline wrappers strategy, using NuGet package: SpecSync.AzureDevOps.SpecFlow.3-4

• .NET Core binaries are also distributed as downloadable zip package

Bug Fixes

• Fix: Config file settings cannot be overridden from command line if they contain invalid path

• Fix: Configuration error causes exit code 90 (unhandled error) instead of 100

• Fix: SpecSync removes UTF-8 BOM header from the file on link

• Fix: Gherkin Rule keyword is not supported (no scenarios found in file)

• Fix: Invalid Build ID detected from build or release pipeline

• Fix: Unnecessary whitespace at the bottom of DocString (fix applies at the next scenario change unless you perform a push with --force)

• Fix: Error when log file does not exist (found in v3.0.1)

v3.0.0 - 2020/07/24

Note: The release was formerly planned as v2.2.

When upgrading from v2, please check the Migrating from SpecSync v2 to v3 page.

New features & improvements

• .NET Core Support: SpecSync is provided as a .NET Core Tool, the .NET Framework executable is available as NuGet package: SpecSync.AzureDevOps.Console

• Using new Azure DevOps API

• Publishing test results to multiple Test Suites (enterprise feature, see Customization: Publishing test results to multiple Test Suites)

• Allow to specify log file

• init command to setup SpecSync for a new project (see init command)

• Hierarchical SpecSync configuration files (see Hierarchical configuration files)

• List known remotes in user-specific configuration file (see Hierarchical configuration files)

• Attaching files to test run

• Tag test cases of removed scenarios with specsync:removed

• Support for SpecFlow v3.3 with Test Suite based execution with Scenario Outline wrappers strategy, using NuGet package: SpecSync.AzureDevOps.SpecFlow.3-3

• Map inconclusive test results for publishing (see Publishing inconclusive test results)

• Specify target test suite for publishing on the command line

• Tag expressions support tail wildcards

• Map tags (enterprise feature, see Customization: Mapping tags)

• Allow specifying test run and test result comments for publishing

• Published test results are automatically connected to the Azure DevOps builds or the build reference can be specified explicitly

• New supported test result formats (besides TRX): Cucumber Java (XML), Python Behave (XML), Cucumber Studio/Hiptest JSON, Python PyTest.BDD (XML), SpecFlow NUnit (XML)

• Simplified licensing: scenario outlines count as one for synchronization limit

• Improved authentication error handling

Breaking changes

• synchronization/forceUpdate has been removed from configuration (use --force command line option instead)

• Replace --buildServerMode with --disableLocalChanges on the command line and synchronization/enableLocalChanges with synchronization/disableLocalChanges in the config file

• SpecFlow+ Excel support removed

• Linux Mono support has been removed, but SpecSync v3 can be used on Linux and OSX using the .NET Core tool or the downloadable native binaries

• The minimum .NET Framework version supported is 4.6.2 (v4.5 is not supported)

• Setting 'useLegacyFeatureFileGenerator' has been deprecated

Bug Fixes

• Fix: Maximum 1000 test results can be processed with a single call

• Fix: --force does not fix Scenario Outline parameter binding

• Fix: Using shared parameters cause sync error

v2.1.14 - 2020/07/24

Improvements

• Support for SpecFlow v3.3 with Test Suite based execution with Scenario Outline wrappers strategy, using NuGet package: SpecSync.AzureDevOps.SpecFlow.3-3

• Simplified licensing: scenario outlines count as one for synchronization limit

Bug Fixes

• Fix: --force does not fix Scenario Outline parameter binding

• Fix: Using shared parameters cause sync error

v2.1.13 - 2020/06/11

Bug Fixes

• Fix: Parameters are not displayed when test is manually executed using the web-based test runner of ADO (Microsoft.VSTS.TCM.Parameters is not set)

v2.1.12 - 2020/04/03

Bug Fixes

• Fix: Publishing xUnit test results cannot find tests with VsTest v16.5.0 or higher

• Fix: Publishing NUnit test results cannot find tests

• Fix: version command should return with exit code 0

v2.1.11 - 2020/02/23

Improvements

• Improved test case result comment when publishing test results of scenario outlines

Bug Fixes

• Fix: DataTable headers missing when scenario is pulled

• Fix: DataTable is not pulled properly when syncDataTableAsText formatting option is enabled

• Fix: DocString is not pulled properly

• 3rd party open-source licenses (third-party-licenses.txt) added to the package. The information is also available from the Licensing page.

v2.1.10 - 2019/11/01

Improvements

• Security protocol can be configured for HTTPS (e.g. to avoid using TLS 1.0). To override the default configuration set the remote/securityProtocol setting in the configuration file to one of the following values: Ssl3, Tls, Tls11, Tls12

• Support for SpecFlow v3.1 (via NuGet package SpecSync.AzureDevOps.SpecFlow.3-1).

Bug Fixes

• Fix: Test result remains in "In Progress" state when publishing test results

v2.1.9 - 2019/08/22

Bug Fixes

• Fix: useTestCaseData value for setting specFlow/scenarioOutlineAutomationWrappers causes "Invalid Test Case ID" error

• Fix: Incorrect detection of PAT when specified as %foo% in config file

• Fix: Incorrect display of user name when specified as %foo% and asks for password

v2.1.8 - 2019/08/15

Bug Fixes

• Fix: execution on Linux using the dependency-bundled executable fails with TypeInitializationException

Improvements:

• Native library libMonoPosixHelper.so does not need to be copied to the project folder for native Linux execution

v2.1.7 - 2019/08/12

Bug Fixes

• Fix: execution on Linux using the dependency-bundled executable fails with assembly load error

v2.1.6 - 2019/07/08

Bug Fixes

• Fix: specsync4azuredevops.cmd does not tolerate spaces in project path

• Fix: default feature file language is not picked up from SpecFlow config

v2.1.5 - 2019/06/14

Bug Fixes

• Fix: Error when synchronizing SpecFlow V3 projects that use specflow.json config file

v2.1.4 - 2019/05/29

Bug Fixes

• Fix: Publish tests does not find SpecFlow+ Runner test results without feature name in the test definition name

• Fix: Publish tests reports the test as "Not Executed" when there are skipped test targets in a SpecFlow+ Runner test result

• Fix: Collect all test result for scenarios executed with SpecFlow+ Runner using multiple test targets

• Fix: Include example name for the test result error, stack trace and comment fields created for scenario outlines

• Show license expiration date and remaining time warning

v2.1.3 - 2019/05/08

Bug Fixes

• Fix: Publish test results fails for TFS2018

v2.1.2 - 2019/04/08

Bug Fixes

• Fix "Error during generation" error when linking new scenarios

v2.1.1 - 2019/04/04

Bug Fixes

• Fix generation with SpecFlow.Tools.MsBuild.Generation for SpecFlow 2.4

v2.1.0 - 2019/04/02

Breaking changes

• When synchronizing automated test cases, a test execution strategy has to be configured in the synchronization/automation section of the configuration file. To read more about test execution strategies see the Synchronizing automated test cases article.

New features

• Support for SpecFlow v3 both .Net Framework and .Net Core

• New test execution strategy for automated test cases: Assembly based execution

  • Supports all test runners (MsTest, xUnit, NUnit, SpecFlow+ Runner)

  • Supports both .NET and .NET Core

  • Available for TFS 2017 or newer

  • See more in the Synchronizing automated test cases article

• Updated "Test Suite Based execution strategy": now supports MsTest, xUnit and NUnit in Azure DevOps (for MsTest, Scenario Outline wrapper and SpecSync SpecFlow plugin is needed.

  • See more in the Synchronizing automated test cases article

• Allow overriding base folder using the --baseFolder console option

• Allow specifying Test Plan ID to be able to improve Test Suite loading time

• Automatically create Test Suite if does not exists

Bug Fixes

• Fix displaying load project source in console

• Fix: Invalid "_MsTest" suffix might be added to the automated test class name

• Better error reporting for project load error

• Fix project URL error message

• Fix changing link type

v2.0.0 - 2019/01/14

Breaking changes

• The product has been renamed to SpecSync for Azure DevOps to be conform with the updated product name of Microsoft TFS/VSTS

• The NuGet package has been renamed and split:

  • SpecSync.AzureDevOps - contains the synchronization tool

  • SpecSync.AzureDevOps.SpecFlow.2-3, SpecSync.AzureDevOps.SpecFlow.2-4, etc. - contains the SpecFlow plugin required to synchronized automated test cases for a particular SpecFlow version (eg. v2.3, v2.4).

  • SpecSync.MTM - obsolete package, will load SpecSync.AzureDevOps, SpecSync.AzureDevOps.SpecFlowPlugin has to be added manually if necessary

• The synchronization tool has been renamed from SpecSync4MTM to SpecSync4AzureDevOps

• The configuration of the synchronization has been moved to a configuration file (although a few options can be overridden from the command line). By default the config file should be named as specsync.json. See configuration options and samples at Configuration.

• The two-way synchronization has been reworked to be able to support a more stable development process. The synchronization has been split into two independent actions: push and pull. The new process should follow a pull-merge/resolve-verify-push model. See Two-way synchronization for details.

• Tag filtering has been split to tag filter and tags scope. Tag filter has to be specified on the command line (--tagFilter), while tag scope has to be specified in the config file (local/tags). See Filters and scopes for details.

• If a scenario was linked to a test case that does not exist, SpecSync reports this as an error (in v1 it linked to a new scenario and replaced the wrong tag)

• The 'state' field of the test case is set to the value provided in configuration synchronization/state/setValueOnChangeTo not only when the test case changed (v1) but also when the test case is created.

• The default way of generating test method wrappers has changed to iterateThroughExamples. See specFlow configuration for details.

New features

• Support for specifying test case field default values and custom field updates. See customizations configuration.

• Support for skipping the Scenario or Scenario Outline prefixes in test case title. See synchronization configuration.

• Test case tag prefix name (by default tc) can be configured. See synchronization/format configuration.

• Support for ignoring test case steps with a specific prefix text. See customizations configuration.

• Support for synchronization of scenarios on a feature branch. See customizations configuration.

• Support for folder-based synchronization. See local configuration.

• SpecSync can track format configuration changes and automatically re-sync scenarios without the --force option.

• More readable sync trace output.

v1.6.0 - 2018/07/25

• Support for SpecFlow v2.3.*

• Support for synchronizing scenarios from a branch to a temporary set of test cases (see --branchTagPrefix option, experimental)

• Fix: Generating feature-file code-behind files fail with the SpecFlow Visual Studio integration v2017.1.11 or later.

• Fix: Do not remove filtered out test cases from the test suite.

• Fix: Invalid tools version error when back-syncing new test cases.

• Fix: Handle   in test cases.

• Fix: Use proper space encoding in the URL specified in the @tfs tag.

• Fix: Do not add @tfs tag to feature if otherwise not changed (scenarios skipped)

• Fix: Space handling in TFS collection name.

• Fix: Missing parameter in parametrized test case if the Scenario Outline placeholder is used in a DataTable.

• Improved error handling

v1.5.0 - 2018/04/11

• Support for SpecFlow v2.3.1 (for SpecFlow v2.2.1, please use v1.4.*)

v1.4.1 - 2018/04/10

• Fix: ArgumentOutOfRangeException when synchronizing empty feature file

• Fix: Do not count skipped scenarios in summary

• Improved error handling

v1.4.0 - 2018/03/20

• Use new TFS REST API (supports TFS 2015+)

• Support synchronizing non-SpecFlow projects with the --listFilePath option. See page Using SpecSync with Cucumber for details.

• Allow executing the synchronization from OSX and Linux systems. See page Using SpecSync on OSX/Linux for details.

• Filter scenarios to be synchronized with tag expressions using the --tags option.

• --skipAutomation supports tag expressions.

• Improved test case formatting options (see Configuring the format of the synchronized test cases)

  • Synchronize Then steps to the expected results column of the test case steps by specifying the --useExpectedResult option.

  • Synchronize data tables as plain text by specifying the --syncDataTableAsText option.

  • Skip adding the Background: prefix for background steps by specifying the --doNotPrefixBackgroundSteps option.

  • Force synchronization even if the scenario text did not change by specifying the --force option. This is useful after changing formatting options like --useExpectedResult.

• Better handling invalid Gherkin files.

• Generate @tc:123 tags on new lines (before the first existing tag line).

• Update existing (invalid or incomplete) @tc: tags instead of generating a new one.

v1.3.2 - 2017/10/31

• Fix SpecFlow+ Runner compatibility issue for Scenario Outlines

v1.3.1 - 2017/10/10

• Feature: Specify an area or an iteration for the newly created test cases using --areaPathForCreate and --iterationPathForCreateoptions See Add new test cases to an Area or an Iteration for details.

• Upgrade to SpecFlow 2.2.1.

• Fix project loading issues.

• Fix SpecFlow+ Runner integration issue.

• Fix Newtonssoft.Json loading issue.

• Fix IndexOutOfBounds error when synchronizing data tables with empty cells.

v1.2.0 - 2017/03/31

• Support synchronizing '@us:123' style tags to links between the test case and other work items. The tag prefixes and the link type can be specified. See Linking work items using tags for details.

• Small fixes in Scenario Outline table handling

• Fix compatibility issue for running synchronized test cases using the TFS lab environment.

• Add application icon

v1.1.6 - 2016/08/11

• Fix authorization problem with VSTS for Alternate authentication credentials and Personal access tokens

• Set test case tags to the tags of the scenario

• Only update changed test cases

• Synchronize automation does not need to have a compiled test assembly

• Feature files are automatically regenerated if changed

• Optionally set test case state to a configured value when test case is updated

• Synchronize test cases to test suites

• Support for SpecFlow+ Excel examples

• More robust error handling

• Two-way synchronization (beta)

v1.0.1 - 2016/03/17

• Only display the exception messages by default, you can use the --verbose option to get the stack trace.

• The tool returns with non-zero exit code if there was an error.

• The ESC key can be used to cancel password entering.

• Allow specifying environment variables in user name.

• Fix tag placing issue.

• Allow more authentication options (sign-in prompts, domain account)

• Tested with TFS 2013.

v1.0.0 - 2016/02/24

Initial version used in the demo video in the intro post.