-
-
Notifications
You must be signed in to change notification settings - Fork 139
/
cli_test.go
165 lines (135 loc) · 3.34 KB
/
cli_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
package huma
import (
"bytes"
"syscall"
"testing"
"time"
"github.com/spf13/cobra"
"github.com/stretchr/testify/assert"
)
func TestCLIPlain(t *testing.T) {
type Options struct {
Debug bool
Host string
Port int
// ignore private fields, should not crash.
ingore bool
}
cli := NewCLI(func(hooks Hooks, options *Options) {
assert.Equal(t, true, options.Debug)
assert.Equal(t, "localhost", options.Host)
assert.Equal(t, 8001, options.Port)
assert.Equal(t, false, options.ingore)
hooks.OnStart(func() {
// Do nothing
})
})
cli.Root().SetArgs([]string{"--debug", "--host", "localhost", "--port", "8001"})
cli.Run()
}
func TestCLIAdvanced(t *testing.T) {
type DebugOption struct {
Debug bool `doc:"Enable debug mode." default:"false"`
}
type Options struct {
// Example of option composition via embedded type.
DebugOption
Host string `doc:"Hostname to listen on."`
Port int `doc:"Port to listen on." short:"p" default:"8000"`
}
cli := NewCLI(func(hooks Hooks, options *Options) {
assert.Equal(t, true, options.Debug)
assert.Equal(t, "localhost", options.Host)
assert.Equal(t, 8001, options.Port)
hooks.OnStart(func() {
// Do nothing
})
})
// A custom pre-run isn't overwritten and should still work!
customPreRun := false
cli.Root().PersistentPreRun = func(cmd *cobra.Command, args []string) {
customPreRun = true
}
cli.Root().SetArgs([]string{"--debug", "--host", "localhost", "--port", "8001"})
cli.Run()
assert.True(t, customPreRun)
}
func TestCLIHelp(t *testing.T) {
type Options struct {
Debug bool
Host string
Port int
}
cli := NewCLI(func(hooks Hooks, options *Options) {
// Do nothing
})
cli.Root().SetArgs([]string{"--help"})
buf := bytes.NewBuffer(nil)
cli.Root().SetOut(buf)
cli.Root().SetErr(buf)
cli.Run()
assert.Equal(t, "Usage:\n myapp [flags]\n\nFlags:\n --debug \n -h, --help help for myapp\n --host string \n --port int\n", buf.String())
}
func TestCLICommandWithOptions(t *testing.T) {
type Options struct {
Debug bool
}
cli := NewCLI(func(hooks Hooks, options *Options) {
// Do nothing
})
wasSet := false
cli.Root().AddCommand(&cobra.Command{
Use: "custom",
Run: WithOptions(func(cmd *cobra.Command, args []string, options *Options) {
if options.Debug {
wasSet = true
}
}),
})
cli.Root().SetArgs([]string{"custom", "--debug"})
cli.Run()
assert.True(t, wasSet)
}
func TestCLIShutdown(t *testing.T) {
type Options struct{}
started := false
stopping := make(chan bool, 1)
cli := NewCLI(func(hooks Hooks, options *Options) {
hooks.OnStart(func() {
started = true
<-stopping
})
hooks.OnStop(func() {
stopping <- true
})
})
go func() {
time.Sleep(10 * time.Millisecond)
syscall.Kill(syscall.Getpid(), syscall.SIGINT)
}()
cli.Root().SetArgs([]string{})
cli.Run()
assert.True(t, started)
}
func TestCLIBadType(t *testing.T) {
type Options struct {
Debug []struct{}
}
assert.Panics(t, func() {
NewCLI(func(hooks Hooks, options *Options) {})
})
}
func TestCLIBadDefaults(t *testing.T) {
type OptionsBool struct {
Debug bool `default:"notabool"`
}
type OptionsInt struct {
Debug int `default:"notanint"`
}
assert.Panics(t, func() {
NewCLI(func(hooks Hooks, options *OptionsBool) {})
})
assert.Panics(t, func() {
NewCLI(func(hooks Hooks, options *OptionsInt) {})
})
}