-
Notifications
You must be signed in to change notification settings - Fork 2
feat: PR2 — target resolution seam (openshell.ResolveTarget) #95
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 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
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,26 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/stackrox/harness-openshell/internal/openshell" | ||
| ) | ||
|
|
||
| // registerTargetFlags adds the standard --gateway/--workspace flags to cmd and | ||
| // returns pointers to their values. Every SDK-backed command registers its | ||
| // target flags through this one helper so the flag names, help text, and the | ||
| // OPENSHELL_* env fallbacks stay identical across commands. The flags are | ||
| // per-command (not root-persistent) so legacy CLI-path commands never carry | ||
| // them. | ||
| // | ||
| // The returned pointers are meant to be fed to openshell.ResolveTarget together | ||
| // with os.Getenv; resolution (flag > env > empty) and the workspace default live | ||
| // there and in sdkclient, not here. | ||
| func registerTargetFlags(cmd *cobra.Command) (gateway, workspace *string) { | ||
| gateway = cmd.Flags().String("gateway", "", | ||
| fmt.Sprintf("OpenShell gateway registration name (falls back to $%s).", openshell.EnvGateway)) | ||
| workspace = cmd.Flags().String("workspace", "", | ||
| fmt.Sprintf("OpenShell workspace (defaults to %q; falls back to $%s).", "default", openshell.EnvWorkspace)) | ||
| return gateway, workspace | ||
| } |
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,36 @@ | ||
| package openshell | ||
|
|
||
| // Environment variables consulted by ResolveTarget, in the repo's standard | ||
| // flag-resolution order (AGENTS.md: explicit flag > OPENSHELL_* env var > | ||
| // default). Exported so cmd help text and tests can name them without | ||
| // re-declaring the strings. | ||
| const ( | ||
| EnvGateway = "OPENSHELL_GATEWAY" | ||
| EnvWorkspace = "OPENSHELL_WORKSPACE" | ||
| ) | ||
|
|
||
| // ResolveTarget builds a Target from explicit flag values and the environment, | ||
| // applying flag > env > empty for each field independently. | ||
| // | ||
| // It does NOT default the workspace: an unset workspace stays "" and sdkclient | ||
| // maps "" -> "default" at construction (the single owner of that default). An | ||
| // empty Gateway is likewise left empty — a caller decision (e.g. doctor skips | ||
| // its online checks), never a silent fallback to the CLI's active gateway. | ||
| // | ||
| // Resolution is pure: getenv is injected (production passes os.Getenv, tests | ||
| // pass a map closure) so this package imports neither os nor any CLI framework. | ||
| func ResolveTarget(flagGateway, flagWorkspace string, getenv func(string) string) Target { | ||
| return Target{ | ||
| Gateway: resolveField(flagGateway, EnvGateway, getenv), | ||
| Workspace: resolveField(flagWorkspace, EnvWorkspace, getenv), | ||
| } | ||
| } | ||
|
|
||
| // resolveField applies flag > env > empty for one field. An empty flag value is | ||
| // treated as unset so the env var can take effect. | ||
| func resolveField(flagVal, envKey string, getenv func(string) string) string { | ||
| if flagVal != "" { | ||
| return flagVal | ||
| } | ||
| return getenv(envKey) | ||
| } | ||
Oops, something went wrong.
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.