Secrets: update guidance and parsing for local multiline env vars #1890
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
github-actions
bot
added
the
documentation
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
|
Preview url: https://benefits-1890--cal-itp-previews.netlify.app |
thekaveman
force-pushed
the
docs/local-secrets-newlines
branch
from
6b1e3e5
to
f8bc1e0
Compare
|
Preview url: https://benefits-1890--cal-itp-previews.netlify.app |
thekaveman
force-pushed
the
docs/local-secrets-newlines
branch
from
f8bc1e0
to
29c84b6
Compare
|
Preview url: https://benefits-1890--cal-itp-previews.netlify.app |
|
🤔 Cypress tests are passing locally for me using the exact same steps as the workflow... ?? EDIT: I had an outdated Docker image, hence the addition in the secrets helper of the unescaping of newlines. |
Docker, bash, etc. support multiline environment variables, by simply wrapping the value in single quotes with newlines, e.g. in an .env file: multi_line_value='first line second line third line' Resulting in the expected: $ echo "$multi_line_value" first line second line third line Due to a quirk in VS Code's Python extension, multiline values are not parsed, see https://code.visualstudio.com/docs/python/environments#_environment-variables > ... Multiline values aren't supported ... And more ongoing discussion at microsoft/vscode-python#18307 When running locally in e.g. Debug mode, and secrets are read dynamically from the environment, Python loses the multiline value and we end up with: >> value = os.environ.get("multi_line_value") >> print(value) first line This changes the samples and docs so literal newlines are added to the value of the environment variable in an .env file: multi_line_value='first line\nsecond line\nthird line' But the initial value read by Python contains _escaped_ newline characters: first line\\nsecond line\\nthird line Hence unescaping so that local secrets contain the actual newline character: first line\nsecond line\nthird line
thekaveman
changed the title
thekaveman
force-pushed
the
docs/local-secrets-newlines
branch
from
29c84b6
to
a7084bb
Compare
|
Preview url: https://benefits-1890--cal-itp-previews.netlify.app |
thekaveman
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.
Docker, bash, etc. support multiline environment variables, by simply wrapping the value in single quotes with newlines, e.g. in an .env file:
Resulting in the expected:
Due to a quirk in VS Code's Python extension, multiline values are not parsed, see https://code.visualstudio.com/docs/python/environments#_environment-variables
And more ongoing discussion at microsoft/vscode-python#18307
When running locally in e.g. Debug mode, and secrets are read dynamically from the environment, Python loses the multiline value and we end up with:
This changes the samples and docs so literal newlines are added to the value of the environment variable in an .env file:
But the initial value read by Python contains escaped newline characters:
first line\\nsecond line\\nthird lineHence unescaping in the secrets helper, so that local secrets contain the actual newline character:
first line\nsecond line\nthird line