Files
Dominik Schulz 7c63ba09b7 chore(deps): migrate from urfave/cli v2 to v3 (#3428)
Migrate the entire codebase from github.com/urfave/cli/v2 to
github.com/urfave/cli/v3 (v3.9.0).

Key breaking changes addressed:
- cli.App removed, replaced by *cli.Command
- ActionFunc signature: func(*Context) error -> func(context.Context, *Command) error
- BeforeFunc signature: func(*Context) error -> func(context.Context, *Command) (context.Context, error)
- app.RunContext -> app.Run
- app.EnableBashCompletion -> app.EnableShellCompletion
- Subcommands field renamed to Commands
- EnvVars on flags -> Sources: cli.EnvVars(...)
- cli.NewContext removed; test helpers updated to use cmd.Run() pattern
- cli.Flag interface updated (Apply removed, Get/PreParse/PostParse/Set added)
- VersionPrinter type changed to func(*Command)

Also updates .capabilities.json baseline to reflect new cli/v3 call paths.

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
2026-05-16 18:13:19 +02:00

128 lines
2.6 KiB
Go

package fish
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/urfave/cli/v3"
)
type unknownFlag struct{}
func (u *unknownFlag) String() string {
return ""
}
func (u *unknownFlag) Get() any {
return nil
}
func (u *unknownFlag) PreParse() error {
return nil
}
func (u *unknownFlag) PostParse() error {
return nil
}
func (u *unknownFlag) Set(string, string) error {
return nil
}
func (u *unknownFlag) GetName() string {
return ""
}
func (u *unknownFlag) IsSet() bool {
return false
}
func (u *unknownFlag) Names() []string {
return nil
}
func TestFormatFlag(t *testing.T) {
t.Parallel()
for _, tc := range []struct {
Name string
Usage string
Typ string
Out string
}{
{"print, p", "Print", "short", "p"},
{"print, p", "Print", "long", "print"},
{"print, p", "Print", "usage", "Print"},
{"print", "Print", "short", ""},
{"", "Print", "long", ""},
{"print, p", "Print", "foo", ""},
} {
t.Run(tc.Name, func(t *testing.T) {
assert.Equal(t, tc.Out, formatFlag(tc.Name, tc.Usage, tc.Typ))
t.Parallel()
})
}
}
func TestGetCompletion(t *testing.T) {
t.Parallel()
app := &cli.Command{}
sv, err := GetCompletion(app)
require.NoError(t, err)
assert.Contains(t, sv, "#!/usr/bin/env fish")
fishTemplate = "{{.unexported}}"
sv, err = GetCompletion(app)
require.Error(t, err)
assert.Contains(t, sv, "")
fishTemplate = "{{}}"
sv, err = GetCompletion(app)
require.Error(t, err)
assert.Contains(t, sv, "")
}
func TestFormatflagFunc(t *testing.T) {
t.Parallel()
for _, flag := range []cli.Flag{
&cli.BoolFlag{Name: "foo", Usage: "bar"},
&cli.Float64Flag{Name: "foo", Usage: "bar"},
&cli.GenericFlag{Name: "foo", Usage: "bar"},
&cli.Int64Flag{Name: "foo", Usage: "bar"},
&cli.Int64SliceFlag{Name: "foo", Usage: "bar"},
&cli.IntFlag{Name: "foo", Usage: "bar"},
&cli.IntSliceFlag{Name: "foo", Usage: "bar"},
&cli.StringFlag{Name: "foo", Usage: "bar"},
&cli.StringSliceFlag{Name: "foo", Usage: "bar"},
&cli.Uint64Flag{Name: "foo", Usage: "bar"},
&cli.UintFlag{Name: "foo", Usage: "bar"},
} {
sv, err := formatFlagFunc("short")(flag)
require.NoError(t, err)
assert.Empty(t, sv)
sv, err = formatFlagFunc("long")(flag)
require.NoError(t, err)
assert.Equal(t, "foo", sv)
sv, err = formatFlagFunc("usage")(flag)
require.NoError(t, err)
assert.Equal(t, "bar", sv)
}
sv, err := formatFlagFunc("short")(&unknownFlag{})
require.Error(t, err)
assert.Empty(t, sv)
sv, err = formatFlagFunc("long")(&unknownFlag{})
require.Error(t, err)
assert.Empty(t, sv)
sv, err = formatFlagFunc("usage")(&unknownFlag{})
require.Error(t, err)
assert.Empty(t, sv)
}