diff --git a/internal/cmd/oidctrust/create.go b/internal/cmd/oidctrust/create.go index 561e37a0..e6d4b251 100644 --- a/internal/cmd/oidctrust/create.go +++ b/internal/cmd/oidctrust/create.go @@ -61,9 +61,9 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command { }, } - cmd.Flags().StringVar(&flags.name, "name", "", "The display name of the trust (required)") - cmd.Flags().StringVar(&flags.provider, "provider", "", "The identity provider; run `pscale oidc-trust providers` to list them (required)") - cmd.Flags().IntVar(&flags.maxTTL, "max-ttl", 0, "The maximum token lifetime in seconds (required)") + cmd.Flags().StringVar(&flags.name, "name", "", "The display name of the trust") + cmd.Flags().StringVar(&flags.provider, "provider", "", "The identity provider; run 'pscale oidc-trust providers' to list them") + cmd.Flags().IntVar(&flags.maxTTL, "max-ttl", 0, "The maximum token lifetime in seconds") cmd.Flags().StringArrayVar(&flags.conditions, "condition", nil, "A claim the token must match, as claim=value; repeatable") cmd.Flags().StringArrayVar(&flags.orgAccesses, "org-access", nil, "An organization access to grant; repeatable") cmd.Flags().StringArrayVar(&flags.databaseAccesses, "database-access", nil, "A database access to grant, as database:access; repeatable") diff --git a/internal/cmd/oidctrust/delete.go b/internal/cmd/oidctrust/delete.go new file mode 100644 index 00000000..6130cdfb --- /dev/null +++ b/internal/cmd/oidctrust/delete.go @@ -0,0 +1,68 @@ +package oidctrust + +import ( + "fmt" + + "github.com/planetscale/cli/internal/cmdutil" + ps "github.com/planetscale/cli/internal/planetscale" + "github.com/planetscale/cli/internal/printer" + "github.com/spf13/cobra" +) + +func DeleteCmd(ch *cmdutil.Helper) *cobra.Command { + var force bool + + cmd := &cobra.Command{ + Use: "delete ", + Short: "Delete an OIDC trust", + Args: cmdutil.RequiredArgs("trust-id"), + RunE: func(cmd *cobra.Command, args []string) error { + id := args[0] + + client, err := ch.Client() + if err != nil { + return err + } + + if !force { + if err := ch.Printer.ConfirmCommand(id, "delete OIDC trust", "OIDC trust deletion"); err != nil { + return err + } + } + + end := ch.Printer.PrintProgress(fmt.Sprintf("Deleting OIDC trust %s", printer.BoldBlue(id))) + defer end() + + err = client.OIDCTrusts.Delete(cmd.Context(), &ps.DeleteOIDCTrustRequest{ + Organization: ch.Config.Organization, + ID: id, + }) + if err != nil { + return notFoundOrHandle(ch, id, err) + } + + end() + + if ch.Printer.Format() == printer.Human { + ch.Printer.Printf("OIDC trust %s was successfully deleted.\n", printer.BoldBlue(id)) + return nil + } + + return ch.Printer.PrintResource(map[string]string{ + "result": "oidc trust deleted", + }) + }, + } + + cmd.Flags().BoolVar(&force, "force", false, "Delete the OIDC trust without confirmation") + + return cmd +} + +func notFoundOrHandle(ch *cmdutil.Helper, id string, err error) error { + if cmdutil.ErrCode(err) == ps.ErrNotFound { + return fmt.Errorf("OIDC trust %s does not exist in organization %s", + printer.BoldBlue(id), printer.BoldBlue(ch.Config.Organization)) + } + return cmdutil.HandleError(err) +} diff --git a/internal/cmd/oidctrust/delete_test.go b/internal/cmd/oidctrust/delete_test.go new file mode 100644 index 00000000..f355f058 --- /dev/null +++ b/internal/cmd/oidctrust/delete_test.go @@ -0,0 +1,35 @@ +package oidctrust + +import ( + "context" + "testing" + + qt "github.com/frankban/quicktest" + "github.com/planetscale/cli/internal/mock" + ps "github.com/planetscale/cli/internal/planetscale" +) + +func TestOIDCTrust_DeleteCmd_RequiresForceInJSON(t *testing.T) { + c := qt.New(t) + + svc := &mock.OIDCTrustsService{} + cmd := DeleteCmd(newUpdateHelper(svc)) + cmd.SetArgs([]string{"trust-1"}) + c.Assert(cmd.Execute(), qt.Not(qt.IsNil)) + c.Assert(svc.DeleteFnInvoked, qt.IsFalse) +} + +func TestOIDCTrust_DeleteCmd_Force(t *testing.T) { + c := qt.New(t) + + svc := &mock.OIDCTrustsService{ + DeleteFn: func(ctx context.Context, req *ps.DeleteOIDCTrustRequest) error { + c.Assert(req.ID, qt.Equals, "trust-1") + return nil + }, + } + cmd := DeleteCmd(newUpdateHelper(svc)) + cmd.SetArgs([]string{"trust-1", "--force"}) + c.Assert(cmd.Execute(), qt.IsNil) + c.Assert(svc.DeleteFnInvoked, qt.IsTrue) +} diff --git a/internal/cmd/oidctrust/oidctrust.go b/internal/cmd/oidctrust/oidctrust.go index 3e069ea3..bee83049 100644 --- a/internal/cmd/oidctrust/oidctrust.go +++ b/internal/cmd/oidctrust/oidctrust.go @@ -23,9 +23,11 @@ func OIDCTrustCmd(ch *cmdutil.Helper) *cobra.Command { cmd.MarkPersistentFlagRequired("org") // nolint:errcheck cmd.AddCommand(CreateCmd(ch)) + cmd.AddCommand(DeleteCmd(ch)) cmd.AddCommand(ListCmd(ch)) cmd.AddCommand(ProvidersCmd(ch)) cmd.AddCommand(ShowCmd(ch)) + cmd.AddCommand(UpdateCmd(ch)) return cmd } @@ -109,3 +111,15 @@ func parseAccesses(orgAccesses, databaseAccesses []string) ([]ps.OIDCTrustAccess } return accesses, nil } + +// nonEmpty drops blank values so that `--flag=` yields an empty list, which +// the update API treats as clearing the list. +func nonEmpty(values []string) []string { + out := make([]string, 0, len(values)) + for _, v := range values { + if v != "" { + out = append(out, v) + } + } + return out +} diff --git a/internal/cmd/oidctrust/update.go b/internal/cmd/oidctrust/update.go new file mode 100644 index 00000000..66b6a9e4 --- /dev/null +++ b/internal/cmd/oidctrust/update.go @@ -0,0 +1,94 @@ +package oidctrust + +import ( + "fmt" + + "github.com/planetscale/cli/internal/cmdutil" + ps "github.com/planetscale/cli/internal/planetscale" + "github.com/planetscale/cli/internal/printer" + "github.com/spf13/cobra" +) + +func UpdateCmd(ch *cmdutil.Helper) *cobra.Command { + var flags struct { + name string + maxTTL int + conditions []string + orgAccesses []string + databaseAccesses []string + allDatabasesAccesses []string + } + + cmd := &cobra.Command{ + Use: "update ", + Short: "Update an OIDC trust", + Args: cmdutil.RequiredArgs("trust-id"), + RunE: func(cmd *cobra.Command, args []string) error { + id := args[0] + f := cmd.Flags() + + req := &ps.UpdateOIDCTrustRequest{Organization: ch.Config.Organization, ID: id} + changed := false + + if f.Changed("name") { + req.DisplayName = &flags.name + changed = true + } + if f.Changed("max-ttl") { + req.MaxTTLSeconds = &flags.maxTTL + changed = true + } + if f.Changed("condition") { + conditions, err := parseConditions(nonEmpty(flags.conditions)) + if err != nil { + return err + } + req.Conditions = &conditions + changed = true + } + if f.Changed("org-access") || f.Changed("database-access") { + accesses, err := parseAccesses(nonEmpty(flags.orgAccesses), nonEmpty(flags.databaseAccesses)) + if err != nil { + return err + } + req.Accesses = &accesses + changed = true + } + if f.Changed("all-databases-access") { + bulk := nonEmpty(flags.allDatabasesAccesses) + req.BulkDatabaseAccesses = &bulk + changed = true + } + + if !changed { + return fmt.Errorf("at least one of --name, --max-ttl, --condition, --org-access, --database-access, or --all-databases-access must be provided") + } + + client, err := ch.Client() + if err != nil { + return err + } + + end := ch.Printer.PrintProgress(fmt.Sprintf("Updating OIDC trust %s", printer.BoldBlue(id))) + defer end() + + trust, err := client.OIDCTrusts.Update(cmd.Context(), req) + if err != nil { + return notFoundOrHandle(ch, id, err) + } + + end() + + return ch.Printer.PrintResource(toOIDCTrust(trust)) + }, + } + + cmd.Flags().StringVar(&flags.name, "name", "", "The display name of the trust") + cmd.Flags().IntVar(&flags.maxTTL, "max-ttl", 0, "The maximum token lifetime in seconds") + cmd.Flags().StringArrayVar(&flags.conditions, "condition", nil, "A claim the token must match, as claim=value; repeatable; replaces all conditions") + cmd.Flags().StringArrayVar(&flags.orgAccesses, "org-access", nil, "An organization access to grant; repeatable; replaces all org and database accesses") + cmd.Flags().StringArrayVar(&flags.databaseAccesses, "database-access", nil, "A database access to grant, as database:access; repeatable; replaces all org and database accesses") + cmd.Flags().StringArrayVar(&flags.allDatabasesAccesses, "all-databases-access", nil, "An access to grant on all databases; repeatable; replaces all all-databases accesses") + + return cmd +} diff --git a/internal/cmd/oidctrust/update_test.go b/internal/cmd/oidctrust/update_test.go new file mode 100644 index 00000000..3622f271 --- /dev/null +++ b/internal/cmd/oidctrust/update_test.go @@ -0,0 +1,75 @@ +package oidctrust + +import ( + "bytes" + "context" + "testing" + + qt "github.com/frankban/quicktest" + "github.com/planetscale/cli/internal/cmdutil" + "github.com/planetscale/cli/internal/config" + "github.com/planetscale/cli/internal/mock" + ps "github.com/planetscale/cli/internal/planetscale" + "github.com/planetscale/cli/internal/printer" +) + +func newUpdateHelper(svc *mock.OIDCTrustsService) *cmdutil.Helper { + var buf bytes.Buffer + format := printer.JSON + p := printer.NewPrinter(&format) + p.SetResourceOutput(&buf) + return &cmdutil.Helper{ + Printer: p, + Config: &config.Config{Organization: "planetscale"}, + Client: func() (*ps.Client, error) { return &ps.Client{OIDCTrusts: svc}, nil }, + } +} + +func TestOIDCTrust_UpdateCmd_OnlySendsChangedFields(t *testing.T) { + c := qt.New(t) + + svc := &mock.OIDCTrustsService{ + UpdateFn: func(ctx context.Context, req *ps.UpdateOIDCTrustRequest) (*ps.OIDCTrust, error) { + c.Assert(req.ID, qt.Equals, "trust-1") + c.Assert(req.Accesses, qt.DeepEquals, &[]ps.OIDCTrustAccessInput{{Access: "create_databases"}}) + c.Assert(req.Conditions, qt.IsNil) + c.Assert(req.BulkDatabaseAccesses, qt.IsNil) + c.Assert(req.DisplayName, qt.IsNil) + c.Assert(req.MaxTTLSeconds, qt.IsNil) + return &ps.OIDCTrust{ID: "trust-1"}, nil + }, + } + + cmd := UpdateCmd(newUpdateHelper(svc)) + cmd.SetArgs([]string{"trust-1", "--org-access", "create_databases"}) + c.Assert(cmd.Execute(), qt.IsNil) + c.Assert(svc.UpdateFnInvoked, qt.IsTrue) +} + +func TestOIDCTrust_UpdateCmd_NoFlags(t *testing.T) { + c := qt.New(t) + + svc := &mock.OIDCTrustsService{} + cmd := UpdateCmd(newUpdateHelper(svc)) + cmd.SetArgs([]string{"trust-1"}) + c.Assert(cmd.Execute(), qt.ErrorMatches, `at least one of --name.*must be provided`) + c.Assert(svc.UpdateFnInvoked, qt.IsFalse) +} + +func TestOIDCTrust_UpdateCmd_EmptyFlagsClearLists(t *testing.T) { + c := qt.New(t) + + svc := &mock.OIDCTrustsService{ + UpdateFn: func(ctx context.Context, req *ps.UpdateOIDCTrustRequest) (*ps.OIDCTrust, error) { + c.Assert(req.Conditions, qt.DeepEquals, &[]ps.OIDCTrustConditionInput{}) + c.Assert(req.Accesses, qt.DeepEquals, &[]ps.OIDCTrustAccessInput{}) + c.Assert(req.BulkDatabaseAccesses, qt.DeepEquals, &[]string{}) + return &ps.OIDCTrust{ID: "trust-1"}, nil + }, + } + + cmd := UpdateCmd(newUpdateHelper(svc)) + cmd.SetArgs([]string{"trust-1", "--condition=", "--org-access=", "--database-access=", "--all-databases-access="}) + c.Assert(cmd.Execute(), qt.IsNil) + c.Assert(svc.UpdateFnInvoked, qt.IsTrue) +} diff --git a/internal/mock/oidc_trust.go b/internal/mock/oidc_trust.go index 5c73617c..d9ec1d92 100644 --- a/internal/mock/oidc_trust.go +++ b/internal/mock/oidc_trust.go @@ -18,6 +18,12 @@ type OIDCTrustsService struct { CreateFn func(context.Context, *ps.CreateOIDCTrustRequest) (*ps.OIDCTrust, error) CreateFnInvoked bool + + UpdateFn func(context.Context, *ps.UpdateOIDCTrustRequest) (*ps.OIDCTrust, error) + UpdateFnInvoked bool + + DeleteFn func(context.Context, *ps.DeleteOIDCTrustRequest) error + DeleteFnInvoked bool } func (s *OIDCTrustsService) ListProviders(ctx context.Context, req *ps.ListOIDCTrustProvidersRequest) ([]*ps.OIDCTrustProvider, error) { @@ -39,3 +45,13 @@ func (s *OIDCTrustsService) Create(ctx context.Context, req *ps.CreateOIDCTrustR s.CreateFnInvoked = true return s.CreateFn(ctx, req) } + +func (s *OIDCTrustsService) Update(ctx context.Context, req *ps.UpdateOIDCTrustRequest) (*ps.OIDCTrust, error) { + s.UpdateFnInvoked = true + return s.UpdateFn(ctx, req) +} + +func (s *OIDCTrustsService) Delete(ctx context.Context, req *ps.DeleteOIDCTrustRequest) error { + s.DeleteFnInvoked = true + return s.DeleteFn(ctx, req) +} diff --git a/internal/planetscale/oidc_trusts.go b/internal/planetscale/oidc_trusts.go index 05a2a3c5..f01af752 100644 --- a/internal/planetscale/oidc_trusts.go +++ b/internal/planetscale/oidc_trusts.go @@ -16,6 +16,8 @@ type OIDCTrustsService interface { List(context.Context, *ListOIDCTrustsRequest, ...ListOption) ([]*OIDCTrust, error) Get(context.Context, *GetOIDCTrustRequest) (*OIDCTrust, error) Create(context.Context, *CreateOIDCTrustRequest) (*OIDCTrust, error) + Update(context.Context, *UpdateOIDCTrustRequest) (*OIDCTrust, error) + Delete(context.Context, *DeleteOIDCTrustRequest) error } // OIDCTrust represents a trust between an organization and an identity provider. @@ -185,3 +187,44 @@ func (s *oidcTrustsService) Create(ctx context.Context, createReq *CreateOIDCTru return trust, nil } + +// UpdateOIDCTrustRequest is the request for updating an OIDC trust. Pointer +// fields that are nil are not sent; a sent list replaces the existing list. +type UpdateOIDCTrustRequest struct { + Organization string `json:"-"` + ID string `json:"-"` + DisplayName *string `json:"display_name,omitempty"` + MaxTTLSeconds *int `json:"max_ttl_seconds,omitempty"` + Conditions *[]OIDCTrustConditionInput `json:"conditions,omitempty"` + Accesses *[]OIDCTrustAccessInput `json:"accesses,omitempty"` + BulkDatabaseAccesses *[]string `json:"bulk_database_accesses,omitempty"` +} + +// DeleteOIDCTrustRequest is the request for deleting an OIDC trust. +type DeleteOIDCTrustRequest struct { + Organization string `json:"-"` + ID string `json:"-"` +} + +func (s *oidcTrustsService) Update(ctx context.Context, updateReq *UpdateOIDCTrustRequest) (*OIDCTrust, error) { + req, err := s.client.newRequest(http.MethodPatch, oidcTrustAPIPath(updateReq.Organization, updateReq.ID), updateReq) + if err != nil { + return nil, err + } + + trust := &OIDCTrust{} + if err := s.client.do(ctx, req, &trust); err != nil { + return nil, err + } + + return trust, nil +} + +func (s *oidcTrustsService) Delete(ctx context.Context, deleteReq *DeleteOIDCTrustRequest) error { + req, err := s.client.newRequest(http.MethodDelete, oidcTrustAPIPath(deleteReq.Organization, deleteReq.ID), nil) + if err != nil { + return err + } + + return s.client.do(ctx, req, nil) +}