From c4eba6f7b639f72d8c0fee6b2db942483d6b85f6 Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Thu, 12 Nov 2026 13:30:08 -0500 Subject: [PATCH 1/2] Add `oidc-trust providers show` with provider claims --- internal/cmd/oidctrust/create.go | 2 +- internal/cmd/oidctrust/providers.go | 137 ++++++++++++++++++----- internal/cmd/oidctrust/providers_test.go | 70 ++++++++++-- internal/planetscale/oidc_trusts.go | 16 ++- 4 files changed, 186 insertions(+), 39 deletions(-) diff --git a/internal/cmd/oidctrust/create.go b/internal/cmd/oidctrust/create.go index e6d4b251..1dbb3163 100644 --- a/internal/cmd/oidctrust/create.go +++ b/internal/cmd/oidctrust/create.go @@ -62,7 +62,7 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command { } 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().StringVar(&flags.provider, "provider", "", "The identity provider; run 'pscale oidc-trust providers list' 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") diff --git a/internal/cmd/oidctrust/providers.go b/internal/cmd/oidctrust/providers.go index ed4ff061..6707e002 100644 --- a/internal/cmd/oidctrust/providers.go +++ b/internal/cmd/oidctrust/providers.go @@ -19,49 +19,132 @@ type Provider struct { RequiredClaims string `header:"required claims" json:"required_claims"` } +// ProviderClaim is a table serializable claim of one OIDC trust provider. +type ProviderClaim struct { + Name string `header:"claim" json:"name"` + Required bool `header:"required" json:"required"` + Description string `header:"description" json:"description"` +} + +func toProvider(p *planetscale.OIDCTrustProvider) *Provider { + return &Provider{ + Name: p.Name, + DisplayName: p.DisplayName, + Issuer: p.Issuer, + RequiredClaims: strings.Join(p.RequiredClaims, ", "), + } +} + +// ProvidersCmd encapsulates the commands for OIDC trust providers. Running it +// without a subcommand lists providers, as it did before it had subcommands. func ProvidersCmd(ch *cmdutil.Helper) *cobra.Command { - return &cobra.Command{ - Use: "providers", - Short: "List OIDC trust providers", + list := ProvidersListCmd(ch) + + cmd := &cobra.Command{ + Use: "providers ", + Short: "List and show OIDC trust providers", Args: cobra.NoArgs, + RunE: list.RunE, + } + + cmd.AddCommand(list) + cmd.AddCommand(ProvidersShowCmd(ch)) + + return cmd +} + +func ProvidersListCmd(ch *cmdutil.Helper) *cobra.Command { + return &cobra.Command{ + Use: "list", + Short: "List OIDC trust providers", + Aliases: []string{"ls"}, + Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { - client, err := ch.Client() + providers, err := listProviders(cmd, ch) if err != nil { return err } - end := ch.Printer.PrintProgress(fmt.Sprintf("Fetching OIDC trust providers for %s", printer.BoldBlue(ch.Config.Organization))) - defer end() + if ch.Printer.Format() == printer.JSON { + return ch.Printer.PrintJSON(providers) + } + + results := make([]*Provider, 0, len(providers)) + for _, p := range providers { + results = append(results, toProvider(p)) + } + return ch.Printer.PrintResource(results) + }, + } +} - providers, err := client.OIDCTrusts.ListProviders(cmd.Context(), &planetscale.ListOIDCTrustProvidersRequest{ - Organization: ch.Config.Organization, - }) +func ProvidersShowCmd(ch *cmdutil.Helper) *cobra.Command { + return &cobra.Command{ + Use: "show ", + Short: "Show an OIDC trust provider and the claims in its tokens", + Args: cmdutil.RequiredArgs("name"), + RunE: func(cmd *cobra.Command, args []string) error { + name := args[0] + + providers, err := listProviders(cmd, ch) if err != nil { - switch cmdutil.ErrCode(err) { - case planetscale.ErrNotFound: - return fmt.Errorf("organization %s does not exist or does not have OIDC trusts enabled", - printer.BoldBlue(ch.Config.Organization)) - default: - return cmdutil.HandleError(err) - } + return err } - end() + var provider *planetscale.OIDCTrustProvider + for _, p := range providers { + if p.Name == name { + provider = p + break + } + } + if provider == nil { + return fmt.Errorf("OIDC trust provider %s is not available in organization %s", + printer.BoldBlue(name), printer.BoldBlue(ch.Config.Organization)) + } if ch.Printer.Format() == printer.JSON { - return ch.Printer.PrintJSON(providers) + return ch.Printer.PrintJSON(provider) } - results := make([]*Provider, 0, len(providers)) - for _, p := range providers { - results = append(results, &Provider{ - Name: p.Name, - DisplayName: p.DisplayName, - Issuer: p.Issuer, - RequiredClaims: strings.Join(p.RequiredClaims, ", "), - }) + if err := ch.Printer.PrintResource(toProvider(provider)); err != nil { + return err } - return ch.Printer.PrintResource(results) + + if ch.Printer.Format() != printer.Human || len(provider.Claims) == 0 { + return nil + } + + claims := make([]*ProviderClaim, 0, len(provider.Claims)) + for _, c := range provider.Claims { + claims = append(claims, &ProviderClaim{Name: c.Name, Required: c.Required, Description: c.Description}) + } + return ch.Printer.PrintResource(claims) }, } } + +func listProviders(cmd *cobra.Command, ch *cmdutil.Helper) ([]*planetscale.OIDCTrustProvider, error) { + client, err := ch.Client() + if err != nil { + return nil, err + } + + end := ch.Printer.PrintProgress(fmt.Sprintf("Fetching OIDC trust providers for %s", printer.BoldBlue(ch.Config.Organization))) + defer end() + + providers, err := client.OIDCTrusts.ListProviders(cmd.Context(), &planetscale.ListOIDCTrustProvidersRequest{ + Organization: ch.Config.Organization, + }) + if err != nil { + switch cmdutil.ErrCode(err) { + case planetscale.ErrNotFound: + return nil, fmt.Errorf("organization %s does not exist or does not have OIDC trusts enabled", + printer.BoldBlue(ch.Config.Organization)) + default: + return nil, cmdutil.HandleError(err) + } + } + + return providers, nil +} diff --git a/internal/cmd/oidctrust/providers_test.go b/internal/cmd/oidctrust/providers_test.go index f80bb0da..47fc135a 100644 --- a/internal/cmd/oidctrust/providers_test.go +++ b/internal/cmd/oidctrust/providers_test.go @@ -51,18 +51,74 @@ func TestOIDCTrust_ProvidersCmd(t *testing.T) { }, } - cmd := ProvidersCmd(ch) - cmd.SetArgs([]string{}) - err := cmd.Execute() - - c.Assert(err, qt.IsNil) - c.Assert(svc.ListProvidersFnInvoked, qt.IsTrue) - c.Assert(buf.String(), qt.JSONEquals, []map[string]any{ + want := []map[string]any{ { "name": "github", "display_name": "GitHub Actions", "issuer": "https://token.actions.githubusercontent.com", "required_claims": []string{"repository", "ref"}, + "claims": nil, + }, + } + + for _, args := range [][]string{{"list"}, {}} { + buf.Reset() + cmd := ProvidersCmd(ch) + cmd.SetArgs(args) + c.Assert(cmd.Execute(), qt.IsNil, qt.Commentf("args: %v", args)) + c.Assert(buf.String(), qt.JSONEquals, want, qt.Commentf("args: %v", args)) + } + c.Assert(svc.ListProvidersFnInvoked, qt.IsTrue) +} + +func TestOIDCTrust_ProvidersShowCmd(t *testing.T) { + c := qt.New(t) + + var buf bytes.Buffer + format := printer.JSON + p := printer.NewPrinter(&format) + p.SetResourceOutput(&buf) + + svc := &mock.OIDCTrustsService{ + ListProvidersFn: func(ctx context.Context, req *ps.ListOIDCTrustProvidersRequest) ([]*ps.OIDCTrustProvider, error) { + return []*ps.OIDCTrustProvider{ + {Name: "github"}, + { + Name: "cursor", + DisplayName: "Cursor", + Issuer: "https://cursor.com", + RequiredClaims: []string{"team_id"}, + Claims: []ps.OIDCTrustProviderClaim{ + {Name: "team_id", Required: true, Description: "Cursor team"}, + {Name: "email", Description: "User email"}, + }, + }, + }, nil + }, + } + ch := &cmdutil.Helper{ + Printer: p, + Config: &config.Config{Organization: "planetscale"}, + Client: func() (*ps.Client, error) { + return &ps.Client{OIDCTrusts: svc}, nil + }, + } + + cmd := ProvidersCmd(ch) + cmd.SetArgs([]string{"show", "cursor"}) + c.Assert(cmd.Execute(), qt.IsNil) + c.Assert(buf.String(), qt.JSONEquals, map[string]any{ + "name": "cursor", + "display_name": "Cursor", + "issuer": "https://cursor.com", + "required_claims": []string{"team_id"}, + "claims": []map[string]any{ + {"name": "team_id", "required": true, "description": "Cursor team"}, + {"name": "email", "required": false, "description": "User email"}, }, }) + + cmd = ProvidersCmd(ch) + cmd.SetArgs([]string{"show", "nope"}) + c.Assert(cmd.Execute(), qt.ErrorMatches, `OIDC trust provider .*nope.* is not available in organization .*planetscale.*`) } diff --git a/internal/planetscale/oidc_trusts.go b/internal/planetscale/oidc_trusts.go index f01af752..fd6b7022 100644 --- a/internal/planetscale/oidc_trusts.go +++ b/internal/planetscale/oidc_trusts.go @@ -67,10 +67,18 @@ type GetOIDCTrustRequest struct { // OIDCTrustProvider represents an identity provider that can be trusted. type OIDCTrustProvider struct { - Name string `json:"name"` - DisplayName string `json:"display_name"` - Issuer string `json:"issuer"` - RequiredClaims []string `json:"required_claims"` + Name string `json:"name"` + DisplayName string `json:"display_name"` + Issuer string `json:"issuer"` + RequiredClaims []string `json:"required_claims"` + Claims []OIDCTrustProviderClaim `json:"claims"` +} + +// OIDCTrustProviderClaim describes one claim a provider puts in its tokens. +type OIDCTrustProviderClaim struct { + Name string `json:"name"` + Required bool `json:"required"` + Description string `json:"description"` } // ListOIDCTrustProvidersRequest is the request for listing OIDC trust providers. From cb5105beb11a5f27d64e714999262a986f12de2d Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Thu, 12 Nov 2026 15:23:00 -0500 Subject: [PATCH 2/2] Fix CSV output for `providers show` --- internal/cmd/oidctrust/providers.go | 6 +++++ internal/cmd/oidctrust/providers_test.go | 34 ++++++++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/internal/cmd/oidctrust/providers.go b/internal/cmd/oidctrust/providers.go index 6707e002..ea3fc69e 100644 --- a/internal/cmd/oidctrust/providers.go +++ b/internal/cmd/oidctrust/providers.go @@ -19,6 +19,12 @@ type Provider struct { RequiredClaims string `header:"required claims" json:"required_claims"` } +// MarshalCSVValue wraps a single provider in a slice, which the CSV encoder +// requires. +func (p *Provider) MarshalCSVValue() interface{} { + return []*Provider{p} +} + // ProviderClaim is a table serializable claim of one OIDC trust provider. type ProviderClaim struct { Name string `header:"claim" json:"name"` diff --git a/internal/cmd/oidctrust/providers_test.go b/internal/cmd/oidctrust/providers_test.go index 47fc135a..6a45b3be 100644 --- a/internal/cmd/oidctrust/providers_test.go +++ b/internal/cmd/oidctrust/providers_test.go @@ -122,3 +122,37 @@ func TestOIDCTrust_ProvidersShowCmd(t *testing.T) { cmd.SetArgs([]string{"show", "nope"}) c.Assert(cmd.Execute(), qt.ErrorMatches, `OIDC trust provider .*nope.* is not available in organization .*planetscale.*`) } + +func TestOIDCTrust_ProvidersShowCmd_CSV(t *testing.T) { + c := qt.New(t) + + var buf bytes.Buffer + format := printer.CSV + p := printer.NewPrinter(&format) + p.SetResourceOutput(&buf) + + svc := &mock.OIDCTrustsService{ + ListProvidersFn: func(ctx context.Context, req *ps.ListOIDCTrustProvidersRequest) ([]*ps.OIDCTrustProvider, error) { + return []*ps.OIDCTrustProvider{ + { + Name: "cursor", + DisplayName: "Cursor", + Issuer: "https://cursor.com", + RequiredClaims: []string{"team_id"}, + }, + }, nil + }, + } + ch := &cmdutil.Helper{ + Printer: p, + Config: &config.Config{Organization: "planetscale"}, + Client: func() (*ps.Client, error) { + return &ps.Client{OIDCTrusts: svc}, nil + }, + } + + cmd := ProvidersCmd(ch) + cmd.SetArgs([]string{"show", "cursor"}) + c.Assert(cmd.Execute(), qt.IsNil) + c.Assert(buf.String(), qt.Equals, "Name,DisplayName,Issuer,RequiredClaims\ncursor,Cursor,https://cursor.com,team_id\n\n") +}