gitea.tea/cmd/webhooks/update.go
Ross Golder c48e2af033
fix(flags): drop empty/whitespace entries when parsing CSV flags
Comma-separated flags (`--assignees`, `--labels`, `--add/remove-labels`,
`--add/remove-reviewers`, `--events`, login `--scopes`) silently accepted
stray commas and whitespace, producing values like `[""]` for empty input
or `["alice", "", "bob"]` for `--assignees=alice,,bob`. Those blanks
were then forwarded to the Gitea SDK, where they either triggered obscure
server errors or silently mutated state in unexpected ways.

Root cause: a mix of `strings.Split(s, ",")` and ad-hoc trim loops, none
of which rejected empty segments.

Introduce `modules/utils.SplitCSV` as the single parser for all CSV flag
values. It:

- returns `nil` for an empty or whitespace-only input (so callers can use
  `len(x) == 0` to mean "not set", and `cmd.IsSet("...")` keeps
  working),
- drops empty and whitespace-only segments anywhere in the input,
- otherwise trims surrounding whitespace from each remaining segment.

`cmd/flags.SplitCSV` is re-exported from `cmd/flags/csvflag.go` so
existing call sites read `flags.SplitCSV` without depending on a leaf
package that `modules/task` already imports them.

Convert the remaining raw `strings.Split(..., ",")` sites:

- `cmd/flags/issue_pr.go` (issue/pr --assignees, --labels and the
  set/add/remove variants)
- `cmd/pulls/edit.go` (`--add-reviewers`, `--remove-reviewers`)
- `cmd/webhooks/create.go`, `cmd/webhooks/update.go` (`--events`)
- `modules/task/login_create.go` (login `--scopes`)

Drop the now-unused `"strings"` imports from the three cmd/* files.

Tests:

- `modules/utils/splitcsv_test.go` — table-driven coverage for empty,
  whitespace-only, leading/trailing commas, internal empty segments,
  surrounding whitespace, and re-imported identity with `flags.SplitCSV`.
- `cmd/flags/csvflag_test.go` — `GetValues` happy path, error path,
  empty entry drop, and AvailableFields variants.
- `cmd/flags/issue_pr_test.go` — regression test for
  `GetIssuePREditFlags` proving `SetAssignees/AddAssignees/...`
  produce `nil` (not `[""]`) for empty input and trimmed slices for
  mixed inputs.
2026-09-10 17:31:08 +07:00

149 lines
3.5 KiB
Go

// Copyright 2024 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package webhooks
import (
stdctx "context"
"fmt"
gitea "gitea.dev/sdk"
"gitea.dev/tea/cmd/flags"
"gitea.dev/tea/modules/context"
"gitea.dev/tea/modules/utils"
"github.com/urfave/cli/v3"
)
// CmdWebhooksUpdate represents a sub command of webhooks to update webhook
var CmdWebhooksUpdate = cli.Command{
Name: "update",
Aliases: []string{"edit", "u"},
Usage: "Update a webhook",
Description: "Update webhook configuration in repository, organization, or globally",
ArgsUsage: "<webhook-id>",
Action: runWebhooksUpdate,
Flags: append([]cli.Flag{
&cli.StringFlag{
Name: "url",
Usage: "webhook URL",
},
&cli.StringFlag{
Name: "secret",
Usage: "webhook secret",
},
&cli.StringFlag{
Name: "events",
Usage: "comma separated list of events",
},
&cli.BoolFlag{
Name: "active",
Usage: "webhook is active",
},
&cli.BoolFlag{
Name: "inactive",
Usage: "webhook is inactive",
},
&cli.StringFlag{
Name: "branch-filter",
Usage: "branch filter for push events",
},
&cli.StringFlag{
Name: "authorization-header",
Usage: "authorization header",
},
}, flags.AllDefaultFlags...),
}
func runWebhooksUpdate(ctx stdctx.Context, cmd *cli.Command) error {
if cmd.Args().Len() == 0 {
return fmt.Errorf("webhook ID is required")
}
c, err := context.InitCommand(cmd)
if err != nil {
return err
}
client := c.Login.Client()
webhookID, err := utils.ArgToIndex(cmd.Args().First())
if err != nil {
return err
}
// Get current webhook to preserve existing settings
var hook *gitea.Hook
if c.IsGlobal {
return fmt.Errorf("global webhooks not yet supported in this version")
} else if len(c.Org) > 0 {
hook, _, err = client.Hooks.GetOrgHook(ctx, c.Org, int64(webhookID))
} else {
hook, _, err = client.Hooks.GetRepoHook(ctx, c.Owner, c.Repo, int64(webhookID))
}
if err != nil {
return err
}
// Update configuration
config := hook.Config
if config == nil {
config = make(map[string]string)
}
if cmd.IsSet("url") {
config["url"] = cmd.String("url")
}
if cmd.IsSet("secret") {
config["secret"] = cmd.String("secret")
}
branchFilter := hook.BranchFilter
if cmd.IsSet("branch-filter") {
branchFilter = cmd.String("branch-filter")
}
authHeader := hook.AuthorizationHeader
if cmd.IsSet("authorization-header") {
authHeader = cmd.String("authorization-header")
}
// Update events if specified
events := hook.Events
if cmd.IsSet("events") {
events = flags.SplitCSV(cmd.String("events"))
}
// Update active status
active := hook.Active
if cmd.IsSet("active") {
active = cmd.Bool("active")
} else if cmd.IsSet("inactive") {
active = !cmd.Bool("inactive")
}
if c.IsGlobal {
return fmt.Errorf("global webhooks not yet supported in this version")
} else if len(c.Org) > 0 {
_, err = client.Hooks.EditOrgHook(ctx, c.Org, int64(webhookID), gitea.EditHookOption{
Config: config,
Events: events,
Active: &active,
BranchFilter: branchFilter,
AuthorizationHeader: authHeader,
})
} else {
_, err = client.Hooks.EditRepoHook(ctx, c.Owner, c.Repo, int64(webhookID), gitea.EditHookOption{
Config: config,
Events: events,
Active: &active,
BranchFilter: branchFilter,
AuthorizationHeader: authHeader,
})
}
if err != nil {
return err
}
fmt.Printf("Webhook %d updated successfully\n", webhookID)
return nil
}