Skip to content

chore: early merge clibase foundations #6542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Mar 10, 2023
Merged

chore: early merge clibase foundations #6542

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d19cae5
chore: move over some of the clibase changes
ammario Mar 9, 2023
a57639b
Port over some of clibase
ammario Mar 9, 2023
a571e0c
Simplify Invoke calls
ammario Mar 9, 2023
2b02e65
grr fmt.Errorf
ammario Mar 9, 2023
2884aa6
fix: treat empty env as defaults (#6538)
ammario Mar 9, 2023
71f2c32
Reduce indirection in clibasetest.IO
ammario Mar 9, 2023
c6621bb
Cancel context when command finishes
ammario Mar 9, 2023
be7f957
oops typo
ammario Mar 9, 2023
8127b15
more typo
ammario Mar 9, 2023
7f978ab
Address review comments
ammario Mar 10, 2023
1d48f60
fixup! Address review comments
ammario Mar 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Simplify Invoke calls
  • Loading branch information
@ammario
ammario committed Mar 9, 2023
commit a571e0c89a9f2b55c3a0bb0f9f259d45454cdf0c
2 changes: 1 addition & 1 deletion cli/clibase/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ func (i *Invokation) run(state *runState) error {
}

// Flag parse errors are irrelevant for raw args commands.
if !i.Command.RawArgs && state.flagParseErr != nil && state.flagParseErr != pflag.ErrHelp {
if !i.Command.RawArgs && state.flagParseErr != nil && !errors.Is(state.flagParseErr, pflag.ErrHelp) {
return xerrors.Errorf(
"parsing flags (%v) for %q: %w",
state.allArgs,
Expand Down
128 changes: 53 additions & 75 deletions cli/clibase/cmd_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func TestCommand(t *testing.T) {
Value: clibase.BoolOf(&lower),
},
},
Handler: clibase.HandlerFunc(func(i *clibase.Invokation) error {
Handler: (func(i *clibase.Invokation) error {
i.Stdout.Write([]byte(prefix))
w := i.Args[0]
if lower {
Expand All @@ -74,32 +74,27 @@ func TestCommand(t *testing.T) {

t.Run("SimpleOK", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"toupper", "hello"},
Command: cmd(),
}
i := cmd().Invoke("toupper", "hello")
io := clibasetest.FakeIO(i)
i.Run()
require.Equal(t, "HELLO", io.Stdout.String())
})

t.Run("Alias", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"up", "hello"},
Command: cmd(),
}
i := cmd().Invoke(
"up", "hello",
)
io := clibasetest.FakeIO(i)
i.Run()
require.Equal(t, "HELLO", io.Stdout.String())
})

t.Run("NoSubcommand", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"na"},
Command: cmd(),
}
i := cmd().Invoke(
"na",
)
io := clibasetest.FakeIO(i)
err := i.Run()
require.Empty(t, io.Stdout.String())
Expand All @@ -108,10 +103,9 @@ func TestCommand(t *testing.T) {

t.Run("BadArgs", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"toupper"},
Command: cmd(),
}
i := cmd().Invoke(
"toupper",
)
io := clibasetest.FakeIO(i)
err := i.Run()
require.Empty(t, io.Stdout.String())
Expand All @@ -120,10 +114,9 @@ func TestCommand(t *testing.T) {

t.Run("UnknownFlags", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"toupper", "--unknown"},
Command: cmd(),
}
i := cmd().Invoke(
"toupper", "--unknown",
)
io := clibasetest.FakeIO(i)
err := i.Run()
require.Empty(t, io.Stdout.String())
Expand All @@ -132,65 +125,59 @@ func TestCommand(t *testing.T) {

t.Run("Verbose", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"--verbose", "toupper", "hello"},
Command: cmd(),
}
i := cmd().Invoke(
"--verbose", "toupper", "hello",
)
io := clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t, "HELLO!!!", io.Stdout.String())
})

t.Run("Verbose=", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"--verbose=true", "toupper", "hello"},
Command: cmd(),
}
i := cmd().Invoke(
"--verbose=true", "toupper", "hello",
)
io := clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t, "HELLO!!!", io.Stdout.String())
})

t.Run("PrefixSpace", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"--prefix", "conv: ", "toupper", "hello"},
Command: cmd(),
}
i := cmd().Invoke(
"--prefix", "conv: ", "toupper", "hello",
)
io := clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t, "conv: HELLO", io.Stdout.String())
})

t.Run("GlobalFlagsAnywhere", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"toupper", "--prefix", "conv: ", "hello", "--verbose"},
Command: cmd(),
}
i := cmd().Invoke(
"toupper", "--prefix", "conv: ", "hello", "--verbose",
)
io := clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t, "conv: HELLO!!!", io.Stdout.String())
})

t.Run("LowerVerbose", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"toupper", "--verbose", "hello", "--lower"},
Command: cmd(),
}
i := cmd().Invoke(
"toupper", "--verbose", "hello", "--lower",
)
io := clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t, "hello!!!", io.Stdout.String())
})

t.Run("ParsedFlags", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"toupper", "--verbose", "hello", "--lower"},
Command: cmd(),
}
i := cmd().Invoke(
"toupper", "--verbose", "hello", "--lower",
)
_ = clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t,
Expand All @@ -201,10 +188,9 @@ func TestCommand(t *testing.T) {

t.Run("NoDeepChild", func(t *testing.T) {
t.Parallel()
i := &clibase.Invokation{
Args: []string{"root", "level", "level", "toupper", "--verbose", "hello", "--lower"},
Command: cmd(),
}
i := cmd().Invoke(
"root", "level", "level", "toupper", "--verbose", "hello", "--lower",
)
fio := clibasetest.FakeIO(i)
require.Error(t, i.Run(), fio.Stdout.String())
})
Expand All @@ -215,7 +201,7 @@ func TestCommand_MiddlewareOrder(t *testing.T) {

mw := func(letter string) clibase.MiddlewareFunc {
return func(next clibase.HandlerFunc) clibase.HandlerFunc {
return clibase.HandlerFunc(func(i *clibase.Invokation) error {
return (func(i *clibase.Invokation) error {
_, _ = i.Stdout.Write([]byte(letter))
return next(i)
})
Expand All @@ -230,15 +216,14 @@ func TestCommand_MiddlewareOrder(t *testing.T) {
mw("B"),
mw("C"),
),
Handler: clibase.HandlerFunc(func(i *clibase.Invokation) error {
Handler: (func(i *clibase.Invokation) error {
return nil
}),
}

i := &clibase.Invokation{
Args: []string{"hello", "world"},
Command: cmd,
}
i := cmd.Invoke(
"hello", "world",
)
io := clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t, "ABC", io.Stdout.String())
Expand All @@ -262,7 +247,7 @@ func TestCommand_RawArgs(t *testing.T) {
Use: "sushi <args...>",
Short: "Throws back raw output",
RawArgs: true,
Handler: clibase.HandlerFunc(func(i *clibase.Invokation) error {
Handler: (func(i *clibase.Invokation) error {
if v := i.ParsedFlags().Lookup("password").Value.String(); v != "codershack" {
return xerrors.Errorf("password %q is wrong!", v)
}
Expand All @@ -278,12 +263,9 @@ func TestCommand_RawArgs(t *testing.T) {
// Flag parsed before the raw arg command should still work.
t.Parallel()

i := &clibase.Invokation{
Args: []string{
"--password", "codershack", "sushi", "hello", "--verbose", "world",
},
Command: cmd(),
}
i := cmd().Invoke(
"--password", "codershack", "sushi", "hello", "--verbose", "world",
)
io := clibasetest.FakeIO(i)
require.NoError(t, i.Run())
require.Equal(t, "hello --verbose world", io.Stdout.String())
Expand All @@ -293,12 +275,9 @@ func TestCommand_RawArgs(t *testing.T) {
// Verbose before the raw arg command should fail.
t.Parallel()

i := &clibase.Invokation{
Args: []string{
"--password", "codershack", "--verbose", "sushi", "hello", "world",
},
Command: cmd(),
}
i := cmd().Invoke(
"--password", "codershack", "--verbose", "sushi", "hello", "world",
)
io := clibasetest.FakeIO(i)
require.Error(t, i.Run())
require.Empty(t, io.Stdout.String())
Expand All @@ -307,10 +286,9 @@ func TestCommand_RawArgs(t *testing.T) {
t.Run("NoPassword", func(t *testing.T) {
// Flag parsed before the raw arg command should still work.
t.Parallel()
i := &clibase.Invokation{
Args: []string{"sushi", "hello", "--verbose", "world"},
Command: cmd(),
}
i := cmd().Invoke(
"sushi", "hello", "--verbose", "world",
)
_ = clibasetest.FakeIO(i)
i.Stdout = clibasetest.TestWriter(t, "stdout: ")
require.Error(t, i.Run())
Expand All @@ -321,10 +299,10 @@ func TestCommand_RootRaw(t *testing.T) {
t.Parallel()
cmd := &clibase.Cmd{
RawArgs: true,
Handler: clibase.HandlerFunc(func(i *clibase.Invokation) error {
Handler: func(i *clibase.Invokation) error {
i.Stdout.Write([]byte(strings.Join(i.Args, " ")))
return nil
}),
},
}

inv, stdio := clibasetest.Invoke(cmd, "hello", "--verbose", "--friendly")
Expand All @@ -337,7 +315,7 @@ func TestCommand_RootRaw(t *testing.T) {
func TestCommand_HyphenHypen(t *testing.T) {
t.Parallel()
cmd := &clibase.Cmd{
Handler: clibase.HandlerFunc(func(i *clibase.Invokation) error {
Handler: (func(i *clibase.Invokation) error {
i.Stdout.Write([]byte(strings.Join(i.Args, " ")))
return nil
}),
Expand Down