Fix shell escape errors when querying for Rancher API#37
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates adp-connect.sh to avoid shell escape/unescape issues (notably backslashes in JSON) by replacing echo pipelines with printf when passing API responses and other strings through parsing tools.
Changes:
- Replaced multiple
echo "$var"pipelines withprintf '%s' "$var"to avoid escape interpretation and preserve JSON fidelity. - Adjusted
rancher_loginto return failure codes in more cases (and updated several call sites to handle failures). - Added additional diagnostic output when Rancher projects cannot be discovered.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
864
to
+866
| if ! gum spin --show-error --title="Checking ${SERVER}..." rancher project list; then | ||
| yq -i '.Servers["'"${SERVER}"'"].project = ""' "$HOME/.rancher/cli2.json" | ||
| rancher_login "${SERVER}" | ||
| rancher_login "${SERVER}" || warn "Unable to login to ${SERVER}. Skipping." |
| fi | ||
|
|
||
| echo "$RESPONSE" | ||
| printf '%s' "$RESPONSE" |
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.
After using
kopf, annotations containing significant escape characters (\) became present in Rancher Project API responses. Usingechocaused them to be parsed by the shell and slightly unescaped, making them unparseable JSON.This moves to using
printffor all API calls instead ofecho.