Add webhook show command

Author: joshmgross

internal/cmd/webhook/create.go

@@ -56,7 +56,7 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 
 			end()
 
-			return ch.Printer.PrintResource(toWebhook(webhook))
+			return ch.Printer.PrintResource(toWebhookWithSecret(webhook))
 		},
 	}
 

internal/cmd/webhook/create_test.go

@@ -31,6 +31,7 @@ func TestWebhook_CreateCmd(t *testing.T) {
 	webhook := &ps.Webhook{
 		ID:        "webhook-123",
 		URL:       url,
+		Secret:    "abcdefgh",
 		Enabled:   true,
 		Events:    events,
 		CreatedAt: createdAt,
@@ -65,7 +66,7 @@ func TestWebhook_CreateCmd(t *testing.T) {
 	c.Assert(err, qt.IsNil)
 	c.Assert(svc.CreateFnInvoked, qt.IsTrue)
 
-	res := &Webhook{orig: webhook}
+	res := &WebhookWithSecret{orig: webhook}
 	c.Assert(buf.String(), qt.JSONEquals, res)
 }
 

internal/cmd/webhook/show.go

@@ -0,0 +1,52 @@
+package webhook
+
+import (
+	"fmt"
+
+	"github.com/planetscale/cli/internal/cmdutil"
+	"github.com/planetscale/cli/internal/printer"
+	"github.com/planetscale/planetscale-go/planetscale"
+	"github.com/spf13/cobra"
+)
+
+func ShowCmd(ch *cmdutil.Helper) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "show <database> <webhook-id>",
+		Short: "Show a webhook for a database",
+		Args:  cmdutil.RequiredArgs("database", "webhook-id"),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx := cmd.Context()
+			database := args[0]
+			webhookID := args[1]
+
+			client, err := ch.Client()
+			if err != nil {
+				return err
+			}
+
+			end := ch.Printer.PrintProgress(fmt.Sprintf("Fetching webhook %s for %s", printer.BoldBlue(webhookID), printer.BoldBlue(database)))
+			defer end()
+
+			webhook, err := client.Webhooks.Get(ctx, &planetscale.GetWebhookRequest{
+				Organization: ch.Config.Organization,
+				Database:     database,
+				ID:           webhookID,
+			})
+			if err != nil {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("webhook %s does not exist in database %s (organization: %s)",
+						printer.BoldBlue(webhookID), printer.BoldBlue(database), printer.BoldBlue(ch.Config.Organization))
+				default:
+					return cmdutil.HandleError(err)
+				}
+			}
+
+			end()
+
+			return ch.Printer.PrintResource(toWebhookWithSecret(webhook))
+		},
+	}
+
+	return cmd
+}

internal/cmd/webhook/show_test.go

@@ -0,0 +1,107 @@
+package webhook
+
+import (
+	"bytes"
+	"context"
+	"testing"
+	"time"
+
+	qt "github.com/frankban/quicktest"
+	"github.com/planetscale/cli/internal/cmdutil"
+	"github.com/planetscale/cli/internal/config"
+	"github.com/planetscale/cli/internal/mock"
+	"github.com/planetscale/cli/internal/printer"
+	ps "github.com/planetscale/planetscale-go/planetscale"
+)
+
+func TestWebhook_ShowCmd(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.JSON
+	p := printer.NewPrinter(&format)
+	p.SetResourceOutput(&buf)
+
+	org := "planetscale"
+	db := "mydb"
+	webhookID := "webhook-123"
+	createdAt := time.Date(2025, 1, 15, 10, 30, 0, 0, time.UTC)
+
+	webhook := &ps.Webhook{
+		ID:        webhookID,
+		URL:       "https://example.com/webhook",
+		Secret:    "abcdefgh",
+		Enabled:   true,
+		Events:    []string{"branch.created", "branch.deleted"},
+		CreatedAt: createdAt,
+	}
+
+	svc := &mock.WebhooksService{
+		GetFn: func(ctx context.Context, req *ps.GetWebhookRequest) (*ps.Webhook, error) {
+			c.Assert(req.Organization, qt.Equals, org)
+			c.Assert(req.Database, qt.Equals, db)
+			c.Assert(req.ID, qt.Equals, webhookID)
+			return webhook, nil
+		},
+	}
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{
+				Webhooks: svc,
+			}, nil
+		},
+	}
+
+	cmd := ShowCmd(ch)
+	cmd.SetArgs([]string{db, webhookID})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(svc.GetFnInvoked, qt.IsTrue)
+
+	res := &WebhookWithSecret{orig: webhook}
+	c.Assert(buf.String(), qt.JSONEquals, res)
+}
+
+func TestWebhook_ShowCmd_NotFound(t *testing.T) {
+	c := qt.New(t)
+
+	var buf bytes.Buffer
+	format := printer.Human
+	p := printer.NewPrinter(&format)
+	p.SetHumanOutput(&buf)
+
+	org := "planetscale"
+	db := "mydb"
+	webhookID := "webhook-123"
+
+	svc := &mock.WebhooksService{
+		GetFn: func(ctx context.Context, req *ps.GetWebhookRequest) (*ps.Webhook, error) {
+			return nil, &ps.Error{Code: ps.ErrNotFound}
+		},
+	}
+
+	ch := &cmdutil.Helper{
+		Printer: p,
+		Config: &config.Config{
+			Organization: org,
+		},
+		Client: func() (*ps.Client, error) {
+			return &ps.Client{
+				Webhooks: svc,
+			}, nil
+		},
+	}
+
+	cmd := ShowCmd(ch)
+	cmd.SetArgs([]string{db, webhookID})
+	err := cmd.Execute()
+
+	c.Assert(err, qt.IsNotNil)
+	c.Assert(err.Error(), qt.Contains, "does not exist")
+}

internal/cmd/webhook/webhook.go

@@ -24,6 +24,7 @@ func WebhookCmd(ch *cmdutil.Helper) *cobra.Command {
 	cmd.AddCommand(CreateCmd(ch))
 	cmd.AddCommand(DeleteCmd(ch))
 	cmd.AddCommand(ListCmd(ch))
+	cmd.AddCommand(ShowCmd(ch))
 	cmd.AddCommand(UpdateCmd(ch))
 
 	return cmd
@@ -65,3 +66,34 @@ func toWebhooks(webhooks []*ps.Webhook) []*Webhook {
 	}
 	return results
 }
+
+// WebhookWithSecret includes the webhook secret for display.
+type WebhookWithSecret struct {
+	ID        string `header:"id" json:"id"`
+	URL       string `header:"url" json:"url"`
+	Secret    string `header:"secret" json:"secret"`
+	Events    string `header:"events" json:"events"`
+	Enabled   bool   `header:"enabled" json:"enabled"`
+	CreatedAt int64  `header:"created_at,timestamp(ms|utc|human)" json:"created_at"`
+	UpdatedAt int64  `header:"updated_at,timestamp(ms|utc|human)" json:"updated_at"`
+
+	orig *ps.Webhook
+}
+
+func (w *WebhookWithSecret) MarshalJSON() ([]byte, error) {
+	return json.MarshalIndent(w.orig, "", "  ")
+}
+
+// toWebhookWithSecret returns a struct that includes the webhook secret.
+func toWebhookWithSecret(webhook *ps.Webhook) *WebhookWithSecret {
+	return &WebhookWithSecret{
+		ID:        webhook.ID,
+		URL:       webhook.URL,
+		Secret:    webhook.Secret,
+		Events:    strings.Join(webhook.Events, ", "),
+		Enabled:   webhook.Enabled,
+		CreatedAt: printer.GetMilliseconds(webhook.CreatedAt),
+		UpdatedAt: printer.GetMilliseconds(webhook.UpdatedAt),
+		orig:      webhook,
+	}
+}