Continuous Testing and CI GitHub Actions
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project,
feel free to reach out to us!Overview
Trigger Synthetic tests from your GitHub workflows with the Datadog CI Synthetics command.
Setup
To get started:
- Add your Datadog API and Application Keys as secrets to your GitHub repository. For more information, see API and Application Keys.
- In your GitHub workflow, use
DataDog/synthetics-ci-github-action
.
Your workflow can be simple or complex.
Simple workflows
Example workflow using public IDs
name: Run Synthetic tests using the test public IDs
jobs:
e2e_testing:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Run Datadog Synthetic tests
uses: DataDog/synthetics-ci-github-action@v1.13.0
with:
api_key: ${{secrets.DD_API_KEY}}
app_key: ${{secrets.DD_APP_KEY}}
public_ids: 'abc-d3f-ghi, jkl-mn0-pqr'
Example workflow using an existing synthetics.json
file
name: Run Synthetic tests using an existing synthetics.json file
jobs:
e2e_testing:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Run Datadog Synthetic tests
uses: DataDog/synthetics-ci-github-action@v1.13.0
with:
api_key: ${{secrets.DD_API_KEY}}
app_key: ${{secrets.DD_APP_KEY}}
For an example test file, see this test.synthetics.json
file.
Note: By default, this workflow runs all the tests listed in {,!(node_modules)/**/}*.synthetics.json
files (every file ending with .synthetics.json
except for those in the node_modules
folder). You can also trigger a list of Synthetic tests by specifying a public_id
or using a search query.
Complex workflows
Example workflow using the test_search_query
name: Run Synthetic tests by test tag
jobs:
e2e_testing:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Run Datadog Synthetic tests
uses: DataDog/synthetics-ci-github-action@v1.13.0
with:
api_key: ${{secrets.DD_API_KEY}}
app_key: ${{secrets.DD_APP_KEY}}
test_search_query: 'tag:e2e-tests'
Example workflow using a test search query and variable overrides
name: Run Synthetic tests using search query
jobs:
e2e_testing:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Run Datadog Synthetic tests
uses: DataDog/synthetics-ci-github-action@v1.13.0
with:
api_key: ${{secrets.DD_API_KEY}}
app_key: ${{secrets.DD_APP_KEY}}
test_search_query: 'tag:staging'
variables: 'START_URL=https://staging.website.com,PASSWORD=stagingpassword'
Example workflow using a global configuration file with config_path
By default, the path to the global configuration file is datadog-ci.json
. You can override this path with the config_path
input.
name: Run Synthetic tests with custom config
jobs:
e2e_testing:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Run Datadog Synthetic tests
uses: DataDog/synthetics-ci-github-action@v1.13.0
with:
api_key: ${{secrets.DD_API_KEY}}
app_key: ${{secrets.DD_APP_KEY}}
config_path: './global.config.json'
For an example of a global configuration file, see this global.config.json
file.
Name | Type | Requirement | Description |
---|
api_key | string | required | Your Datadog API key. This key is created by your Datadog organization and should be stored as a secret. Default: none. |
app_key | string | required | Your Datadog Application key. This key is created by your Datadog organization and should be stored as a secret. Default: none. |
config_path | string | optional | The global JSON configuration to be used when launching tests. See the example configuration file for more details. Default: datadog-ci.json . |
datadog_site | string | optional | The Datadog site to send data to. Default: datadoghq.com . |
fail_on_critical_errors | boolean | optional | Fail the CI job if no tests were triggered, or results could not be fetched from Datadog. Default: false . |
fail_on_missing_tests | boolean | optional | Fail the CI job if at least one specified test with a public ID (using public_ids 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 . |
fail_on_timeout | boolean | optional | Fail the CI job if at least one test exceeds the default test timeout. Default: true . |
files | string | optional | Glob pattern to detect Synthetic test configuration files. Default: {,!(node_modules)/**/}*.synthetics.json . |
junit_report | string | optional | The filename for a JUnit report if you want to generate one. Default: none. |
public_ids | string | optional | Comma-separated list of public IDs for Synthetic tests you want to trigger. If no value is provided, the action looks for files named with synthetics.json . Default: none. |
polling_timeout | number | optional | The duration (in milliseconds) after which the action stops polling for test results. At the CI level, test results completed after this duration are considered failed. Default: 30 minutes. |
subdomain | string | optional | The name of the custom subdomain set to access your Datadog application. If the URL used to access Datadog is myorg.datadoghq.com , the subdomain value needs to be set to myorg . Default: app . |
test_search_query | string | optional | Trigger tests corresponding to a search query. Default: none. |
tunnel | boolean | optional | Use the Continuous Testing Tunnel to execute your test batch. Default: false . |
variables | string | optional | Comma-separated list of global variables to use for Synthetic tests. For example: START_URL=https://example.org,MY_VARIABLE=My title . Default: [] . |
Contributing
See CONTRIBUTING.md
Further reading
Additional helpful documentation, links, and articles: