-
Notifications
You must be signed in to change notification settings - Fork 55
/
utils.go
516 lines (445 loc) · 12.1 KB
/
utils.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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
package coreutils
import (
"bytes"
"fmt"
"github.com/jfrog/gofrog/version"
"github.com/jfrog/jfrog-client-go/utils"
"github.com/jfrog/jfrog-client-go/utils/errorutils"
"github.com/jfrog/jfrog-client-go/utils/io/fileutils"
"github.com/jfrog/jfrog-client-go/utils/log"
"github.com/pkg/errors"
"os"
"os/exec"
"path/filepath"
"regexp"
"runtime"
"strings"
)
const (
GettingStartedGuideUrl = "https://github.com/jfrog/jfrog-cli/blob/v2/guides/getting-started-with-jfrog-using-the-cli.md"
)
type MinVersionProduct string
const (
Artifactory MinVersionProduct = "JFrog Artifactory"
Xray MinVersionProduct = "JFrog Xray"
DataTransfer MinVersionProduct = "Data Transfer"
DockerApi MinVersionProduct = "Docker API"
Projects MinVersionProduct = "JFrog Projects"
)
// Error modes (how should the application behave when the CheckError function is invoked):
type OnError string
var cliTempDir string
// User agent - the user of the program that uses this library (usually another program, or the same as the client agent), i.e 'jfrog-pipelines'
var cliUserAgentName string
var cliUserAgentVersion string
// Client agent - the program that uses this library, i.e 'jfrog-cli-go'
var clientAgentName string
var clientAgentVersion string
var cliExecutableName string
func init() {
// Initialize error handling.
if os.Getenv(ErrorHandling) == string(OnErrorPanic) {
errorutils.CheckError = PanicOnError
}
// Initialize the temp base-dir path of the CLI executions.
cliTempDir = os.Getenv(TempDir)
if cliTempDir == "" {
cliTempDir = os.TempDir()
}
fileutils.SetTempDirBase(cliTempDir)
}
func SetIfEmpty(str *string, defaultStr string) bool {
if *str == "" {
*str = defaultStr
return true
}
return false
}
func IsAnyEmpty(strings ...string) bool {
for _, str := range strings {
if str == "" {
return true
}
}
return false
}
// Exit codes:
type ExitCode struct {
Code int
}
var ExitCodeNoError = ExitCode{0}
var ExitCodeError = ExitCode{1}
var ExitCodeFailNoOp = ExitCode{2}
var ExitCodeVulnerableBuild = ExitCode{3}
type CliError struct {
ExitCode
ErrorMsg string
}
func (err CliError) Error() string {
return err.ErrorMsg
}
func PanicOnError(err error) error {
if err != nil {
panic(err)
}
return err
}
func ExitOnErr(err error) {
if err, ok := err.(CliError); ok {
traceExit(err.ExitCode, err)
}
if exitCode := GetExitCode(err, 0, 0, false); exitCode != ExitCodeNoError {
traceExit(exitCode, err)
}
}
func traceExit(exitCode ExitCode, err error) {
if err != nil && len(err.Error()) > 0 {
log.Error(err)
}
os.Exit(exitCode.Code)
}
func GetExitCode(err error, success, failed int, failNoOp bool) ExitCode {
// Error occurred - Return 1
if err != nil || failed > 0 {
return ExitCodeError
}
// No errors, but also no files affected - Return 2 if failNoOp
if success == 0 && failNoOp {
return ExitCodeFailNoOp
}
// Otherwise - Return 0
return ExitCodeNoError
}
// When running a command in an external process, if the command fails to run or doesn't complete successfully ExitError is returned.
// We would like to return a regular error instead of ExitError,
// because some frameworks (such as codegangsta used by JFrog CLI) automatically exit when this error is returned.
func ConvertExitCodeError(err error) error {
if _, ok := err.(*exec.ExitError); ok {
err = errors.New(err.Error())
}
return err
}
// GetCliConfigVersion returns the latest version of the config.yml file on the file system at '.jfrog'.
func GetCliConfigVersion() int {
return 6
}
// GetPluginsConfigVersion returns the latest plugins layout version on the file system (at '.jfrog/plugins').
func GetPluginsConfigVersion() int {
return 1
}
func SumTrueValues(boolArr []bool) int {
counter := 0
for _, val := range boolArr {
counter += utils.Bool2Int(val)
}
return counter
}
func SpecVarsStringToMap(rawVars string) map[string]string {
if len(rawVars) == 0 {
return nil
}
varCandidates := strings.Split(rawVars, ";")
varsList := []string{}
for _, v := range varCandidates {
if len(varsList) > 0 && isEndsWithEscapeChar(varsList[len(varsList)-1]) {
currentLastVar := varsList[len(varsList)-1]
varsList[len(varsList)-1] = strings.TrimSuffix(currentLastVar, "\\") + ";" + v
continue
}
varsList = append(varsList, v)
}
return varsAsMap(varsList)
}
func isEndsWithEscapeChar(lastVar string) bool {
return strings.HasSuffix(lastVar, "\\")
}
func varsAsMap(vars []string) map[string]string {
result := map[string]string{}
for _, v := range vars {
keyVal := strings.SplitN(v, "=", 2)
if len(keyVal) != 2 {
continue
}
result[keyVal[0]] = keyVal[1]
}
return result
}
func IsWindows() bool {
return runtime.GOOS == "windows"
}
func IsLinux() bool {
return runtime.GOOS == "linux"
}
// Return the path of CLI temp dir.
// This path should be persistent, meaning - should not be cleared at the end of a CLI run.
func GetCliPersistentTempDirPath() string {
return cliTempDir
}
func GetWorkingDirectory() (string, error) {
currentDir, err := os.Getwd()
if err != nil {
return "", errorutils.CheckError(err)
}
if currentDir, err = filepath.Abs(currentDir); err != nil {
return "", errorutils.CheckError(err)
}
return currentDir, nil
}
type Credentials interface {
SetUser(string)
SetPassword(string)
GetUser() string
GetPassword() string
}
func ReplaceVars(content []byte, specVars map[string]string) []byte {
log.Debug("Replacing variables in the provided content: \n" + string(content))
for key, val := range specVars {
key = "${" + key + "}"
log.Debug(fmt.Sprintf("Replacing '%s' with '%s'", key, val))
content = bytes.Replace(content, []byte(key), []byte(val), -1)
}
log.Debug("The reformatted content is: \n" + string(content))
return content
}
func GetJfrogHomeDir() (string, error) {
if os.Getenv(HomeDir) != "" {
return os.Getenv(HomeDir), nil
}
userHomeDir := fileutils.GetHomeDir()
if userHomeDir == "" {
err := errorutils.CheckErrorf("couldn't find home directory. Make sure your HOME environment variable is set")
if err != nil {
return "", err
}
}
return filepath.Join(userHomeDir, ".jfrog"), nil
}
func CreateDirInJfrogHome(dirName string) (string, error) {
homeDir, err := GetJfrogHomeDir()
if err != nil {
return "", err
}
folderName := filepath.Join(homeDir, dirName)
err = fileutils.CreateDirIfNotExist(folderName)
return folderName, err
}
func GetJfrogSecurityDir() (string, error) {
homeDir, err := GetJfrogHomeDir()
if err != nil {
return "", err
}
return filepath.Join(homeDir, JfrogSecurityDirName), nil
}
func GetJfrogCertsDir() (string, error) {
securityDir, err := GetJfrogSecurityDir()
if err != nil {
return "", err
}
return filepath.Join(securityDir, JfrogCertsDirName), nil
}
func GetJfrogSecurityConfFilePath() (string, error) {
securityDir, err := GetJfrogSecurityDir()
if err != nil {
return "", err
}
return filepath.Join(securityDir, JfrogSecurityConfFile), nil
}
func GetJfrogBackupDir() (string, error) {
homeDir, err := GetJfrogHomeDir()
if err != nil {
return "", err
}
return filepath.Join(homeDir, JfrogBackupDirName), nil
}
func GetJfrogPluginsDir() (string, error) {
homeDir, err := GetJfrogHomeDir()
if err != nil {
return "", err
}
return filepath.Join(homeDir, JfrogPluginsDirName), nil
}
func GetJfrogPluginsResourcesDir(pluginsName string) (string, error) {
pluginsDir, err := GetJfrogPluginsDir()
if err != nil {
return "", err
}
return filepath.Join(pluginsDir, pluginsName, PluginsResourcesDirName), nil
}
func GetPluginsDirContent() ([]os.DirEntry, error) {
pluginsDir, err := GetJfrogPluginsDir()
if err != nil {
return nil, err
}
exists, err := fileutils.IsDirExists(pluginsDir, false)
if err != nil || !exists {
return nil, err
}
content, err := os.ReadDir(pluginsDir)
return content, errorutils.CheckError(err)
}
func ChmodPluginsDirectoryContent() error {
plugins, err := GetPluginsDirContent()
if err != nil || plugins == nil {
return err
}
pluginsDir, err := GetJfrogPluginsDir()
if err != nil {
return err
}
for _, p := range plugins {
err = os.Chmod(filepath.Join(pluginsDir, p.Name()), 0777)
if err != nil {
return err
}
}
return nil
}
func GetJfrogLocksDir() (string, error) {
homeDir, err := GetJfrogHomeDir()
if err != nil {
return "", err
}
return filepath.Join(homeDir, JfrogLocksDirName), nil
}
func GetJfrogConfigLockDir() (string, error) {
configLockDirName := "config"
locksDirPath, err := GetJfrogLocksDir()
if err != nil {
return "", err
}
return filepath.Join(locksDirPath, configLockDirName), nil
}
func GetJfrogPluginsLockDir() (string, error) {
pluginsLockDirName := "plugins"
locksDirPath, err := GetJfrogLocksDir()
if err != nil {
return "", err
}
return filepath.Join(locksDirPath, pluginsLockDirName), nil
}
func GetJfrogTransferLockDir() (string, error) {
transferLockDirName := "transfer"
locksDirPath, err := GetJfrogLocksDir()
if err != nil {
return "", err
}
return filepath.Join(locksDirPath, transferLockDirName), nil
}
func GetJfrogTransferRunStatusFilePath() (string, error) {
transferDir, err := GetJfrogTransferDir()
if err != nil {
return "", err
}
return filepath.Join(transferDir, JfrogTransferRunStatusFileName), nil
}
func GetJfrogTransferRepositoriesDir() (string, error) {
transferDir, err := GetJfrogTransferDir()
if err != nil {
return "", err
}
return filepath.Join(transferDir, JfrogTransferRepositoriesDirName), nil
}
// Ask a yes or no question, with a default answer.
func AskYesNo(promptPrefix string, defaultValue bool) bool {
defStr := "[n]"
if defaultValue {
defStr = "[y]"
}
promptPrefix += " (y/n) " + defStr + "? "
var answer string
for {
fmt.Print(promptPrefix)
_, _ = fmt.Scanln(&answer)
parsed, valid := parseYesNo(answer, defaultValue)
if valid {
return parsed
}
log.Output("Please enter a valid option.")
}
}
func parseYesNo(s string, def bool) (ans, valid bool) {
s = strings.TrimSpace(s)
if s == "" {
return def, true
}
matchedYes, err := regexp.MatchString("^yes$|^y$", strings.ToLower(s))
if errorutils.CheckError(err) != nil {
log.Error(err)
return matchedYes, false
}
if matchedYes {
return true, true
}
matchedNo, err := regexp.MatchString("^no$|^n$", strings.ToLower(s))
if errorutils.CheckError(err) != nil {
log.Error(err)
return matchedNo, false
}
if matchedNo {
return false, true
}
return false, false
}
func GetCliUserAgent() string {
if cliUserAgentVersion == "" {
return cliUserAgentName
}
return fmt.Sprintf("%s/%s", cliUserAgentName, cliUserAgentVersion)
}
func SetCliUserAgentName(cliUserAgentNameToSet string) {
cliUserAgentName = cliUserAgentNameToSet
}
func GetCliUserAgentName() string {
return cliUserAgentName
}
func SetCliUserAgentVersion(versionToSet string) {
cliUserAgentVersion = versionToSet
}
func GetCliUserAgentVersion() string {
return cliUserAgentVersion
}
func SetClientAgentName(clientAgentToSet string) {
clientAgentName = clientAgentToSet
}
func GetClientAgentName() string {
return clientAgentName
}
func SetClientAgentVersion(versionToSet string) {
clientAgentVersion = versionToSet
}
func GetClientAgentVersion() string {
return clientAgentVersion
}
func SetCliExecutableName(executableName string) {
cliExecutableName = executableName
}
func GetCliExecutableName() string {
return cliExecutableName
}
// Turn a list of strings into a sentence.
// For example, turn ["one", "two", "three"] into "one, two and three".
// For a single element: "one".
func ListToText(list []string) string {
if len(list) == 1 {
return list[0]
}
return strings.Join(list[0:len(list)-1], ", ") + " and " + list[len(list)-1]
}
func RemoveAllWhiteSpaces(input string) string {
return strings.Join(strings.Fields(input), "")
}
func GetJfrogTransferDir() (string, error) {
homeDir, err := GetJfrogHomeDir()
if err != nil {
return "", err
}
return filepath.Join(homeDir, JfrogTransferDirName), nil
}
func ValidateMinimumVersion(product MinVersionProduct, currentVersion, minimumVersion string) error {
if !version.NewVersion(currentVersion).AtLeast(minimumVersion) {
return errorutils.CheckErrorf(fmt.Sprintf("You are using %s version %s,"+
" while this operation requires version %s or higher.",
product, currentVersion, minimumVersion))
}
return nil
}