Improve logging of environment variables #3543
Conversation
tests/tox_env/test_api.py
Outdated
| pytest.param("ACCESS_TOKEN", True), | ||
| pytest.param("API_KEY", True), | ||
| pytest.param("DB_PASSWORD", True), | ||
| pytest.param("FOO", False), |
There was a problem hiding this comment.
Missing some of the ones included into rege x, let's test all of them, and we should document all of the patterns in our docs (users shouldn't need to read code to find it out).
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Sorted. Added tests for all of them and also included an extra logging message before the env vars are dumped that mentioned that some were redacted and why (keywords).
There is no need to update documentation website because there is no section reffering to tox logs. The only mention was on FAQ with a basic question about how to increase logging level. Also, due to the notice message in the log, we can consider the behavior self-documented.
There was a problem hiding this comment.
We should add that documentation section. I'm on holiday will review and merge when I'm back next week. I don't think we should have that notice message.
ssbarnea
force-pushed
the
fix/3542
branch
2 times, most recently
from
302c9cf to
511fcac
Compare
|
@gaborbernat Any chance you could look at it again today? I think that I addressed the requests. This patch is a blocker for improving the security of GHA pipelines as I would not want to disable log collection for tox. Thanks. |
Improves logging of environment variables by sorting them by key and redacting
the values for the ones that are likely to contain secrets.
Fixes: #3542
tox -e fix)docs/changelogfolder