Support Synthetics Test Suites

[melkouri]

Requirements for Contributing to this repository

• Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
• The pull request must only fix one issue, or add one feature, at the time.
• The pull request must update the test suite to demonstrate the changed functionality.
• After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

This PR adds support for syncing Synthetics Test Suites between orgs, ensuring they are replicated with their test references correctly mapped to destination test IDs.

Description of the Change

A test suite is bundle of multiple tests, so we added tests as a dependency of Suites.
We first create tests then tests Suites that check the mapping between the source and destination tests.

Using the v2 Public API https://docs.datadoghq.com/api/latest/synthetics/#create-a-test-suite

• List │ GET │ /api/v2/synthetics/suites/search
• Get │ GET │ /api/v2/synthetics/suites/{public_id}
• Create │ POST │ /api/v2/synthetics/suites
• Update │ PUT │ /api/v2/synthetics/suites/{public_id}
• Delete │ POST │ /api/v2/synthetics/suites/bulk-delete

Verification Process

• Created Multiple Test suites in R1

• Synced to R2

• Updated test suites on R1, and changes are correctly propagated to R2
• Deleting a suite from source and running with --cleanup True correctly deletes it from destination

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

• Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
• PR title must be written as a CHANGELOG entry (see why)
• Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
• PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
• PR should not have do-not-merge/ label attached.
• If Applicable, issue must have kind/ and severity/ labels attached at least.

[heyronhay]

Looks good overall, one potential issue found.

[heyronhay]

Can this return paginated results or is it just always just a single list of results?

[melkouri]

I see that the endpoint https://api.datadoghq.com/api/v2/synthetics/suites/search could be used with pagination using start (The offset from which to start returning results) and count (The maximum number of results to return) (doc)

[melkouri]

fixed in a072397