DataDog / datadog-ci-azure-devops

Use Browser and API tests in your Azure pipelines with Datadog Continuous Testing

Datadog Continuous Testing for Azure DevOps

Overview

With the Datadog Continuous Testing Azure DevOps Extension, you can run Synthetic tests within your Azure Pipeline configuration and ensure all your teams using Azure DevOps can benefit from Synthetic tests at every stage of the software lifecycle. You can run SyntheticsRunTests as a task.

Authentication

Service Connection

To connect to your Datadog site, Datadog recommends setting up a custom service connection when configuring the Synthetics Run Test task.

You need to provide the following inputs:

• Datadog site: Which Datadog site to connect and send data to.
• Custom subdomain (default: app): The name of the custom subdomain set to access your Datadog application. If the URL used to access Datadog is myorg.datadoghq.com, this value needs to be set to myorg.
• API Key: Your Datadog API key. This key is created by your Datadog organization.
• Application key: Your Datadog application key. This key is created by your Datadog organization.

API and Application keys

• API Key: Your Datadog API key. This key is created by your Datadog organization and is accessed as an environment variable.
• Application key: Your Datadog application key. This key is created by your Datadog organization and is accessed as an environment variable.
• Datadog site: The Datadog site to connect and send data to.
• Custom subdomain (optional): The name of the custom subdomain set to access your Datadog application. If the URL used to access Datadog is myorg.datadoghq.com, this value needs to be set to myorg.

Setup

To connect to your Datadog account, create a Datadog CI service connection in your Azure pipelines project. Once created, all you need is the name of the service connection in the tasks.

1. Install the Datadog Continuous Testing extension from the Visual Studio Marketplace in your Azure Organization.
2. Add your Datadog API and application keys in the Datadog CI service connection, or as secrets to your Azure Pipelines project.
3. In your Azure DevOps pipeline, use the SyntheticsRunTests task.

Your task can be simple or complex.

Simple usage

Note: We recently changed the major version of the task from SyntheticsRunTests@0 to SyntheticsRunTests@1.

This is NOT a breaking change, but an alignment between the task version and the extension version.

Example task using public IDs

- task: SyntheticsRunTests@1
  displayName: Run Datadog Synthetic tests
  inputs:
    authenticationType: 'connectedService'
    connectedService: 'my-datadog-ci-connected-service'
    publicIds: |
      abc-d3f-ghi
      jkl-mn0-pqr

Example task using existing synthetics.json files

- task: SyntheticsRunTests@1
  displayName: Run Datadog Synthetic tests
  inputs:
    authenticationType: 'connectedService'
    connectedService: 'my-datadog-ci-connected-service'
    files: 'e2e-tests/*.synthetics.json'

For an example test file, see this test.synthetics.json file.

Example task using pipeline secrets for authentication

- task: SyntheticsRunTests@1
  inputs:
    authenticationType: 'apiAppKeys'
    apiKey: '$(DatadogApiKey)'
    appKey: '$(DatadogAppKey)'
    subdomain: 'myorg'
    datadogSite: '$(DatadogSite)'

Complex usage

Note: We recently changed the major version of the task from SyntheticsRunTests@0 to SyntheticsRunTests@1.

This is NOT a breaking change, but an alignment between the task version and the extension version.

Example task using the testSearchQuery

- task: SyntheticsRunTests@1
  displayName: Run Datadog Synthetic tests
  inputs:
    authenticationType: 'connectedService'
    connectedService: 'my-datadog-ci-connected-service'
    testSearchQuery: 'tag:e2e-tests'

Example task using the testSearchQuery and variable overrides

- task: SyntheticsRunTests@1
  displayName: Run Datadog Synthetic tests
  inputs:
    authenticationType: 'connectedService'
    connectedService: 'my-datadog-ci-connected-service'
    testSearchQuery: 'tag:e2e-tests'
    variables: |
      START_URL=https://staging.website.com
      PASSWORD=$(StagingPassword)

Example task using a global configuration override with configPath

This task overrides the path to the global datadog-ci.config.json file.

- task: SyntheticsRunTests@1
  displayName: Run Datadog Synthetic tests
  inputs:
    authenticationType: 'connectedService'
    connectedService: 'my-datadog-ci-connected-service'
    configPath: './synthetics-config.json'

For an example configuration file, see this global.config.json file.

Inputs

Name	Requirement	Description
authenticationType	required	The type of authentication you want Datadog to use, either connectedService or apiAppKeys.
connectedService	optional	The name of the Datadog CI service connection to use when using the connectedService authentication type.
apiKey	optional	Your Datadog API key when using the apiAppKeys authentication type. This key is created by your Datadog organization and should be stored as a secret.
appKey	optional	Your Datadog application key when using the apiAppKeys authentication type. This key is created by your Datadog organization and should be stored as a secret.
subdomain	optional	The name of the custom subdomain set to access your Datadog application when using the apiAppKeys authentication type. If the URL used to access Datadog is myorg.datadoghq.com, this value needs to be set to myorg. Default: app.
datadogSite	optional	The Datadog site when using the apiAppKeys authentication type. Default: datadoghq.com.
publicIds	optional	A list of tests IDs for Synthetic tests you want to trigger, separated by new lines or commas. If no value is provided, the task looks for files named synthetics.json.
testSearchQuery	optional	Trigger tests corresponding to a search query. This can be useful if you are tagging your test configurations. For more information, see rules and best practices for naming tags.
files	optional	Glob pattern to detect Synthetic tests' config files. Default: {,!(node_modules)/**/}*.synthetics.json.
configPath	optional	The global JSON configuration used when launching tests. For more information, see the example configuration. Default: datadog-ci.json.
variables	optional	A list of global variables to use for Synthetic tests, separated by new lines or commas. For example: START_URL=https://example.org,MY_VARIABLE=My title. Default: [].
jUnitReport	optional	The filename for a JUnit report if you want to generate one.
pollingTimeout	optional	The duration (in milliseconds) after which the task stops polling for test results. At the CI level, test results completed after this duration are considered failed. Default: 30 minutes.
failOnCriticalErrors	optional	Fail the CI job if no tests were triggered, or results could not be fetched from Datadog. Default: false.
failOnMissingTests	optional	Fail the CI job if at least one specified test with a public ID (using publicIds or listed in a test file) is missing in a run (for example, if it has been deleted programmatically or on the Datadog site). Default: false.
failOnTimeout	optional	Fail the CI job if at least one test exceeds the default test timeout. Default: true.

Further reading

Additional helpful documentation, links, and articles:

• Continuous Testing and CI/CD Configuration
• Best practices for continuous testing with Datadog