PDE-3951 test(cli): fix failing tests in dependabot's PRs #762
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
The `fields-choices` endpoint doesn't need a deploy key, so we can enable `skipDeployKey` in the request options.
It turns out our CI isn't running the smoke test for the `zapier integrations` command because `DEPLOY_KEY` has been always empty. The correct environment variable to use is `ZAPIER_DEPLOY_KEY`.
GitHub's dependabot [doesn't have access to secrets][1]. This is why dependabot's PRs have been failing. The tests in RegisterCommand don't really need the deploy key because they use nock to mock HTTP requests. But our `callAPI()` function always checks crendentials with `readCredentials()`; it isn't aware that the request may be "nocked" and won't require a deploy key. This commit bypasses the checks in `readCredentials()` the issue by setting a fake ZAPIER_DEPLOY_KEY before running the tests. Since the requests are "nocked", the fake deploy key won't be sent to Zapier anyway. [1]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#accessing-secrets
szchenghuang
approved these changes
Mar 28, 2024
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.
Mock
ZAPIER_DEPLOY_KEYfor RegisterCommand testscommit ac29aa2
GitHub's dependabot doesn't have access to secrets. This is why dependabot's PRs have been failing. The tests in RegisterCommand don't really need the deploy key because they use nock to mock HTTP requests. But our
callAPI()function always checks crendentials withreadCredentials(); it isn't aware that the request may be "nocked" and won't require a deploy key.This commit bypasses the checks in
readCredentials()by setting a fakeZAPIER_DEPLOY_KEYbefore running the tests. Since the requests are "nocked", the fake deploy key won't be sent to Zapier anyway.Replace
DEPLOY_KEYwithZAPIER_DEPLOY_KEYin CLI smoke testscommit 18b7ebc
It turns out our CI isn't running the smoke test for the
zapier integrationscommand becauseDEPLOY_KEYhas been always empty. The correct environment variable to use isZAPIER_DEPLOY_KEY./api/platform/cli/apps/fields-choicesdoesn't need deploy keycommit d60711a
The
fields-choicesendpoint doesn't need a deploy key, so we can enableskipDeployKeyin the request options.