[envsec] Add List function to envsec library #252
Merged
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
savil
approved these changes
Jan 8, 2024
| } | ||
|
|
||
| return envsec.PrintEnvVars( | ||
| vars, cmd.OutOrStdout(), flags.ShowValues, flags.Format) |
There was a problem hiding this comment.
unrelated to this PR:
I just noticed that the help message for --format isn't completely helpful. It could specify what the valid options are Display the key values in key=value format. Must be one of: table | dotenv | json".
envsec/pkg/envsec/list.go
Outdated
Comment on lines
22
to
37
| project, err := e.ProjectConfig() | ||
| if project == nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| authClient, err := e.authClient() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| tok, err := authClient.LoginFlowIfNeededForOrg(ctx, project.OrgID.String()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| store.Identify(ctx, e, tok) |
There was a problem hiding this comment.
this seems repeated from the envsec.SetStore code above. Is it needed?
| // A string that uniquely identifies the organization to which the environment belongs. | ||
| OrgID string | ||
| // A name that uniquely identifies the environment within the project. | ||
| // Usually one of: 'dev', 'prod'. |
| @@ -30,14 +32,18 @@ func newSSMStore(ctx context.Context, config *SSMConfig) (*SSMStore, error) { | |||
| return store, nil | |||
| } | |||
|
|
|||
| func (s *SSMStore) List(ctx context.Context, envID EnvID) ([]EnvVar, error) { | |||
| func (s *SSMStore) Identify(context.Context, *envsec.Envsec, *session.Token) { | |||
| // TODO: implement | |||
There was a problem hiding this comment.
maybe add a panic("TODO: implement SSMStore.Identify") ?
There was a problem hiding this comment.
I don't really want it to panic since it does identity in a different way (via standard AWS credential chain). If we make it panic here it will break.
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.
Summary
This adds a
ListandPrintEnvVarsfunctions to the envsec library. It allows a 3rd party (e.g. devbox) app to use envsec functionality more easily.I refactored stores as much as I could to make this easy to use, but it's still a bit tangled. Specifically, the envsec package uses the jetpack API internally a bunch. In theory, we could make most of these functions part of the
store. That way other stores can implement their owninitorwhoamispecifics depending on their capabilities. This is left for later.Once this is merged, devbox will be able to:
envsec.Listin order to fetch secrets (instead of the current implementation which calls the envsec CLI).devbox secrets listcommand that fetches and prints secrets.How was it tested?