-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Fix PowerShell encoding for Windows environment variable names #3498
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vortsghost2025
wants to merge
1
commit into
wavetermdev:main
Choose a base branch
from
vortsghost2025:contrib/wave-upstream
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+61
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| // Copyright 2025, Command Line Inc. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package shellutil | ||
|
|
||
| import "testing" | ||
|
|
||
| func TestEncodeEnvVarsForPowerShell(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| envName string | ||
| envValue string | ||
| want string | ||
| }{ | ||
| { | ||
| name: "ProgramFiles(x86)", | ||
| envName: "ProgramFiles(x86)", | ||
| envValue: `C:\Program Files (x86)`, | ||
| want: "${env:ProgramFiles(x86)} = \"C:\\Program Files (x86)\"\n", | ||
| }, | ||
| { | ||
| name: "CommonProgramFiles(x86)", | ||
| envName: "CommonProgramFiles(x86)", | ||
| envValue: `C:\Program Files\Common Files (x86)`, | ||
| want: "${env:CommonProgramFiles(x86)} = \"C:\\Program Files\\Common Files (x86)\"\n", | ||
| }, | ||
| { | ||
| name: "PATH", | ||
| envName: "PATH", | ||
| envValue: `C:\Windows\System32`, | ||
| want: "${env:PATH} = \"C:\\Windows\\System32\"\n", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| got, err := EncodeEnvVarsForShell(ShellType_pwsh, map[string]string{tt.envName: tt.envValue}) | ||
| if err != nil { | ||
| t.Fatalf("EncodeEnvVarsForShell() returned error: %v", err) | ||
| } | ||
| if got != tt.want { | ||
| t.Errorf("EncodeEnvVarsForShell() = %q, want %q", got, tt.want) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestEncodeEnvVarsForPowerShellRejectsUnrepresentableNames(t *testing.T) { | ||
| for _, name := range []string{"", "invalid}name"} { | ||
| t.Run(name, func(t *testing.T) { | ||
| if _, err := EncodeEnvVarsForShell(ShellType_pwsh, map[string]string{name: "value"}); err == nil { | ||
| t.Errorf("EncodeEnvVarsForShell() accepted unrepresentable name %q", name) | ||
| } | ||
| }) | ||
| } | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the environment contains an otherwise legal OS variable name with a backtick, such as
FOO\``, this validation accepts it and interpolates the name directly into${env:...}`. The PowerShell variable-name rules identify the backtick as an escape character excluded from braced variable names; in particular, a trailing backtick escapes the generated closing brace, making the token script unparsable and preventing shell initialization. Reject backticks here or escape them correctly before interpolation.Useful? React with 👍 / 👎.