-
Notifications
You must be signed in to change notification settings - Fork 235
/
command.go
415 lines (349 loc) · 10.4 KB
/
command.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
package cmd
import (
"fmt"
"path/filepath"
"github.com/superfly/flyctl/cmdctx"
"github.com/superfly/flyctl/docstrings"
"github.com/superfly/flyctl/flyctl"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"github.com/superfly/flyctl/client"
"github.com/superfly/flyctl/helpers"
"github.com/superfly/flyctl/internal/buildinfo"
"github.com/superfly/flyctl/internal/flyerr"
"github.com/superfly/flyctl/terminal"
)
// RunFn - Run function for commands which takes a command context
type RunFn func(cmdContext *cmdctx.CmdContext) error
// Command - Wrapper for a cobra command
type Command struct {
*cobra.Command
}
// AddCommand adds subcommands to this command
func (c *Command) AddCommand(commands ...*Command) {
for _, cmd := range commands {
c.Command.AddCommand(cmd.Command)
}
}
func namespace(c *cobra.Command) string {
parentName := flyctl.NSRoot
if c.Parent() != nil {
parentName = c.Parent().Name()
}
return parentName + "." + c.Name()
}
// StringFlagOpts - options for string flags
type StringFlagOpts struct {
Name string
Shorthand string
Description string
Default string
EnvName string
Hidden bool
}
// BoolFlagOpts - options for boolean flags
type BoolFlagOpts struct {
Name string
Shorthand string
Description string
Default bool
EnvName string
Hidden bool
}
// AddStringFlag - Add a string flag to a command
func (c *Command) AddStringFlag(options StringFlagOpts) {
fullName := namespace(c.Command) + "." + options.Name
c.Flags().StringP(options.Name, options.Shorthand, options.Default, options.Description)
flag := c.Flags().Lookup(options.Name)
flag.Hidden = options.Hidden
err := viper.BindPFlag(fullName, flag)
checkErr(err)
if options.EnvName != "" {
err := viper.BindEnv(fullName, options.EnvName)
checkErr(err)
}
}
// AddBoolFlag - Add a boolean flag for a command
func (c *Command) AddBoolFlag(options BoolFlagOpts) {
fullName := namespace(c.Command) + "." + options.Name
c.Flags().BoolP(options.Name, options.Shorthand, options.Default, options.Description)
flag := c.Flags().Lookup(options.Name)
flag.Hidden = options.Hidden
err := viper.BindPFlag(fullName, flag)
checkErr(err)
if options.EnvName != "" {
err := viper.BindEnv(fullName, options.EnvName)
checkErr(err)
}
}
// IntFlagOpts - options for integer flags
type IntFlagOpts struct {
Name string
Shorthand string
Description string
Default int
EnvName string
Hidden bool
}
// AddIntFlag - Add an integer flag to a command
func (c *Command) AddIntFlag(options IntFlagOpts) {
fullName := namespace(c.Command) + "." + options.Name
c.Flags().IntP(options.Name, options.Shorthand, options.Default, options.Description)
flag := c.Flags().Lookup(options.Name)
flag.Hidden = options.Hidden
err := viper.BindPFlag(fullName, flag)
checkErr(err)
if options.EnvName != "" {
err := viper.BindEnv(fullName, options.EnvName)
checkErr(err)
}
}
// StringSliceFlagOpts - options a string slice flag
type StringSliceFlagOpts struct {
Name string
Shorthand string
Description string
Default []string
EnvName string
}
// AddStringSliceFlag - add a string slice flag to a command
func (c *Command) AddStringSliceFlag(options StringSliceFlagOpts) {
fullName := namespace(c.Command) + "." + options.Name
if options.Shorthand != "" {
c.Flags().StringSliceP(options.Name, options.Shorthand, options.Default, options.Description)
} else {
c.Flags().StringSlice(options.Name, options.Default, options.Description)
}
err := viper.BindPFlag(fullName, c.Flags().Lookup(options.Name))
checkErr(err)
if options.EnvName != "" {
err := viper.BindEnv(fullName, options.EnvName)
checkErr(err)
}
}
// Initializer - Retains Setup and PreRun functions
type Initializer struct {
Setup InitializerFn
PreRun InitializerFn
}
// Option - A wrapper for an Initializer function that takes a command
type Option func(*Command) Initializer
// InitializerFn - A wrapper for an Initializer function that takes a command context
type InitializerFn func(*cmdctx.CmdContext) error
// BuildCommandKS - A wrapper for BuildCommand which takes the docs.KeyStrings bundle instead of the coder having to manually unwrap it
func BuildCommandKS(parent *Command, fn RunFn, keystrings docstrings.KeyStrings, client *client.Client, options ...Option) *Command {
return BuildCommand(parent, fn, keystrings.Usage, keystrings.Short, keystrings.Long, client, options...)
}
func BuildCommandCobra(parent *Command, fn RunFn, cmd *cobra.Command, client *client.Client, options ...Option) *Command {
flycmd := &Command{
Command: cmd,
}
if parent != nil {
parent.AddCommand(flycmd)
}
initializers := []Initializer{}
for _, o := range options {
if i := o(flycmd); i.Setup != nil || i.PreRun != nil {
initializers = append(initializers, i)
}
}
if fn != nil {
flycmd.RunE = func(cmd *cobra.Command, args []string) error {
ctx, err := cmdctx.NewCmdContext(client, namespace(cmd), cmd, args)
if err != nil {
return err
}
for _, init := range initializers {
if init.Setup != nil {
if err := init.Setup(ctx); err != nil {
return err
}
}
}
terminal.Debugf("Working Directory: %s\n", ctx.WorkingDir)
terminal.Debugf("App Config File: %s\n", ctx.ConfigFile)
for _, init := range initializers {
if init.PreRun != nil {
if err := init.PreRun(ctx); err != nil {
return err
}
}
}
return fn(ctx)
}
}
return flycmd
}
// BuildCommand - builds a functioning Command using all the initializers
func BuildCommand(parent *Command, fn RunFn, usageText string, shortHelpText string, longHelpText string, client *client.Client, options ...Option) *Command {
return BuildCommandCobra(parent, fn, &cobra.Command{
Use: usageText,
Short: shortHelpText,
Long: longHelpText,
}, client, options...)
}
const defaultConfigFilePath = "./fly.toml"
func requireSession(cmd *Command) Initializer {
return Initializer{
PreRun: func(ctx *cmdctx.CmdContext) error {
if !ctx.Client.Authenticated() {
return client.ErrNoAuthToken
}
return nil
},
}
}
func addAppConfigFlags(cmd *Command) {
cmd.AddStringFlag(StringFlagOpts{
Name: "app",
Shorthand: "a",
Description: "App name to operate on",
EnvName: "FLY_APP",
})
cmd.AddStringFlag(StringFlagOpts{
Name: "config",
Shorthand: "c",
Description: "Path to an app config file or directory containing one",
Default: defaultConfigFilePath,
EnvName: "FLY_APP_CONFIG",
})
}
func setupAppName(ctx *cmdctx.CmdContext) error {
// resolve the config file path
configPath := ctx.Config.GetString("config")
if configPath == "" {
configPath = defaultConfigFilePath
}
if !filepath.IsAbs(configPath) {
absConfigPath, err := filepath.Abs(filepath.Join(ctx.WorkingDir, configPath))
if err != nil {
return err
}
configPath = absConfigPath
}
resolvedPath, err := flyctl.ResolveConfigFileFromPath(configPath)
if err != nil {
return err
}
ctx.ConfigFile = resolvedPath
// load the config file if it exists
if helpers.FileExists(ctx.ConfigFile) {
terminal.Debug("Loading app config from", ctx.ConfigFile)
appConfig, err := flyctl.LoadAppConfig(ctx.ConfigFile)
if err != nil {
return err
}
ctx.AppConfig = appConfig
} else {
ctx.AppConfig = flyctl.NewAppConfig()
}
// set the app name if provided
appName := ctx.Config.GetString("app")
if appName != "" {
ctx.AppName = appName
} else if ctx.AppConfig != nil {
ctx.AppName = ctx.AppConfig.AppName
}
return nil
}
func optionalAppName(cmd *Command) Initializer {
addAppConfigFlags(cmd)
return Initializer{
Setup: setupAppName,
}
}
func requireAppName(cmd *Command) Initializer {
// TODO: Add Flags to docStrings
addAppConfigFlags(cmd)
return Initializer{
Setup: setupAppName,
PreRun: func(ctx *cmdctx.CmdContext) error {
if ctx.AppName == "" {
return fmt.Errorf("We couldn't find a fly.toml nor an app specified by the -a flag. If you want to launch a new app, use '" + buildinfo.Name() + " launch'")
}
if ctx.AppConfig == nil {
return nil
}
if ctx.AppConfig.AppName != "" && ctx.AppConfig.AppName != ctx.AppName {
terminal.Warnf("app flag '%s' does not match app name in config file '%s'\n", ctx.AppName, ctx.AppConfig.AppName)
if !confirm(fmt.Sprintf("Continue using '%s'", ctx.AppName)) {
return flyerr.ErrAbort
}
}
return nil
},
}
}
func requireAppNameAsArg(cmd *Command) Initializer {
cmd.AddStringFlag(StringFlagOpts{
Name: "app",
Shorthand: "a",
Description: "App name to operate on",
EnvName: "FLY_APP",
})
cmd.AddStringFlag(StringFlagOpts{
Name: "config",
Shorthand: "c",
Description: "Path to an app config file or directory containing one",
Default: defaultConfigFilePath,
EnvName: "FLY_APP_CONFIG",
})
return Initializer{
Setup: func(ctx *cmdctx.CmdContext) error {
// resolve the config file path
configPath := ctx.Config.GetString("config")
if configPath == "" {
configPath = defaultConfigFilePath
}
if !filepath.IsAbs(configPath) {
absConfigPath, err := filepath.Abs(filepath.Join(ctx.WorkingDir, configPath))
if err != nil {
return err
}
configPath = absConfigPath
}
resolvedPath, err := flyctl.ResolveConfigFileFromPath(configPath)
if err != nil {
return err
}
ctx.ConfigFile = resolvedPath
// load the config file if it exists
if helpers.FileExists(ctx.ConfigFile) {
terminal.Debug("Loading app config from", ctx.ConfigFile)
appConfig, err := flyctl.LoadAppConfig(ctx.ConfigFile)
if err != nil {
return err
}
ctx.AppConfig = appConfig
} else {
ctx.AppConfig = flyctl.NewAppConfig()
}
// set the app name if provided
appName := ctx.Config.GetString("app")
if appName != "" {
ctx.AppName = appName
} else if ctx.AppConfig != nil {
ctx.AppName = ctx.AppConfig.AppName
}
return nil
},
PreRun: func(ctx *cmdctx.CmdContext) error {
if len(ctx.Args) > 0 {
ctx.AppName = ctx.Args[0]
}
if ctx.AppName == "" {
return fmt.Errorf("No app specified")
}
if ctx.AppConfig == nil {
return nil
}
if ctx.AppConfig.AppName != "" && ctx.AppConfig.AppName != ctx.AppName {
terminal.Warnf("app flag '%s' does not match app name in config file '%s'\n", ctx.AppName, ctx.AppConfig.AppName)
if !confirm(fmt.Sprintf("Continue using '%s'", ctx.AppName)) {
return flyerr.ErrAbort
}
}
return nil
},
}
}