chore: unset SYNTHETICS_API_KEY before tests to ensure clean test env #1050
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR adds logic to the Jest global setup to clear out any locally set SYNTHETICS_API_KEY so that tests run in a clean environment.
- Unset
SYNTHETICS_API_KEYif present inprocess.envbefore tests start. - Log a message when the variable is cleared.
Comments suppressed due to low confidence (1)
tests/utils/jest-global-setup.ts:31
- Consider adding a test to verify that
SYNTHETICS_API_KEYis indeed unset in the test environment. You could create a simple test case that checksprocess.env.SYNTHETICS_API_KEYisundefinedafter the global setup runs.
if (process.env.SYNTHETICS_API_KEY) {
andrewvc
changed the title
andrewvc
changed the title
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
andrewvc
changed the title
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.
After more hours than I'd care to admit debugging bizarre test failures I discovered the issue was that I often have SYNTHETICS_API_KEY set locally. That causes many functional tests to fail, where they assume the user has no auth specified etc.