-
Notifications
You must be signed in to change notification settings - Fork 28
fix(cli): print registered flags in --help #352
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ddb8df6
fix(cli): print registered flags in --help
gosunuts 1b6e093
fix(cli): document loopback wiring in --help
gosunuts 4ae32f7
fix(cli): keep environment values out of help
gosunuts 2e02cce
test(cli): distinguish secret values from flag names
gosunuts 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
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,74 @@ | ||
| package utils | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestWriteFlagDefaultsListsRegisteredFlags(t *testing.T) { | ||
| ResetEnvRegistry() | ||
| t.Cleanup(ResetEnvRegistry) | ||
| t.Setenv("IDENTITY_PATH", "/private/runtime/identity.json") | ||
| t.Setenv("ADMIN_TOKEN", "admin-token-secret") | ||
| t.Setenv("AWS_SECRET_ACCESS_KEY", "aws-secret-access-key") | ||
|
|
||
| var buf bytes.Buffer | ||
| var identityPath string | ||
| var adminToken string | ||
| var awsSecretAccessKey string | ||
| fs := NewFlagSet("expose", nil) | ||
| StringFlagEnv(fs, &identityPath, "identity-path", "identity.json", "identity json file path", "IDENTITY_PATH") | ||
| StringFlagEnv(fs, &adminToken, "admin-token", "", "admin bearer token", "ADMIN_TOKEN") | ||
| StringFlagEnv(fs, &awsSecretAccessKey, "aws-secret-access-key", "", "AWS secret access key", "AWS_SECRET_ACCESS_KEY") | ||
| if identityPath != "/private/runtime/identity.json" || adminToken != "admin-token-secret" || awsSecretAccessKey != "aws-secret-access-key" { | ||
| t.Fatal("environment values were not resolved into flag targets") | ||
| } | ||
|
|
||
| WriteCommandUsage(&buf, []string{"portal expose [flags] <target>"}, []string{"portal expose 3000"}) | ||
| WriteFlagDefaults(&buf, fs) | ||
|
|
||
| got := buf.String() | ||
| for _, want := range []string{"Usage:", "Examples:", "Flags:", "-identity-path", "identity.json", "IDENTITY_PATH"} { | ||
| if !strings.Contains(got, want) { | ||
| t.Fatalf("help missing %q\n%s", want, got) | ||
| } | ||
| } | ||
| for _, secret := range []string{"/private/runtime/identity.json", "admin-token-secret", "aws-secret-access-key"} { | ||
| if strings.Contains(got, secret) { | ||
| t.Fatalf("help contains environment value %q\n%s", secret, got) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestWriteFlagDefaultsNilIsNoop(t *testing.T) { | ||
| WriteFlagDefaults(nil, nil) | ||
| var buf bytes.Buffer | ||
| WriteFlagDefaults(&buf, nil) | ||
| if buf.Len() != 0 { | ||
| t.Fatalf("nil FlagSet should print nothing, got %q", buf.String()) | ||
| } | ||
| } | ||
|
|
||
| func TestWriteHelpSectionLoopbackAndReady(t *testing.T) { | ||
| var buf bytes.Buffer | ||
| WriteHelpSection(&buf, "Loopback", []string{ | ||
| "portal expose 127.0.0.1:8080 --identity-path /absolute/path/outside/repo/identity.json --relays https://127.0.0.1:4017 --discovery=false", | ||
| }) | ||
| WriteHelpSection(&buf, "Ready", []string{ | ||
| "After portal expose succeeds, it logs a line starting with: service ready at", | ||
| }) | ||
| got := buf.String() | ||
| for _, want := range []string{ | ||
| "Loopback:", | ||
| "--identity-path /absolute/path/outside/repo/identity.json", | ||
| "--relays https://127.0.0.1:4017", | ||
| "--discovery=false", | ||
| "Ready:", | ||
| "service ready at", | ||
| } { | ||
| if !strings.Contains(got, want) { | ||
| t.Fatalf("help missing %q\n%s", want, got) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.