fix: expand home directory for credentials file #1425
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 documentation does not specify that the `credentials-file` field in `config.yaml` needs to be an absolute path. If you add a relative path with a `~`, it throw as error that the file is not found. However, this iis a confusing error for the user as the file at the path exists, it is just that `os.Stat` failed because it could not expand the `~`. This commit fixes the above issue by running a `homedir.Expand` on the `credentials-file` path in the `credentialFinder` function.
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.
Issue
The documentation for creating a tunnel's configuration file does not specify that the
credentials-filefield inconfig.ymlneeds to be an absolute path.A user (E.G. me 🤦) might add a path like
~/.cloudflared/<uuid>.jsonand wonder why thecloudflared tunnel runcommand is throwing a credentials file not found error. Although one might consider it intuitive, it's not a fair assumption as a lot of CLI tools allow file paths with~for specifying files.P.S. The tunnel ID in the following snippet is not a real tunnel ID, I just generated it.
Furthermore, the error has a confusing message for the user as the file at the logged path actually exists, it is just that
os.Statfailed because it could not expand the~.Solution
This commit fixes the above issue by running a
homedir.Expandon thecredentials-filepath in thecredentialFinderfunction.