SpecSync Documentation
Getting StartedConfigurationGuidesDownloads
Azure DevOps
Azure DevOps
  • Introduction to SpecSync for Azure DevOps
  • Getting started
    • Getting started using SpecFlow
    • Getting started using Cucumber or other Gherkin-based BDD tool
  • Installation & Setup
    • Install as .NET tool
    • Install as .NET Console App
    • Install as native binaries for Linux or macOS
    • Install as Docker image
    • Setup and Configure
  • Features
    • Push features
      • Pushing scenario changes to Test Cases
      • Configuring the format of the synchronized test cases
      • Synchronizing Scenario Outlines
      • Add new Test Cases to an Area or an Iteration
      • Mark Test Cases as Automated
      • Setting Test Case state on change
      • Update Test Case fields
      • Attach files to Test Cases using tags
      • Customization: Setting Test Case fields with default values
      • Customization: Update custom Test Case fields on push
      • Customization: Ignoring marked Test Case steps
      • Customization: Ignoring Test Case Tags
      • Customization: Ignore non-supported local tags
      • Customization: Mapping tags
      • Customization: Synchronizing scenarios from feature branches
      • Customization: Reset Test Case state after change
      • Customization: Automatically link changed Test Cases
      • Customization: Synchronize linked artifact titles
      • Customization: Add Test Cases to Suites
      • Customization: Do not synchronize title
    • Pull features
      • Pulling Test Case changes to local scenarios
    • Common synchronization features
      • Configuration key
      • Remote scope
      • Linking Work Items using tags
      • Synchronizing Test Case hierarchies using Test Suites
      • Include synchronized Test Cases to a Test Suite (deprecated)
      • Excluding scenarios from synchronization
      • Synchronization conflict resolution
      • Re-link scenarios to new Test Cases
    • Test result publishing features
      • Publishing test result files
      • Support for Azure DevOps Test Plan / Test Suite based test execution
      • Customization: Publishing test results to multiple Test Suites
    • General features
      • Azure DevOps authentication options
      • Configuration file
      • Hierarchical configuration files
      • Local test case conditions
      • Configuration wizards
      • SpecSync plugins
    • Customizations
    • Plugin list
  • Licensing
  • Guides
    • What is my Azure DevOps project URL?
    • How to define the local feature-set to be synchronized
    • Filters and scopes
    • How to synchronize automated test cases
    • How to use SpecSync from build or release pipeline
    • How to publish test results from pipelines using the VSTest task
    • How to use the SpecSync Azure DevOps pipeline tasks
    • How to link GitHub pull requests
    • How to upgrade to a newer version of SpecSync
    • How to attach files to test results
    • Using SpecSync with SpecFlow+
    • Using SpecSync with Cucumber
    • Using SpecSync with Cypress
    • Using SpecSync with Postman
    • Using SpecSync with TestNG
    • Using SpecSync on macOS or Linux
    • Using SpecSync inside a Docker container
    • How to handle Test Cases of multiple parallel application releases
    • Migrating from SpecSync v3 to v5
    • Migrating from SpecSync v2 to v3
    • Migrating from SpecSync v1 to v2
  • Changelog
  • Release Model and Roadmap
  • Downloads
  • Reference
    • Command line reference
      • init
      • upgrade
      • push
      • pull
      • publish-test-results
      • re-link
      • version
    • Configuration reference
      • toolSettings
      • local
      • remote
      • knownRemotes
      • synchronization
        • push
        • pull
        • automation
        • state
        • areaPath
        • iterationPath
        • links
        • attachments
        • format
        • fieldUpdates
      • hierarchies
      • publishTestResults
      • specFlow
      • reqnroll
      • customizations
    • Compatibility
    • Older versions
  • Contact
    • SpecSync Support
    • Troubleshooting
    • FAQ
  • Project Website
Powered by GitBook
On this page

Was this helpful?

  1. Reference
  2. Configuration reference

remote

PreviouslocalNextknownRemotes

Last updated 1 year ago

Was this helpful?

This configuration section contains settings for accessing the test cases on the remote Azure DevOps server.

The following example shows the most common options within this section.

{
  ...
  "remote": {
    "projectUrl": "https://specsyncdemo.visualstudio.com/MyCalculator",
    "user": "myuser",
    "password": "%MYPWD%",
    "testSuite": {
      "name": "BDD Scenarios",
      "testPlanId": 12345
    }
  },
  ...
}

Settings

The remote settings of the Azure DevOps project can also be specified in the knownRemotes section of one of the parent configuration file or in the user-specific configuration file. Check for details.

Setting
Description
Default

projectUrl

mandatory

authenticationMethod

The authentication method to be used for connecting to the remote server. Possible values: Interactive, UserNamePassword, PAT, ServicePrincipal

automatically detect UserNamePassword or PAT

user

interactive prompt

password

interactive prompt

tenantId

Only for ServicePrincipal authentication method: specify the Microsoft Entra Tenant ID.

Mandatory for ServicePrincipal authentication method

authenticationCertificateThumbprint

Only for ServicePrincipal authentication method: specify the thumbprint of the client certificate to be used for authentication. The certificate has to be saved to the Personal certificate store.

client secret (password) is used

securityProtocol

The security protocol to be used for the remote connection (Ssl3, Tls, Tls11, Tls12).

system default

ignoreCertificateErrorsForThumbprint

SSL is verified by the OS

testSuite

test cases are not included in a test suite

testSuite/name

The name of the Test Suite. For suites with non-unique names, please use the testSuite/id or testSuite/path setting.

either name, id or path is mandatory

testSuite/id

The ID of the Test Suite as a number.

either name, id or path is mandatory

testSuite/path

The path of the Test Suite from the root of the Test Plan, separated by / (e.g. Ordering/Card Payment).

either name, id or path is mandatory

testSuite/testPlanId

Deprecated, use 'testPlan' instead.

not specified

testSuite/testPlan

The name or ID of the Test Plan to search or create the test suite in, e.g. My Plan or #1234. (Optional, improves performance)

not specified

azureDevOps

Azure DevOps server configuration settings.

  • testCaseWorkItemName — The name of the Test Case work item in a localized Azure DevOps process (Default: Test Case)

  • testSuiteWorkItemName — The name of the Test Suite work item in a localized Azure DevOps process (Default: Test Suite)

uses default AzureDevOps server settings

The full URL of the Azure DevOps or VSTS project (including project collection name if necessary). Must not include project team name: for multi-team projects the root project URL has to be specified. See for details.

The Azure DevOps user name or (PAT) to be used for authentication. For ServicePrincipal authentication method the application ID is specified here. It may contain environment variables in ...{env:ENV_VAR}... form. See for details.

The password to be used for authentication. For ServicePrincipal authentication method the client secret is specified here. It may contain environment variables in ...{env:ENV_VAR}... form. See for details.

The thumbprint of the server certificate that should be treated as trusted. It is recommended to install trusted certificates on the operating system instead of using this setting. See related for details.

Specifies a test suite within the Azure DevOps project as a target container of the synchronized test cases. If the test suite is specified, SpecSync will add the synchronized test cases to it for push command and consider the test cases within the suite for pull command. See for details.

Hierarchical configuration files
Configuration reference
What is my Azure DevOps project URL
personal access token
Azure DevOps authentication options
Azure DevOps authentication options
Group synchronized test cases to a test suite
Troubleshooting entry