[PLAT-16887][YBA CLI]Add Linter to CLI project

Summary: Add a linter to the YBA CLI project Use `make fmt` in the root directory for formatting Test Plan: Run `make fmt` Reviewers: sneelakantan Reviewed By: sneelakantan Differential Revision: https://phorge.dev.yugabyte.com/D42103
yugabyte · Feb 25, 2025 · 6f43969 · 6f43969
1 parent c670ee6
commit 6f43969
Show file tree

Hide file tree

Showing 90 changed files with 963 additions and 460 deletions.
diff --git a/.arclint b/.arclint
@@ -58,7 +58,7 @@
      },
      "go-files-length": {
          "type": "text",
-         "text.max-line-length": 100,
+        "text.max-line-length": 120,
          "include": "(^managed/yba-cli/.*[.]go$)",
          "severity": {
              "2": "disabled"

diff --git a/managed/yba-cli/GNUmakefile b/managed/yba-cli/GNUmakefile
@@ -1,5 +1,6 @@
 TOP_BUILDDIR ?= .
 DEVOPS_HOME=$(CURDIR)/../devops
+GOLINES := ./bin/golines
 
 
 VERSION_NUMBER ?= $(shell cat $(CURDIR)/version_metadata.json | jq '.version_number')
@@ -91,3 +92,9 @@ build:
 .PHONY: license
 license:
 	./licenses/generate-license-file.sh
+
+.PHONY: fmt
+fmt:
+	go clean -modcache
+	GOBIN=$(PWD)/bin go install github.com/segmentio/golines@latest
+	$(GOLINES) --max-len=100 -w .
diff --git a/managed/yba-cli/cmd/backup/create_backup.go b/managed/yba-cli/cmd/backup/create_backup.go
@@ -49,7 +49,11 @@ var createBackupCmd = &cobra.Command{
 		if len(strings.TrimSpace(storageConfigNameFlag)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No storage config name found to take a backup\n", formatter.RedColor))
+				formatter.Colorize(
+					"No storage config name found to take a backup\n",
+					formatter.RedColor,
+				),
+			)
 		}
 
 		tableTypeFlag, err := cmd.Flags().GetString("table-type")
@@ -59,7 +63,11 @@ var createBackupCmd = &cobra.Command{
 		if len(strings.TrimSpace(tableTypeFlag)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("Table type not specified to take a backup\n", formatter.RedColor))
+				formatter.Colorize(
+					"Table type not specified to take a backup\n",
+					formatter.RedColor,
+				),
+			)
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {
@@ -76,7 +84,12 @@ var createBackupCmd = &cobra.Command{
 
 		r, response, err := universeListRequest.Execute()
 		if err != nil {
-			errMessage := util.ErrorFromHTTPResponse(response, err, "Backup", "Create - Get Universe")
+			errMessage := util.ErrorFromHTTPResponse(
+				response,
+				err,
+				"Backup",
+				"Create - Get Universe",
+			)
 			logrus.Fatalf(formatter.Colorize(errMessage.Error()+"\n", formatter.RedColor))
 		}
 
@@ -252,8 +265,17 @@ var createBackupCmd = &cobra.Command{
 
 		if viper.GetBool("wait") {
 			if taskUUID != "" {
-				logrus.Info(fmt.Sprintf("\nWaiting for backup task %s on universe %s (%s) to be completed\n",
-					formatter.Colorize(taskUUID, formatter.GreenColor), universeNameFlag, universeUUID))
+				logrus.Info(
+					fmt.Sprintf(
+						"\nWaiting for backup task %s on universe %s (%s) to be completed\n",
+						formatter.Colorize(
+							taskUUID,
+							formatter.GreenColor,
+						),
+						universeNameFlag,
+						universeUUID,
+					),
+				)
 				err = authAPI.WaitForTask(taskUUID, msg)
 				if err != nil {
 					logrus.Fatalf(formatter.Colorize(err.Error()+"\n", formatter.RedColor))
@@ -262,7 +284,12 @@ var createBackupCmd = &cobra.Command{
 			backupTaskRequest := authAPI.GetBackupByTaskUUID(universeUUID, taskUUID)
 			rBackup, response, err := backupTaskRequest.Execute()
 			if err != nil {
-				errMessage := util.ErrorFromHTTPResponse(response, err, "Backup", "Create - Get Backup")
+				errMessage := util.ErrorFromHTTPResponse(
+					response,
+					err,
+					"Backup",
+					"Create - Get Backup",
+				)
 				logrus.Fatalf(formatter.Colorize(errMessage.Error()+"\n", formatter.RedColor))
 			}
 			backupUUID := rBackup[0].GetBackupUUID()
@@ -295,7 +322,12 @@ var createBackupCmd = &cobra.Command{
 			backupListRequest := authAPI.ListBackups().PageBackupsRequest(backupAPIQuery)
 			r, response, err := backupListRequest.Execute()
 			if err != nil {
-				errMessage := util.ErrorFromHTTPResponse(response, err, "Backup", "Create - Describe Backup")
+				errMessage := util.ErrorFromHTTPResponse(
+					response,
+					err,
+					"Backup",
+					"Create - Describe Backup",
+				)
 				logrus.Fatalf(formatter.Colorize(errMessage.Error()+"\n", formatter.RedColor))
 			}
 

diff --git a/managed/yba-cli/cmd/backup/delete_backup.go b/managed/yba-cli/cmd/backup/delete_backup.go
@@ -31,7 +31,11 @@ var deleteBackupCmd = &cobra.Command{
 		if len(backupInfoArray) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No backup info specified to delete backup(s)\n", formatter.RedColor))
+				formatter.Colorize(
+					"No backup info specified to delete backup(s)\n",
+					formatter.RedColor,
+				),
+			)
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {

diff --git a/managed/yba-cli/cmd/backup/describe_backup.go b/managed/yba-cli/cmd/backup/describe_backup.go
@@ -34,7 +34,11 @@ var describeBackupCmd = &cobra.Command{
 		if len(backupUUID) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No backup UUID specified to describe backup\n", formatter.RedColor))
+				formatter.Colorize(
+					"No backup UUID specified to describe backup\n",
+					formatter.RedColor,
+				),
+			)
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {

diff --git a/managed/yba-cli/cmd/backup/edit_backup.go b/managed/yba-cli/cmd/backup/edit_backup.go
@@ -51,7 +51,8 @@ var editBackupCmd = &cobra.Command{
 
 		if cmd.Flags().Changed("time-before-delete-in-ms") {
 			logrus.Debugf("Updating time-before-delete-in-ms")
-			timeBeforeDeleteFromPresentInMillis, err := cmd.Flags().GetInt64("time-before-delete-in-ms")
+			timeBeforeDeleteFromPresentInMillis, err := cmd.Flags().
+				GetInt64("time-before-delete-in-ms")
 			if err != nil {
 				logrus.Fatalf(formatter.Colorize(err.Error()+"\n", formatter.RedColor))
 			}
@@ -137,7 +138,12 @@ var editBackupCmd = &cobra.Command{
 		backupListRequest := authAPI.ListBackups().PageBackupsRequest(backupAPIQuery)
 		r, response, err := backupListRequest.Execute()
 		if err != nil {
-			errMessage := util.ErrorFromHTTPResponse(response, err, "Backup", "Edit - Describe Backup")
+			errMessage := util.ErrorFromHTTPResponse(
+				response,
+				err,
+				"Backup",
+				"Edit - Describe Backup",
+			)
 			logrus.Fatalf(formatter.Colorize(errMessage.Error()+"\n", formatter.RedColor))
 		}
 

diff --git a/managed/yba-cli/cmd/backup/list_incremental_backup.go b/managed/yba-cli/cmd/backup/list_incremental_backup.go
@@ -32,7 +32,11 @@ var listIncrementalBackupsCmd = &cobra.Command{
 		if len(backupUUID) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No backup UUID specified to list incremental backup\n", formatter.RedColor))
+				formatter.Colorize(
+					"No backup UUID specified to list incremental backup\n",
+					formatter.RedColor,
+				),
+			)
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {

diff --git a/managed/yba-cli/cmd/backup/restore/create_restore.go b/managed/yba-cli/cmd/backup/restore/create_restore.go
@@ -41,7 +41,11 @@ var createRestoreCmd = &cobra.Command{
 		if len(strings.TrimSpace(universeNameFlag)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No universe name found to restore backup to\n", formatter.RedColor))
+				formatter.Colorize(
+					"No universe name found to restore backup to\n",
+					formatter.RedColor,
+				),
+			)
 		}
 
 		storageConfigNameFlag, err := cmd.Flags().GetString("storage-config-name")
@@ -51,7 +55,11 @@ var createRestoreCmd = &cobra.Command{
 		if len(strings.TrimSpace(storageConfigNameFlag)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No storage config name found for restore\n", formatter.RedColor))
+				formatter.Colorize(
+					"No storage config name found for restore\n",
+					formatter.RedColor,
+				),
+			)
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {
@@ -68,7 +76,12 @@ var createRestoreCmd = &cobra.Command{
 
 		r, response, err := universeListRequest.Execute()
 		if err != nil {
-			errMessage := util.ErrorFromHTTPResponse(response, err, "Restore", "Create - Get Universe")
+			errMessage := util.ErrorFromHTTPResponse(
+				response,
+				err,
+				"Restore",
+				"Create - Get Universe",
+			)
 			logrus.Fatalf(formatter.Colorize(errMessage.Error()+"\n", formatter.RedColor))
 		}
 
@@ -194,8 +207,17 @@ var createRestoreCmd = &cobra.Command{
 
 		if viper.GetBool("wait") {
 			if taskUUID != "" {
-				logrus.Info(fmt.Sprintf("\nWaiting for restore task %s on universe %s (%s) to be completed\n",
-					formatter.Colorize(taskUUID, formatter.GreenColor), universeNameFlag, universeUUID))
+				logrus.Info(
+					fmt.Sprintf(
+						"\nWaiting for restore task %s on universe %s (%s) to be completed\n",
+						formatter.Colorize(
+							taskUUID,
+							formatter.GreenColor,
+						),
+						universeNameFlag,
+						universeUUID,
+					),
+				)
 				err = authAPI.WaitForTask(taskUUID, msg)
 				if err != nil {
 					logrus.Fatalf(formatter.Colorize(err.Error()+"\n", formatter.RedColor))
@@ -275,7 +297,8 @@ func buildBackupInfoList(backupInfos []string) (res []ybaclient.BackupStorageInf
 					backupDetails["storage-location"] = val
 				}
 			case "backup-type":
-				if !strings.EqualFold(val, "ysql") && !strings.EqualFold(val, "ycql") && !strings.EqualFold(val, "yedis") {
+				if !strings.EqualFold(val, "ysql") && !strings.EqualFold(val, "ycql") &&
+					!strings.EqualFold(val, "yedis") {
 					logrus.Fatalf(fmt.Sprintf("Table type provided %s is not supported", val))
 				}
 

diff --git a/managed/yba-cli/cmd/backup/schedule/create_backup_schedule.go b/managed/yba-cli/cmd/backup/schedule/create_backup_schedule.go
@@ -38,7 +38,11 @@ var createBackupScheduleCmd = &cobra.Command{
 		if len(strings.TrimSpace(scheduleName)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No schedule name specified to create a backup schedule\n", formatter.RedColor))
+				formatter.Colorize(
+					"No schedule name specified to create a backup schedule\n",
+					formatter.RedColor,
+				),
+			)
 		}
 
 		universeNameFlag, err := cmd.Flags().GetString("universe-name")
@@ -48,7 +52,11 @@ var createBackupScheduleCmd = &cobra.Command{
 		if len(strings.TrimSpace(universeNameFlag)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No universe name found to create a backup schedule\n", formatter.RedColor))
+				formatter.Colorize(
+					"No universe name found to create a backup schedule\n",
+					formatter.RedColor,
+				),
+			)
 		}
 
 		storageConfigNameFlag, err := cmd.Flags().GetString("storage-config-name")
@@ -58,7 +66,11 @@ var createBackupScheduleCmd = &cobra.Command{
 		if len(strings.TrimSpace(storageConfigNameFlag)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("No storage config name found to create a backup schedule\n", formatter.RedColor))
+				formatter.Colorize(
+					"No storage config name found to create a backup schedule\n",
+					formatter.RedColor,
+				),
+			)
 		}
 
 		tableTypeFlag, err := cmd.Flags().GetString("table-type")
@@ -68,7 +80,11 @@ var createBackupScheduleCmd = &cobra.Command{
 		if len(strings.TrimSpace(tableTypeFlag)) == 0 {
 			cmd.Help()
 			logrus.Fatalln(
-				formatter.Colorize("Table type not specified to create a backup schedule\n", formatter.RedColor))
+				formatter.Colorize(
+					"Table type not specified to create a backup schedule\n",
+					formatter.RedColor,
+				),
+			)
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {
@@ -210,8 +226,11 @@ var createBackupScheduleCmd = &cobra.Command{
 
 		if scheduleFrequencyInSecs == 0 && len(strings.TrimSpace(cronExpression)) == 0 {
 			logrus.Fatalln(
-				formatter.Colorize("Neither frequency of the schedule nor cron expression are provided",
-					formatter.RedColor))
+				formatter.Colorize(
+					"Neither frequency of the schedule nor cron expression are provided",
+					formatter.RedColor,
+				),
+			)
 		}
 		frequencyTimeUnit := "MINUTES"
 
@@ -253,7 +272,8 @@ var createBackupScheduleCmd = &cobra.Command{
 			requestBody.SetCronExpression(cronExpression)
 		}
 
-		incrementalBackupFrequencyInSecs, err := cmd.Flags().GetInt64("incremental-backup-frequency-in-secs")
+		incrementalBackupFrequencyInSecs, err := cmd.Flags().
+			GetInt64("incremental-backup-frequency-in-secs")
 		if err != nil {
 			logrus.Fatalf(formatter.Colorize(err.Error()+"\n", formatter.RedColor))
 		}
@@ -279,7 +299,13 @@ var createBackupScheduleCmd = &cobra.Command{
 			if taskUUID != "" {
 				logrus.Info(fmt.Sprintf(
 					"\nWaiting for backup schedule %s creation on universe %s (%s) to be completed\n",
-					formatter.Colorize(scheduleName, formatter.GreenColor), universeNameFlag, universeUUID))
+					formatter.Colorize(
+						scheduleName,
+						formatter.GreenColor,
+					),
+					universeNameFlag,
+					universeUUID,
+				))
 				err = authAPI.WaitForTask(taskUUID, msg)
 				if err != nil {
 					logrus.Fatalf(formatter.Colorize(err.Error()+"\n", formatter.RedColor))

diff --git a/managed/yba-cli/cmd/backup/schedule/delete_backup_schedule.go b/managed/yba-cli/cmd/backup/schedule/delete_backup_schedule.go
@@ -132,7 +132,8 @@ var deleteBackupScheduleCmd = &cobra.Command{
 
 			// Prepare next page request
 			scheduleAPIQuery.Offset = offset
-			scheduleListRequest = authAPI.ListBackupSchedules().PageScheduleRequest(scheduleAPIQuery)
+			scheduleListRequest = authAPI.ListBackupSchedules().
+				PageScheduleRequest(scheduleAPIQuery)
 		}
 
 		if len(scheduleUUID) == 0 {

diff --git a/managed/yba-cli/cmd/ear/aws/update_ear.go b/managed/yba-cli/cmd/ear/aws/update_ear.go
@@ -82,7 +82,8 @@ var updateAWSEARCmd = &cobra.Command{
 		if err != nil {
 			logrus.Fatalf(formatter.Colorize(err.Error()+"\n", formatter.RedColor))
 		}
-		if len(strings.TrimSpace(accessKeyID)) != 0 && len(strings.TrimSpace(secretAccessKey)) != 0 {
+		if len(strings.TrimSpace(accessKeyID)) != 0 &&
+			len(strings.TrimSpace(secretAccessKey)) != 0 {
 			logrus.Debug("Updating AWS credentials\n")
 			hasUpdates = true
 			requestBody[util.AWSAccessKeyEnv] = accessKeyID

diff --git a/managed/yba-cli/cmd/ear/earutil/deleteearutil.go b/managed/yba-cli/cmd/ear/earutil/deleteearutil.go
@@ -66,7 +66,12 @@ func DeleteEARUtil(cmd *cobra.Command, commandCall, earCode string) {
 		if len(strings.TrimSpace(commandCall)) != 0 {
 			callSite = fmt.Sprintf("%s: %s", callSite, commandCall)
 		}
-		errMessage := util.ErrorFromHTTPResponse(response, err, callSite, "Delete - List KMS Configs")
+		errMessage := util.ErrorFromHTTPResponse(
+			response,
+			err,
+			callSite,
+			"Delete - List KMS Configs",
+		)
 		logrus.Fatalf(formatter.Colorize(errMessage.Error()+"\n", formatter.RedColor))
 	}
 

diff --git a/managed/yba-cli/cmd/ear/earutil/updatearutil.go b/managed/yba-cli/cmd/ear/earutil/updatearutil.go
@@ -131,8 +131,11 @@ func GetEARConfig(
 	if len(r) < 1 {
 		logrus.Fatalf(
 			formatter.Colorize(
-				fmt.Sprintf("No encryption at rest configurations with name: %s and code %s found\n",
-					earName, earCode),
+				fmt.Sprintf(
+					"No encryption at rest configurations with name: %s and code %s found\n",
+					earName,
+					earCode,
+				),
 				formatter.RedColor,
 			))
 	}

diff --git a/managed/yba-cli/cmd/ear/hashicorp/create_ear.go b/managed/yba-cli/cmd/ear/hashicorp/create_ear.go
@@ -127,7 +127,12 @@ var createHashicorpVaultEARCmd = &cobra.Command{
 		rTask, response, err := authAPI.CreateKMSConfig(util.HashicorpVaultEARType).
 			KMSConfig(requestBody).Execute()
 		if err != nil {
-			errMessage := util.ErrorFromHTTPResponse(response, err, "EAR: Hashicorp Vault", "Create")
+			errMessage := util.ErrorFromHTTPResponse(
+				response,
+				err,
+				"EAR: Hashicorp Vault",
+				"Create",
+			)
 			logrus.Fatalf(formatter.Colorize(errMessage.Error()+"\n", formatter.RedColor))
 		}