-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
cli.go
338 lines (310 loc) · 9.63 KB
/
cli.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
// Package cmd provides functionally common to various argo CLIs
package cli
import (
"bufio"
"bytes"
"flag"
"fmt"
"os"
"os/exec"
"path"
"strconv"
"strings"
"github.com/argoproj/gitops-engine/pkg/utils/text"
"github.com/google/shlex"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
terminal "golang.org/x/term"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/klog/v2"
"k8s.io/kubectl/pkg/util/term"
"sigs.k8s.io/yaml"
"github.com/argoproj/argo-cd/v2/common"
"github.com/argoproj/argo-cd/v2/util/errors"
"github.com/argoproj/argo-cd/v2/util/io"
utillog "github.com/argoproj/argo-cd/v2/util/log"
)
// NewVersionCmd returns a new `version` command to be used as a sub-command to root
func NewVersionCmd(cliName string) *cobra.Command {
var short bool
versionCmd := cobra.Command{
Use: "version",
Short: "Print version information",
Run: func(cmd *cobra.Command, args []string) {
version := common.GetVersion()
fmt.Printf("%s: %s\n", cliName, version)
if short {
return
}
fmt.Printf(" BuildDate: %s\n", version.BuildDate)
fmt.Printf(" GitCommit: %s\n", version.GitCommit)
fmt.Printf(" GitTreeState: %s\n", version.GitTreeState)
if version.GitTag != "" {
fmt.Printf(" GitTag: %s\n", version.GitTag)
}
fmt.Printf(" GoVersion: %s\n", version.GoVersion)
fmt.Printf(" Compiler: %s\n", version.Compiler)
fmt.Printf(" Platform: %s\n", version.Platform)
if version.ExtraBuildInfo != "" {
fmt.Printf(" ExtraBuildInfo: %s\n", version.ExtraBuildInfo)
}
},
}
versionCmd.Flags().BoolVar(&short, "short", false, "print just the version number")
return &versionCmd
}
// AddKubectlFlagsToCmd adds kubectl like flags to a persistent flags of a command and returns the ClientConfig interface
// for retrieving the values.
func AddKubectlFlagsToCmd(cmd *cobra.Command) clientcmd.ClientConfig {
return AddKubectlFlagsToSet(cmd.PersistentFlags())
}
// AddKubectlFlagsToSet adds kubectl like flags to a provided flag set and returns the ClientConfig interface
// for retrieving the values.
func AddKubectlFlagsToSet(flags *pflag.FlagSet) clientcmd.ClientConfig {
loadingRules := clientcmd.NewDefaultClientConfigLoadingRules()
loadingRules.DefaultClientConfig = &clientcmd.DefaultClientConfig
overrides := clientcmd.ConfigOverrides{}
kflags := clientcmd.RecommendedConfigOverrideFlags("")
flags.StringVar(&loadingRules.ExplicitPath, "kubeconfig", "", "Path to a kube config. Only required if out-of-cluster")
clientcmd.BindOverrideFlags(&overrides, flags, kflags)
return clientcmd.NewInteractiveDeferredLoadingClientConfig(loadingRules, &overrides, os.Stdin)
}
// PromptCredentials is a helper to prompt the user for a username and password (unless already supplied)
func PromptCredentials(username, password string) (string, string) {
return PromptUsername(username), PromptPassword(password)
}
// PromptUsername prompts the user for a username value
func PromptUsername(username string) string {
return PromptMessage("Username", username)
}
// PromptMessage prompts the user for a value (unless already supplied)
func PromptMessage(message, value string) string {
for value == "" {
reader := bufio.NewReader(os.Stdin)
fmt.Print(message + ": ")
valueRaw, err := reader.ReadString('\n')
errors.CheckError(err)
value = strings.TrimSpace(valueRaw)
}
return value
}
// PromptPassword prompts the user for a password, without local echo. (unless already supplied)
func PromptPassword(password string) string {
for password == "" {
fmt.Print("Password: ")
passwordRaw, err := terminal.ReadPassword(int(os.Stdin.Fd()))
errors.CheckError(err)
password = string(passwordRaw)
fmt.Print("\n")
}
return password
}
// AskToProceed prompts the user with a message (typically a yes or no question) and returns whether
// they responded in the affirmative or negative.
func AskToProceed(message string) bool {
for {
fmt.Print(message)
reader := bufio.NewReader(os.Stdin)
proceedRaw, err := reader.ReadString('\n')
errors.CheckError(err)
switch strings.ToLower(strings.TrimSpace(proceedRaw)) {
case "y", "yes":
return true
case "n", "no":
return false
}
}
}
// AskToProceedS prompts the user with a message (typically a yes, no or all question) and returns string
// "a", "y" or "n".
func AskToProceedS(message string) string {
for {
fmt.Print(message)
reader := bufio.NewReader(os.Stdin)
proceedRaw, err := reader.ReadString('\n')
errors.CheckError(err)
switch strings.ToLower(strings.TrimSpace(proceedRaw)) {
case "y", "yes":
return "y"
case "n", "no":
return "n"
case "a", "all":
return "a"
}
}
}
// ReadAndConfirmPassword is a helper to read and confirm a password from stdin
func ReadAndConfirmPassword(username string) (string, error) {
for {
fmt.Printf("*** Enter new password for user %s: ", username)
password, err := terminal.ReadPassword(int(os.Stdin.Fd()))
if err != nil {
return "", err
}
fmt.Print("\n")
fmt.Printf("*** Confirm new password for user %s: ", username)
confirmPassword, err := terminal.ReadPassword(int(os.Stdin.Fd()))
if err != nil {
return "", err
}
fmt.Print("\n")
if string(password) == string(confirmPassword) {
return string(password), nil
}
log.Error("Passwords do not match")
}
}
// SetLogFormat sets a logrus log format
func SetLogFormat(logFormat string) {
switch strings.ToLower(logFormat) {
case utillog.JsonFormat:
os.Setenv(common.EnvLogFormat, utillog.JsonFormat)
case utillog.TextFormat, "":
os.Setenv(common.EnvLogFormat, utillog.TextFormat)
default:
log.Fatalf("Unknown log format '%s'", logFormat)
}
log.SetFormatter(utillog.CreateFormatter(logFormat))
}
// SetLogLevel parses and sets a logrus log level
func SetLogLevel(logLevel string) {
level, err := log.ParseLevel(text.FirstNonEmpty(logLevel, log.InfoLevel.String()))
errors.CheckError(err)
os.Setenv(common.EnvLogLevel, level.String())
log.SetLevel(level)
}
// SetGLogLevel set the glog level for the k8s go-client
func SetGLogLevel(glogLevel int) {
klog.InitFlags(nil)
_ = flag.Set("logtostderr", "true")
_ = flag.Set("v", strconv.Itoa(glogLevel))
}
func writeToTempFile(pattern string, data []byte) string {
f, err := os.CreateTemp("", pattern)
errors.CheckError(err)
defer io.Close(f)
_, err = f.Write(data)
errors.CheckError(err)
return f.Name()
}
func stripComments(input []byte) []byte {
var stripped []byte
lines := bytes.Split(input, []byte("\n"))
for i, line := range lines {
if bytes.HasPrefix(bytes.TrimSpace(line), []byte("#")) {
continue
}
stripped = append(stripped, line...)
if i < len(lines)-1 {
stripped = append(stripped, '\n')
}
}
return stripped
}
const (
defaultEditor = "vi"
editorEnv = "EDITOR"
commentsHeader = `# Please edit the object below. Lines beginning with a '#' will be ignored,
# and an empty file will abort the edit. If an error occurs while saving this file will be
# reopened with the relevant failures."
`
)
func setComments(input []byte, comments string) []byte {
input = stripComments(input)
var commentLines []string
for _, line := range strings.Split(comments, "\n") {
if line != "" {
commentLines = append(commentLines, "# "+line)
}
}
parts := []string{commentsHeader}
if len(commentLines) > 0 {
parts = append(parts, strings.Join(commentLines, "\n"))
}
parts = append(parts, string(input))
return []byte(strings.Join(parts, "\n"))
}
// InteractiveEdit launches an interactive editor
func InteractiveEdit(filePattern string, data []byte, save func(input []byte) error) {
var editor string
var editorArgs []string
if overrideEditor := os.Getenv(editorEnv); overrideEditor == "" {
editor = defaultEditor
} else {
parts := strings.Fields(overrideEditor)
editor = parts[0]
editorArgs = parts[1:]
}
errorComment := ""
for {
data = setComments(data, errorComment)
tempFile := writeToTempFile(filePattern, data)
cmd := exec.Command(editor, append(editorArgs, tempFile)...)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Stdin = os.Stdin
err := (term.TTY{In: os.Stdin, TryDev: true}).Safe(cmd.Run)
errors.CheckError(err)
updated, err := os.ReadFile(tempFile)
errors.CheckError(err)
if string(updated) == "" || string(updated) == string(data) {
errors.CheckError(fmt.Errorf("edit cancelled, no valid changes were saved"))
break
} else {
data = stripComments(updated)
}
err = save(data)
if err == nil {
break
}
errorComment = err.Error()
}
}
// PrintDiff prints a diff between two unstructured objects to stdout using an external diff utility
// Honors the diff utility set in the KUBECTL_EXTERNAL_DIFF environment variable
func PrintDiff(name string, live *unstructured.Unstructured, target *unstructured.Unstructured) error {
tempDir, err := os.MkdirTemp("", "argocd-diff")
if err != nil {
return err
}
targetFile := path.Join(tempDir, name)
targetData := []byte("")
if target != nil {
targetData, err = yaml.Marshal(target)
if err != nil {
return err
}
}
err = os.WriteFile(targetFile, targetData, 0644)
if err != nil {
return err
}
liveFile := path.Join(tempDir, fmt.Sprintf("%s-live.yaml", name))
liveData := []byte("")
if live != nil {
liveData, err = yaml.Marshal(live)
if err != nil {
return err
}
}
err = os.WriteFile(liveFile, liveData, 0644)
if err != nil {
return err
}
cmdBinary := "diff"
var args []string
if envDiff := os.Getenv("KUBECTL_EXTERNAL_DIFF"); envDiff != "" {
parts, err := shlex.Split(envDiff)
if err != nil {
return err
}
cmdBinary = parts[0]
args = parts[1:]
}
cmd := exec.Command(cmdBinary, append(args, liveFile, targetFile)...)
cmd.Stderr = os.Stderr
cmd.Stdout = os.Stdout
return cmd.Run()
}