-
Notifications
You must be signed in to change notification settings - Fork 13
feat: Add support for generic oidc accounts #455
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
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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,213 @@ | ||
| package create | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "github.com/AlecAivazis/survey/v2" | ||
| "github.com/MakeNowJust/heredoc/v2" | ||
| "github.com/OctopusDeploy/cli/pkg/cmd" | ||
| "github.com/OctopusDeploy/cli/pkg/cmd/account/helper" | ||
| "github.com/OctopusDeploy/cli/pkg/constants" | ||
| "github.com/OctopusDeploy/cli/pkg/factory" | ||
| "github.com/OctopusDeploy/cli/pkg/output" | ||
| "github.com/OctopusDeploy/cli/pkg/question" | ||
| "github.com/OctopusDeploy/cli/pkg/question/selectors" | ||
| "github.com/OctopusDeploy/cli/pkg/surveyext" | ||
| "github.com/OctopusDeploy/cli/pkg/util" | ||
| "github.com/OctopusDeploy/cli/pkg/util/flag" | ||
| "github.com/OctopusDeploy/cli/pkg/validation" | ||
| "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/accounts" | ||
| "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" | ||
| "github.com/spf13/cobra" | ||
| "os" | ||
| ) | ||
|
|
||
| type CreateFlags struct { | ||
| Name *flag.Flag[string] | ||
| Description *flag.Flag[string] | ||
| Environments *flag.Flag[[]string] | ||
| ExecutionSubjectKeys *flag.Flag[[]string] | ||
| Audience *flag.Flag[string] | ||
| } | ||
|
|
||
| type CreateOptions struct { | ||
| *CreateFlags | ||
| *cmd.Dependencies | ||
| selectors.GetAllEnvironmentsCallback | ||
| } | ||
|
|
||
| func NewCreateFlags() *CreateFlags { | ||
| return &CreateFlags{ | ||
| Name: flag.New[string]("name", false), | ||
| Description: flag.New[string]("description", false), | ||
| Environments: flag.New[[]string]("environment", false), | ||
| ExecutionSubjectKeys: flag.New[[]string]("execution-subject-keys", false), | ||
| Audience: flag.New[string]("audience", false), | ||
| } | ||
| } | ||
|
|
||
| func NewCreateOptions(flags *CreateFlags, dependencies *cmd.Dependencies) *CreateOptions { | ||
| return &CreateOptions{ | ||
| CreateFlags: flags, | ||
| Dependencies: dependencies, | ||
| GetAllEnvironmentsCallback: func() ([]*environments.Environment, error) { | ||
| return selectors.GetAllEnvironments(dependencies.Client) | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func NewCmdCreate(f factory.Factory) *cobra.Command { | ||
| createFlags := NewCreateFlags() | ||
| descriptionFilePath := "" | ||
|
|
||
| cmd := &cobra.Command{ | ||
| Use: "create", | ||
| Short: "Create an Generic OpenID Connect account", | ||
| Long: "Create an Generic OpenID Connect account in Octopus Deploy", | ||
| Example: heredoc.Docf("$ %s account generic-oidc create", constants.ExecutableName), | ||
| Aliases: []string{"new"}, | ||
| RunE: func(c *cobra.Command, _ []string) error { | ||
| opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c)) | ||
| if descriptionFilePath != "" { | ||
| if err := validation.IsExistingFile(descriptionFilePath); err != nil { | ||
| return err | ||
| } | ||
| data, err := os.ReadFile(descriptionFilePath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| opts.Description.Value = string(data) | ||
| } | ||
| opts.NoPrompt = !f.IsPromptEnabled() | ||
|
|
||
| if opts.Environments.Value != nil { | ||
| env, err := helper.ResolveEnvironmentNames(opts.Environments.Value, opts.Client) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| opts.Environments.Value = env | ||
| } | ||
| return CreateRun(opts) | ||
| }, | ||
| } | ||
|
|
||
| flags := cmd.Flags() | ||
| flags.StringVarP(&createFlags.Name.Value, createFlags.Name.Name, "n", "", "A short, memorable, unique name for this account.") | ||
| flags.StringVarP(&createFlags.Description.Value, createFlags.Description.Value, "d", "", "A summary explaining the use of the account to other users.") | ||
| flags.StringArrayVarP(&createFlags.Environments.Value, createFlags.Environments.Name, "e", nil, "The environments that are allowed to use this account") | ||
| flags.StringArrayVarP(&createFlags.ExecutionSubjectKeys.Value, createFlags.ExecutionSubjectKeys.Name, "E", nil, "The subject keys used for a deployment or runbook") | ||
| flags.StringVar(&createFlags.Audience.Value, createFlags.Audience.Name, "", "The audience claim for the federated credentials. Defaults to api://default") | ||
| flags.StringVarP(&descriptionFilePath, "description-file", "D", "", "Read the description from `file`") | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func CreateRun(opts *CreateOptions) error { | ||
| if !opts.NoPrompt { | ||
| if err := PromptMissing(opts); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| var createdAccount accounts.IAccount | ||
| oidcAccount, err := accounts.NewGenericOIDCAccount( | ||
| opts.Name.Value, | ||
| ) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| oidcAccount.DeploymentSubjectKeys = opts.ExecutionSubjectKeys.Value | ||
| oidcAccount.Audience = opts.Audience.Value | ||
| oidcAccount.Description = opts.Description.Value | ||
|
|
||
| createdAccount, err = opts.Client.Accounts.Add(oidcAccount) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| _, err = fmt.Fprintf(opts.Out, "Successfully created Generic account %s %s.\n", createdAccount.GetName(), output.Dimf("(%s)", createdAccount.GetSlug())) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| link := output.Bluef("%s/app#/%s/infrastructure/accounts/%s", opts.Host, opts.Space.GetID(), createdAccount.GetID()) | ||
| fmt.Fprintf(opts.Out, "\nView this account on Octopus Deploy: %s\n", link) | ||
| if !opts.NoPrompt { | ||
| autoCmd := flag.GenerateAutomationCmd( | ||
| opts.CmdPath, | ||
| opts.Name, | ||
| opts.Description, | ||
| opts.Environments, | ||
| opts.ExecutionSubjectKeys, | ||
| opts.Audience, | ||
| ) | ||
| fmt.Fprintf(opts.Out, "\nAutomation Command: %s\n", autoCmd) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func PromptMissing(opts *CreateOptions) error { | ||
| if opts.Name.Value == "" { | ||
| if err := opts.Ask(&survey.Input{ | ||
| Message: "Name", | ||
| Help: "A short, memorable, unique name for this account.", | ||
| }, &opts.Name.Value, survey.WithValidator(survey.ComposeValidators( | ||
| survey.MaxLength(200), | ||
| survey.MinLength(1), | ||
| survey.Required, | ||
| ))); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| if opts.Description.Value == "" { | ||
| if err := opts.Ask(&surveyext.OctoEditor{ | ||
| Editor: &survey.Editor{ | ||
| Message: "Description", | ||
| Help: "A summary explaining the use of the account to other users.", | ||
| FileName: "*.md", | ||
| }, | ||
| Optional: true, | ||
| }, &opts.Description.Value); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| var err error | ||
| if len(opts.ExecutionSubjectKeys.Value) == 0 { | ||
| opts.ExecutionSubjectKeys.Value, err = promptSubjectKeys(opts.Ask, "Deployment and Runbook subject keys", []string{"space", "environment", "project", "tenant", "runbook", "account", "type"}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| if opts.Audience.Value == "" { | ||
| if err := opts.Ask(&survey.Input{ | ||
| Message: "Audience", | ||
| Default: "api://default", | ||
| Help: "Set this if you need to override the default Audience value.", | ||
| }, &opts.Audience.Value); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| if opts.Environments.Value == nil { | ||
| envs, err := selectors.EnvironmentsMultiSelect(opts.Ask, opts.GetAllEnvironmentsCallback, | ||
| "Choose the environments that are allowed to use this account.\n"+ | ||
| output.Dim("If nothing is selected, the account can be used for deployments to any environment."), false) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| opts.Environments.Value = util.SliceTransform(envs, func(e *environments.Environment) string { return e.ID }) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func promptSubjectKeys(ask question.Asker, message string, opts []string) ([]string, error) { | ||
| keys, err := question.MultiSelectMap(ask, message, opts, func(item string) string { return item }, false) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if len(keys) > 0 { | ||
| return keys, nil | ||
| } | ||
|
|
||
| return nil, nil | ||
| } | ||
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,58 @@ | ||
| package create_test | ||
|
|
||
| import ( | ||
| "github.com/OctopusDeploy/cli/pkg/cmd" | ||
| "github.com/OctopusDeploy/cli/test/fixtures" | ||
| "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments" | ||
| "github.com/stretchr/testify/assert" | ||
| "testing" | ||
|
|
||
| "github.com/OctopusDeploy/cli/pkg/cmd/account/generic-oidc/create" | ||
| "github.com/OctopusDeploy/cli/test/testutil" | ||
| ) | ||
|
|
||
| func TestPromptMissing_AllOptionsSupplied(t *testing.T) { | ||
| pa := []*testutil.PA{} | ||
|
|
||
| asker, checkRemainingPrompts := testutil.NewMockAsker(t, pa) | ||
| flags := create.NewCreateFlags() | ||
| flags.Name.Value = "The Final Frontier" | ||
| flags.Description.Value = "Where no person has gone before" | ||
| flags.ExecutionSubjectKeys.Value = []string{"space"} | ||
| flags.Audience.Value = "custom audience" | ||
| flags.Environments.Value = []string{"dev"} | ||
|
|
||
| opts := &create.CreateOptions{ | ||
| CreateFlags: flags, | ||
| Dependencies: &cmd.Dependencies{Ask: asker}, | ||
| } | ||
| _ = create.PromptMissing(opts) | ||
| checkRemainingPrompts() | ||
| } | ||
|
|
||
| func TestPromptMissing_NoOptionsSupplied(t *testing.T) { | ||
| pa := []*testutil.PA{ | ||
| testutil.NewInputPrompt("Name", "A short, memorable, unique name for this account.", "oidc account"), | ||
| testutil.NewMultiSelectPrompt("Deployment and Runbook subject keys", "", []string{"space", "environment", "project", "tenant", "runbook", "account", "type"}, []string{"space", "type"}), | ||
| testutil.NewInputPromptWithDefault("Audience", "Set this if you need to override the default Audience value.", "api://default", "custom audience"), | ||
| testutil.NewMultiSelectPrompt("Choose the environments that are allowed to use this account.\nIf nothing is selected, the account can be used for deployments to any environment.", "", []string{"testenv"}, []string{"testenv"}), | ||
| } | ||
|
|
||
| asker, checkRemainingPrompts := testutil.NewMockAsker(t, pa) | ||
| flags := create.NewCreateFlags() | ||
| flags.Description.Value = "the description" // this is due the input mocking not support OctoEditor | ||
|
|
||
| opts := &create.CreateOptions{ | ||
| CreateFlags: flags, | ||
| Dependencies: &cmd.Dependencies{Ask: asker}, | ||
| GetAllEnvironmentsCallback: func() ([]*environments.Environment, error) { | ||
| return []*environments.Environment{fixtures.NewEnvironment("Spaces-1", "Environments-1", "testenv")}, nil | ||
| }, | ||
| } | ||
| _ = create.PromptMissing(opts) | ||
|
|
||
| assert.Equal(t, "oidc account", flags.Name.Value) | ||
| assert.Equal(t, "custom audience", flags.Audience.Value) | ||
| assert.Equal(t, []string{"Environments-1"}, flags.Environments.Value) | ||
| checkRemainingPrompts() | ||
| } |
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,24 @@ | ||
| package generic_oidc | ||
|
|
||
| import ( | ||
| "github.com/MakeNowJust/heredoc/v2" | ||
| cmdCreate "github.com/OctopusDeploy/cli/pkg/cmd/account/generic-oidc/create" | ||
| cmdList "github.com/OctopusDeploy/cli/pkg/cmd/account/generic-oidc/list" | ||
| "github.com/OctopusDeploy/cli/pkg/constants" | ||
| "github.com/OctopusDeploy/cli/pkg/factory" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func NewCmdGenericOidc(f factory.Factory) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "generic-oidc <command>", | ||
| Short: "Manage Generic OpenID Connect accounts", | ||
| Long: "Manage Generic OpenID Connect accounts in Octopus Deploy", | ||
| Example: heredoc.Docf("$ %s account generic-oidc list", constants.ExecutableName), | ||
| } | ||
|
|
||
| cmd.AddCommand(cmdList.NewCmdList(f)) | ||
| cmd.AddCommand(cmdCreate.NewCmdCreate(f)) | ||
|
|
||
| return cmd | ||
| } |
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.
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.
Looks like
Audienceis missing from the automation command output