-
Notifications
You must be signed in to change notification settings - Fork 787
/
cmd.go
492 lines (428 loc) · 14.5 KB
/
cmd.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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
/*
Copyright 2018 The Kubernetes Authors & The Jenkins X Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package cmd
import (
"fmt"
"io"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"runtime"
"strconv"
"strings"
"syscall"
"github.com/jenkins-x/jx/v2/pkg/cmd/deprecation"
"github.com/jenkins-x/jx/v2/pkg/cmd/experimental"
"github.com/jenkins-x/jx/v2/pkg/cmd/profile"
"github.com/jenkins-x/jx/v2/pkg/cmd/ui"
version2 "github.com/jenkins-x/jx/v2/pkg/cmd/version"
"github.com/spf13/viper"
"github.com/jenkins-x/jx/v2/pkg/cmd/boot"
"github.com/jenkins-x/jx/v2/pkg/cmd/compliance"
"github.com/jenkins-x/jx/v2/pkg/cmd/controller"
"github.com/jenkins-x/jx/v2/pkg/cmd/create"
"github.com/jenkins-x/jx/v2/pkg/cmd/deletecmd"
"github.com/jenkins-x/jx/v2/pkg/cmd/edit"
"github.com/jenkins-x/jx/v2/pkg/cmd/gc"
"github.com/jenkins-x/jx/v2/pkg/cmd/get"
"github.com/jenkins-x/jx/v2/pkg/cmd/importcmd"
"github.com/jenkins-x/jx/v2/pkg/cmd/initcmd"
"github.com/jenkins-x/jx/v2/pkg/cmd/preview"
"github.com/jenkins-x/jx/v2/pkg/cmd/rsh"
"github.com/jenkins-x/jx/v2/pkg/cmd/start"
"github.com/jenkins-x/jx/v2/pkg/cmd/stop"
"github.com/jenkins-x/jx/v2/pkg/cmd/sync"
"github.com/jenkins-x/jx/v2/pkg/cmd/uninstall"
"github.com/jenkins-x/jx/v2/pkg/cmd/update"
"github.com/jenkins-x/jx/v2/pkg/cmd/upgrade"
"github.com/jenkins-x/jx/v2/pkg/cmd/add"
"github.com/jenkins-x/jx/v2/pkg/cmd/namespace"
"github.com/jenkins-x/jx/v2/pkg/cmd/promote"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"github.com/jenkins-x/jx/v2/pkg/extensions"
"github.com/jenkins-x/jx-logging/pkg/log"
"github.com/jenkins-x/jx/v2/pkg/features"
"github.com/jenkins-x/jx/v2/pkg/util"
"github.com/jenkins-x/jx/v2/pkg/cmd/clients"
"github.com/jenkins-x/jx/v2/pkg/cmd/opts"
"github.com/jenkins-x/jx/v2/pkg/cmd/templates"
"github.com/jenkins-x/jx/v2/pkg/version"
"github.com/spf13/cobra"
"gopkg.in/AlecAivazis/survey.v1/terminal"
)
// NewJXCommand creates the `jx` command and its nested children.
// args used to determine binary plugin to run can be overridden (does not affect compiled in commands).
func NewJXCommand(f clients.Factory, in terminal.FileReader, out terminal.FileWriter,
err io.Writer, args []string) *cobra.Command {
configureViper()
rootCommand := &cobra.Command{
Use: "jx",
Short: "jx is a command line tool for working with Jenkins X",
PersistentPreRun: setLoggingLevel,
Run: runHelp,
}
features.Init()
commonOpts := opts.NewCommonOptionsWithTerm(f, in, out, err)
commonOpts.AddBaseFlags(rootCommand)
addCommands := add.NewCmdAdd(commonOpts)
createCommands := create.NewCmdCreate(commonOpts)
deleteCommands := deletecmd.NewCmdDelete(commonOpts)
getCommands := get.NewCmdGet(commonOpts)
editCommands := edit.NewCmdEdit(commonOpts)
updateCommands := update.NewCmdUpdate(commonOpts)
installCommands := []*cobra.Command{
profile.NewCmdProfile(commonOpts),
boot.NewCmdBoot(commonOpts),
create.NewCmdInstall(commonOpts),
uninstall.NewCmdUninstall(commonOpts),
upgrade.NewCmdUpgrade(commonOpts),
}
installCommands = append(installCommands, findCommands("cluster", createCommands, deleteCommands)...)
installCommands = append(installCommands, findCommands("cluster", updateCommands)...)
installCommands = append(installCommands, findCommands("jenkins token", createCommands, deleteCommands)...)
installCommands = append(installCommands, initcmd.NewCmdInit(commonOpts))
addProjectCommands := []*cobra.Command{
importcmd.NewCmdImport(commonOpts),
}
addProjectCommands = append(addProjectCommands, findCommands("create spring", createCommands, deleteCommands)...)
addProjectCommands = append(addProjectCommands, findCommands("create quickstart", createCommands, deleteCommands)...)
gitCommands := []*cobra.Command{}
gitCommands = append(gitCommands, findCommands("git server", createCommands, deleteCommands)...)
gitCommands = append(gitCommands, findCommands("git token", createCommands, deleteCommands)...)
gitCommands = append(gitCommands, NewCmdRepo(commonOpts))
addonCommands := []*cobra.Command{}
addonCommands = append(addonCommands, findCommands("addon", createCommands, deleteCommands)...)
addonCommands = append(addonCommands, findCommands("app", createCommands, deleteCommands, addCommands)...)
environmentsCommands := []*cobra.Command{
preview.NewCmdPreview(commonOpts),
promote.NewCmdPromote(commonOpts),
}
environmentsCommands = append(environmentsCommands, findCommands("environment", createCommands, deleteCommands, editCommands, getCommands)...)
groups := templates.CommandGroups{
{
Message: "Installing:",
Commands: installCommands,
},
{
Message: "Adding Projects to Jenkins X:",
Commands: addProjectCommands,
},
{
Message: "Apps:",
Commands: addonCommands,
},
{
Message: "Git:",
Commands: gitCommands,
},
{
Message: "Working with Kubernetes:",
Commands: []*cobra.Command{
compliance.NewCompliance(commonOpts),
NewCmdCompletion(commonOpts),
NewCmdContext(commonOpts),
NewCmdEnvironment(commonOpts),
NewCmdTeam(commonOpts),
namespace.NewCmdNamespace(commonOpts),
NewCmdPrompt(commonOpts),
NewCmdScan(commonOpts),
NewCmdShell(commonOpts),
NewCmdStatus(commonOpts),
},
},
{
Message: "Working with Applications:",
Commands: []*cobra.Command{
NewCmdLogs(commonOpts),
NewCmdOpen(commonOpts),
rsh.NewCmdRsh(commonOpts),
sync.NewCmdSync(commonOpts),
},
},
{
Message: "Working with Environments:",
Commands: environmentsCommands,
},
{
Message: "Working with Jenkins X resources:",
Commands: []*cobra.Command{
getCommands,
editCommands,
createCommands,
updateCommands,
deleteCommands,
addCommands,
start.NewCmdStart(commonOpts),
stop.NewCmdStop(commonOpts),
},
},
{
Message: "Jenkins X Pipeline Commands:",
Commands: []*cobra.Command{
NewCmdStep(commonOpts),
},
},
{
Message: "Jenkins X services:",
Commands: []*cobra.Command{
controller.NewCmdController(commonOpts),
gc.NewCmdGC(commonOpts),
},
},
{
Message: "Working with Jenkins X UI:",
Commands: []*cobra.Command{
ui.NewCmdUI(commonOpts),
},
},
}
groups.Add(rootCommand)
filters := []string{"options"}
getPluginCommandGroups := func() (templates.PluginCommandGroups, bool) {
verifier := &extensions.CommandOverrideVerifier{
Root: rootCommand,
SeenPlugins: make(map[string]string, 0),
}
pluginCommandGroups, managedPluginsEnabled, err := commonOpts.GetPluginCommandGroups(verifier)
if err != nil {
log.Logger().Errorf("%v", err)
}
return pluginCommandGroups, managedPluginsEnabled
}
templates.ActsAsRootCommand(rootCommand, filters, getPluginCommandGroups, groups...)
rootCommand.AddCommand(NewCmdDocs(commonOpts))
rootCommand.AddCommand(version2.NewCmdVersion(commonOpts))
rootCommand.Version = version.GetVersion()
rootCommand.SetVersionTemplate("{{printf .Version}}\n Deprecated will be removed on July 1, 2020. Please use version instead\n")
rootCommand.AddCommand(NewCmdOptions(out))
rootCommand.AddCommand(NewCmdDiagnose(commonOpts))
// Mark the deprecated commands
deprecation.DeprecateCommands(rootCommand)
// Mark the experimental commands
experimental.AlphaCommands(rootCommand)
experimental.BetaCommands(rootCommand)
managedPlugins := &managedPluginHandler{
CommonOptions: commonOpts,
}
localPlugins := &localPluginHandler{}
if len(args) == 0 {
args = os.Args
}
if len(args) > 1 {
cmdPathPieces := args[1:]
// only look for suitable executables if
// the specified command does not already exist
if _, _, err := rootCommand.Find(cmdPathPieces); err != nil {
if _, managedPluginsEnabled := getPluginCommandGroups(); managedPluginsEnabled {
if err := handleEndpointExtensions(managedPlugins, cmdPathPieces); err != nil {
log.Logger().Errorf("%v", err)
os.Exit(1)
}
} else {
if err := handleEndpointExtensions(localPlugins, cmdPathPieces); err != nil {
log.Logger().Errorf("%v", err)
os.Exit(1)
}
}
}
}
return rootCommand
}
func configureViper() {
replacer := strings.NewReplacer("-", "_")
viper.SetEnvKeyReplacer(replacer)
}
func findCommands(subCommand string, commands ...*cobra.Command) []*cobra.Command {
answer := []*cobra.Command{}
for _, parent := range commands {
for _, c := range parent.Commands() {
if commandHasParentName(c, subCommand) {
answer = append(answer, c)
} else {
childCommands := findCommands(subCommand, c)
if len(childCommands) > 0 {
answer = append(answer, childCommands...)
}
}
}
}
return answer
}
func commandHasParentName(command *cobra.Command, name string) bool {
path := fullPath(command)
return strings.Contains(path, name)
}
func fullPath(command *cobra.Command) string {
name := command.Name()
parent := command.Parent()
if parent != nil {
return fullPath(parent) + " " + name
}
return name
}
func setLoggingLevel(cmd *cobra.Command, args []string) {
verbose, err := strconv.ParseBool(cmd.Flag(opts.OptionVerbose).Value.String())
if err != nil {
log.Logger().Errorf("Unable to check if the verbose flag is set")
}
level := os.Getenv("JX_LOG_LEVEL")
if level != "" {
if verbose {
log.Logger().Trace("The JX_LOG_LEVEL environment variable took precedence over the verbose flag")
}
err := log.SetLevel(level)
if err != nil {
log.Logger().Errorf("Unable to set log level to %s", level)
}
} else {
if verbose {
err := log.SetLevel("debug")
if err != nil {
log.Logger().Errorf("Unable to set log level to debug")
}
} else {
err := log.SetLevel("info")
if err != nil {
log.Logger().Errorf("Unable to set log level to info")
}
}
}
}
func runHelp(cmd *cobra.Command, args []string) {
cmd.Help() //nolint:errcheck
}
// PluginHandler is capable of parsing command line arguments
// and performing executable filename lookups to search
// for valid plugin files, and execute found plugins.
type PluginHandler interface {
// Lookup receives a potential filename and returns
// a full or relative path to an executable, if one
// exists at the given filename, or an error.
Lookup(filename string) (string, error)
// Execute receives an executable's filepath, a slice
// of arguments, and a slice of environment variables
// to relay to the executable.
Execute(executablePath string, cmdArgs, environment []string) error
}
type managedPluginHandler struct {
*opts.CommonOptions
localPluginHandler
}
// Lookup implements PluginHandler
func (h *managedPluginHandler) Lookup(filename string) (string, error) {
jxClient, ns, err := h.JXClientAndDevNamespace()
if err != nil {
return "", err
}
possibles, err := jxClient.JenkinsV1().Plugins(ns).List(metav1.ListOptions{
LabelSelector: fmt.Sprintf("%s=%s", extensions.PluginCommandLabel, filename),
})
if err != nil {
return "", err
}
if len(possibles.Items) > 0 {
found := possibles.Items[0]
if len(possibles.Items) > 1 {
// There is a warning about this when you install extensions as well
log.Logger().Warnf("More than one plugin installed for %s by apps. Selecting the one installed by %s at random.",
filename, found.Name)
}
return extensions.EnsurePluginInstalled(found)
}
return h.localPluginHandler.Lookup(filename)
}
// Execute implements PluginHandler
func (h *managedPluginHandler) Execute(executablePath string, cmdArgs, environment []string) error {
return h.localPluginHandler.Execute(executablePath, cmdArgs, environment)
}
type localPluginHandler struct{}
// Lookup implements PluginHandler
func (h *localPluginHandler) Lookup(filename string) (string, error) {
// if on Windows, append the "exe" extension
// to the filename that we are looking up.
if runtime.GOOS == "windows" {
filename = filename + ".exe"
}
return exec.LookPath(filename)
}
// Execute implements PluginHandler
func (h *localPluginHandler) Execute(executablePath string, cmdArgs, environment []string) error {
return syscall.Exec(executablePath, cmdArgs, environment)
}
func handleEndpointExtensions(pluginHandler PluginHandler, cmdArgs []string) error {
remainingArgs := []string{} // all "non-flag" arguments
for idx := range cmdArgs {
if strings.HasPrefix(cmdArgs[idx], "-") {
break
}
remainingArgs = append(remainingArgs, strings.Replace(cmdArgs[idx], "-", "_", -1))
}
foundBinaryPath := ""
pluginDir, err := util.PluginBinDir("jx")
if err != nil {
log.Logger().Debugf("failed to find plugin dir %s", err.Error())
}
// attempt to find binary, starting at longest possible name with given cmdArgs
for len(remainingArgs) > 0 {
commandName := fmt.Sprintf("jx-%s", strings.Join(remainingArgs, "-"))
path, err := pluginHandler.Lookup(commandName)
if err != nil || len(path) == 0 {
// lets see if we have previously downloaded this binary plugin
path = FindPluginBinary(pluginDir, commandName)
if path != "" {
foundBinaryPath = path
break
}
/* Usually "executable file not found in $PATH", spams output of jx help subcommand:
if err != nil {
log.Logger().Errorf("Error installing plugin for command %s. %v\n", remainingArgs, err)
}
*/
remainingArgs = remainingArgs[:len(remainingArgs)-1]
continue
}
foundBinaryPath = path
break
}
if len(foundBinaryPath) == 0 {
return nil
}
// invoke cmd binary relaying the current environment and args given
// remainingArgs will always have at least one element.
// execve will make remainingArgs[0] the "binary name".
if err := pluginHandler.Execute(foundBinaryPath, append([]string{foundBinaryPath}, cmdArgs[len(remainingArgs):]...), os.Environ()); err != nil {
return err
}
return nil
}
// FindPluginBinary tries to find the jx-foo binary plugin in the plugins dir `~/.jx/plugins/jx/bin` dir `
func FindPluginBinary(pluginDir string, commandName string) string {
if pluginDir != "" {
files, err := ioutil.ReadDir(pluginDir)
if err != nil {
log.Logger().Debugf("failed to read plugin dir %s", err.Error())
} else {
prefix := commandName + "-"
for _, f := range files {
name := f.Name()
if strings.HasPrefix(name, prefix) {
path := filepath.Join(pluginDir, name)
log.Logger().Debugf("found plugin %s at %s", commandName, path)
return path
}
}
}
}
return ""
}