mirror of
https://gitea.com/gitea/tea.git
synced 2026-09-10 07:26:33 -04:00
c48e2af033
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.
116 lines
2.8 KiB
Go
116 lines
2.8 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"
|
|
"github.com/urfave/cli/v3"
|
|
)
|
|
|
|
// CmdWebhooksCreate represents a sub command of webhooks to create webhook
|
|
var CmdWebhooksCreate = cli.Command{
|
|
Name: "create",
|
|
Aliases: []string{"c"},
|
|
Usage: "Create a webhook",
|
|
Description: "Create a webhook in repository, organization, or globally",
|
|
ArgsUsage: "<webhook-url>",
|
|
Action: runWebhooksCreate,
|
|
Flags: append([]cli.Flag{
|
|
&cli.StringFlag{
|
|
Name: "type",
|
|
Usage: "webhook type (gitea, gogs, slack, discord, dingtalk, telegram, msteams, feishu, wechatwork, packagist)",
|
|
Value: "gitea",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "secret",
|
|
Usage: "webhook secret",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "events",
|
|
Usage: "comma separated list of events",
|
|
Value: "push",
|
|
},
|
|
&cli.BoolFlag{
|
|
Name: "active",
|
|
Usage: "webhook is active",
|
|
Value: true,
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "branch-filter",
|
|
Usage: "branch filter for push events",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "authorization-header",
|
|
Usage: "authorization header",
|
|
},
|
|
}, flags.AllDefaultFlags...),
|
|
}
|
|
|
|
func runWebhooksCreate(ctx stdctx.Context, cmd *cli.Command) error {
|
|
if cmd.Args().Len() == 0 {
|
|
return fmt.Errorf("webhook URL is required")
|
|
}
|
|
|
|
c, err := context.InitCommand(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
client := c.Login.Client()
|
|
|
|
webhookType := gitea.HookType(cmd.String("type"))
|
|
url := cmd.Args().First()
|
|
secret := cmd.String("secret")
|
|
active := cmd.Bool("active")
|
|
branchFilter := cmd.String("branch-filter")
|
|
authHeader := cmd.String("authorization-header")
|
|
|
|
// Parse events
|
|
events := flags.SplitCSV(cmd.String("events"))
|
|
|
|
config := map[string]string{
|
|
"url": url,
|
|
"http_method": "post",
|
|
"content_type": "json",
|
|
}
|
|
|
|
if secret != "" {
|
|
config["secret"] = secret
|
|
}
|
|
|
|
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.CreateOrgHook(ctx, c.Org, gitea.CreateHookOption{
|
|
Type: webhookType,
|
|
Config: config,
|
|
Events: events,
|
|
Active: active,
|
|
BranchFilter: branchFilter,
|
|
AuthorizationHeader: authHeader,
|
|
})
|
|
} else {
|
|
hook, _, err = client.Hooks.CreateRepoHook(ctx, c.Owner, c.Repo, gitea.CreateHookOption{
|
|
Type: webhookType,
|
|
Config: config,
|
|
Events: events,
|
|
Active: active,
|
|
BranchFilter: branchFilter,
|
|
AuthorizationHeader: authHeader,
|
|
})
|
|
}
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
fmt.Printf("Webhook created successfully (ID: %d)\n", hook.ID)
|
|
return nil
|
|
}
|