Fix misleading error when _FILE secret is not readable#9622
Open
kon-foo wants to merge 2 commits intopgadmin-org:masterfrom
Open
Fix misleading error when _FILE secret is not readable#9622kon-foo wants to merge 2 commits intopgadmin-org:masterfrom
kon-foo wants to merge 2 commits intopgadmin-org:masterfrom
Conversation
WalkthroughAdds file-existence and readability validation to the file_env function in the Docker entrypoint script; if a VAR_FILE is set but the referenced file is missing or unreadable, the script prints an error and exits with status 1. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
Problem
When a *_FILE environment variable (e.g. PGADMIN_DEFAULT_PASSWORD_FILE) points to a file that doesn't exist or isn't readable, the file_env() function silently reads an empty string, exports the base variable as empty, and then unsets the _FILE variable.
This causes the downstream validation to produce a misleading error:
...even though PGADMIN_DEFAULT_PASSWORD_FILE was correctly set. This is a common scenario when using Docker secrets with incorrect mount paths or file permissions.
Proposed Fix
Add an explicit check for file readability before attempting to read it. If it fails, issue an clear error message and exit immidiately.
Performed Tests
To reproduce the tests
docker build -t pgadmin-better-error:1 .Summary by CodeRabbit