Add script to test live API integration #128
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mr0grog
force-pushed
the
89-it-never-hurts-to-check-the-live-api
branch
from
6406f08 to
ebfe508
Compare
Mr0grog
changed the base branch from
84-async-promise-support-is-overdue
to
main
|
I updated this to not depend on #125, which is a lot more complicated to review. I also moved this script and a couple others from the @dbader any chance you are able to add credentials for a test Datadog account to the repository secrets? Then I can add a CI workflow for this. I have usable credentials if you don’t; just send me an e-mail if you want them. |
This basic script sends some metrics to Datadog using this library, then queries the API for those same values to make sure they were successfully ingested and will be visible in Datadog's UI. This is mainly meant as a simple test to ensure changes to the underlying Datadog client keep sending things in the correct form. Unit tests *mostly* cover this use case, so the check here is pretty lightweight. We don't check every metric type, for example. But this is still important. Fixes #89.
It turns out Mocha was seeing these (or at least the ones that are JS) and at least executing the top-level code. We could adjust Mocha's settings, but it's probably better to separate these checks anyway, since they aren't really unit tests.
Since distributions get send through an entirely different API endpoint, we should include them in the test.
Mr0grog
force-pushed
the
89-it-never-hurts-to-check-the-live-api
branch
from
57d0203 to
dd03893
Compare
|
CI works!!! Thanks, @dbader 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a
npm run check-integrationscript that sends some metrics to Datadog using this library, then queries the API for those same metric values to make sure they were successfully ingested and will be visible in Datadog's UI.The goal here is to provide a minimal check of real, live integration in case a change to the actual reporter or Datadog client breaks or mis-formats something in a way that our unit tests don’t effectively catch. In most cases, our unit tests should be enough (this is why we use nock instead of just mocking the Datadog client), so this check is pretty lightweight (it only checks one metric type, for example).
I haven’t included any CI changes since @dbader would need to configure CI with working credentials. If we get that going, great, otherwise this will just have to be something maintainers run locally as needed (mainly before publishing releases).
Fixes #89.