fix: replace service account "name" with "short description"

BREAKING CHANGE: The service account `long description` field is removed
and the `name` has been re-labeled to `short description`

Author: Enda Phelan

pkg/cmd/serviceaccount/create/create.go

@@ -6,6 +6,7 @@ import (
 	"os"
 
 	"github.com/redhat-developer/app-services-cli/pkg/icon"
+	"github.com/redhat-developer/app-services-cli/pkg/ioutil/spinner"
 
 	"github.com/redhat-developer/app-services-cli/pkg/localize"
 	"github.com/redhat-developer/app-services-cli/pkg/serviceaccount/validation"
@@ -33,11 +34,10 @@ type options struct {
 	localizer  localize.Localizer
 	Context    context.Context
 
-	fileFormat  string
-	overwrite   bool
-	name        string
-	description string
-	filename    string
+	fileFormat       string
+	overwrite        bool
+	shortDescription string
+	filename         string
 
 	interactive bool
 }
@@ -60,9 +60,9 @@ func NewCreateCommand(f *factory.Factory) *cobra.Command {
 		Example: opts.localizer.MustLocalize("serviceAccount.create.cmd.example"),
 		Args:    cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, _ []string) (err error) {
-			if !opts.IO.CanPrompt() && opts.name == "" {
+			if !opts.IO.CanPrompt() && opts.shortDescription == "" {
 				return opts.localizer.MustLocalizeError("flag.error.requiredWhenNonInteractive", localize.NewEntry("Flag", "name"))
-			} else if opts.name == "" && opts.description == "" {
+			} else if opts.shortDescription == "" {
 				opts.interactive = true
 			}
 
@@ -75,10 +75,7 @@ func NewCreateCommand(f *factory.Factory) *cobra.Command {
 					return opts.localizer.MustLocalizeError("flag.error.requiredWhenNonInteractive", localize.NewEntry("Flag", "file-format"))
 				}
 
-				if err = validator.ValidateName(opts.name); err != nil {
-					return err
-				}
-				if err = validator.ValidateDescription(opts.description); err != nil {
+				if err = validator.ValidateShortDescription(opts.shortDescription); err != nil {
 					return err
 				}
 			}
@@ -93,8 +90,7 @@ func NewCreateCommand(f *factory.Factory) *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVar(&opts.name, "name", "", opts.localizer.MustLocalize("serviceAccount.create.flag.name.description"))
-	cmd.Flags().StringVar(&opts.description, "description", "", opts.localizer.MustLocalize("serviceAccount.create.flag.description.description"))
+	cmd.Flags().StringVar(&opts.shortDescription, "short-description", "", opts.localizer.MustLocalize("serviceAccount.create.flag.shortDescription.description"))
 	cmd.Flags().BoolVar(&opts.overwrite, "overwrite", false, opts.localizer.MustLocalize("serviceAccount.common.flag.overwrite.description"))
 	cmd.Flags().StringVar(&opts.filename, "output-file", "", opts.localizer.MustLocalize("serviceAccount.common.flag.fileLocation.description"))
 	cmd.Flags().StringVar(&opts.fileFormat, "file-format", "", opts.localizer.MustLocalize("serviceAccount.common.flag.fileFormat.description"))
@@ -110,6 +106,10 @@ func runCreate(opts *options) error {
 	if err != nil {
 		return err
 	}
+	cfg, err := opts.Config.Load()
+	if err != nil {
+		return err
+	}
 
 	if opts.interactive {
 		// run the create command interactively
@@ -129,23 +129,29 @@ func runCreate(opts *options) error {
 		return opts.localizer.MustLocalizeError("serviceAccount.common.error.credentialsFileAlreadyExists", localize.NewEntry("FilePath", opts.filename))
 	}
 
+	spinner := spinner.New(opts.IO.ErrOut, opts.localizer)
+	spinner.SetSuffix(opts.localizer.MustLocalize("serviceAccount.create.log.info.creating"))
+	spinner.Start()
 	// create the service account
-	serviceAccountPayload := &kafkamgmtclient.ServiceAccountRequest{Name: opts.name, Description: &opts.description}
+	serviceAccountPayload := kafkamgmtclient.ServiceAccountRequest{Name: opts.shortDescription}
 
-	a := conn.API().ServiceAccount().CreateServiceAccount(opts.Context)
-	a = a.ServiceAccountRequest(*serviceAccountPayload)
-	serviceacct, _, err := a.Execute()
-	if err != nil {
-		return err
-	}
+	serviceacct, httpRes, err := conn.API().
+		ServiceAccount().
+		CreateServiceAccount(opts.Context).
+		ServiceAccountRequest(serviceAccountPayload).
+		Execute()
+	spinner.Stop()
 
-	opts.Logger.Info(icon.SuccessPrefix(), opts.localizer.MustLocalize("serviceAccount.create.log.info.createdSuccessfully", localize.NewEntry("ID", serviceacct.GetId()), localize.NewEntry("Name", serviceacct.GetName())))
+	if httpRes != nil {
+		defer httpRes.Body.Close()
+	}
 
-	cfg, err := opts.Config.Load()
 	if err != nil {
 		return err
 	}
 
+	opts.Logger.Info(icon.SuccessPrefix(), opts.localizer.MustLocalize("serviceAccount.create.log.info.createdSuccessfully", localize.NewEntry("ID", serviceacct.GetId())))
+
 	creds := &credentials.Credentials{
 		ClientID:     serviceacct.GetClientId(),
 		ClientSecret: serviceacct.GetClientSecret(),
@@ -158,7 +164,7 @@ func runCreate(opts *options) error {
 		return fmt.Errorf("%v: %w", opts.localizer.MustLocalize("serviceAccount.common.error.couldNotSaveCredentialsFile"), err)
 	}
 
-	opts.Logger.Info(opts.localizer.MustLocalize("serviceAccount.common.log.info.credentialsSaved", localize.NewEntry("FilePath", opts.filename)))
+	opts.Logger.Info(icon.SuccessPrefix(), opts.localizer.MustLocalize("serviceAccount.common.log.info.credentialsSaved", localize.NewEntry("FilePath", opts.filename)))
 
 	return nil
 }
@@ -176,11 +182,11 @@ func runInteractivePrompt(opts *options) (err error) {
 	opts.Logger.Debug(opts.localizer.MustLocalize("common.log.debug.startingInteractivePrompt"))
 
 	promptName := &survey.Input{
-		Message: opts.localizer.MustLocalize("serviceAccount.create.input.name.message"),
-		Help:    opts.localizer.MustLocalize("serviceAccount.create.input.name.help"),
+		Message: opts.localizer.MustLocalize("serviceAccount.create.input.shortDescription.message"),
+		Help:    opts.localizer.MustLocalize("serviceAccount.create.input.shortDescription.help"),
 	}
 
-	err = survey.AskOne(promptName, &opts.name, survey.WithValidator(survey.Required), survey.WithValidator(validator.ValidateName))
+	err = survey.AskOne(promptName, &opts.shortDescription, survey.WithValidator(survey.Required), survey.WithValidator(validator.ValidateShortDescription))
 	if err != nil {
 		return err
 	}
@@ -207,17 +213,5 @@ func runInteractivePrompt(opts *options) (err error) {
 		return err
 	}
 
-	promptDescription := &survey.Multiline{
-		Message: opts.localizer.MustLocalize("serviceAccount.create.input.description.message"),
-		Help:    opts.localizer.MustLocalize("serviceAccount.create.flag.description.description"),
-	}
-
-	err = survey.AskOne(promptDescription, &opts.description, survey.WithValidator(validator.ValidateDescription))
-	if err != nil {
-		return err
-	}
-
-	opts.Logger.Info(opts.localizer.MustLocalize("serviceAccount.create.log.info.creating", localize.NewEntry("Name", opts.name)))
-
 	return nil
 }

pkg/cmd/serviceaccount/list/list.go

@@ -30,8 +30,8 @@ type options struct {
 // populate the list of service accounts into a table row
 type svcAcctRow struct {
 	ID        string `json:"id" header:"ID"`
-	Name      string `json:"name" header:"Name"`
 	ClientID  string `json:"clientID" header:"Client ID"`
+	Name      string `json:"name" header:"Short Description"`
 	Owner     string `json:"owner" header:"Owner"`
 	CreatedAt string `json:"createdAt" header:"Created At"`
 }

pkg/cmd/serviceaccount/resetcredentials/reset_credentials.go

@@ -9,6 +9,7 @@ import (
 	kafkamgmtclient "github.com/redhat-developer/app-services-sdk-go/kafkamgmt/apiv1/client"
 
 	"github.com/redhat-developer/app-services-cli/pkg/connection"
+	"github.com/redhat-developer/app-services-cli/pkg/icon"
 	"github.com/redhat-developer/app-services-cli/pkg/localize"
 
 	"github.com/AlecAivazis/survey/v2"
@@ -153,10 +154,10 @@ func runResetCredentials(opts *options) (err error) {
 
 	updatedServiceAccount, err := resetCredentials(serviceAcctName, opts)
 	if err != nil {
-		return fmt.Errorf("%v: %w", opts.localizer.MustLocalize("serviceAccount.resetCredentials.error.resetError", localize.NewEntry("Name", updatedServiceAccount.GetName())), err)
+		return fmt.Errorf("%v: %w", opts.localizer.MustLocalize("serviceAccount.resetCredentials.error.resetError", localize.NewEntry("ID", opts.id)), err)
 	}
 
-	opts.Logger.Info(opts.localizer.MustLocalize("serviceAccount.resetCredentials.log.info.resetSuccess", localize.NewEntry("Name", updatedServiceAccount.GetName())))
+	opts.Logger.Info(icon.SuccessPrefix(), opts.localizer.MustLocalize("serviceAccount.resetCredentials.log.info.resetSuccess", localize.NewEntry("ID", updatedServiceAccount.GetId())))
 
 	cfg, err := opts.Config.Load()
 	if err != nil {
@@ -175,7 +176,7 @@ func runResetCredentials(opts *options) (err error) {
 		return err
 	}
 
-	opts.Logger.Info(opts.localizer.MustLocalize("serviceAccount.common.log.info.credentialsSaved", localize.NewEntry("FilePath", opts.filename)))
+	opts.Logger.Info(icon.SuccessPrefix(), opts.localizer.MustLocalize("serviceAccount.common.log.info.credentialsSaved", localize.NewEntry("FilePath", opts.filename)))
 
 	return nil
 }
@@ -189,7 +190,7 @@ func resetCredentials(name string, opts *options) (*kafkamgmtclient.ServiceAccou
 	// check if the service account exists
 	api := conn.API()
 
-	opts.Logger.Debug(opts.localizer.MustLocalize("serviceAccount.resetCredentials.log.debug.resettingCredentials", localize.NewEntry("Name", name)))
+	opts.Logger.Debug(opts.localizer.MustLocalize("serviceAccount.resetCredentials.log.debug.resettingCredentials", localize.NewEntry("ID", opts.id)))
 
 	serviceacct, httpRes, err := api.ServiceAccount().ResetServiceAccountCreds(opts.Context, opts.id).Execute()
 	if httpRes != nil {

pkg/icon/icon.go

@@ -1,6 +1,10 @@
 package icon
 
-import "runtime"
+import (
+	"runtime"
+
+	"github.com/redhat-developer/app-services-cli/pkg/color"
+)
 
 const (
 	CrossMark = "\u274c"
@@ -18,7 +22,7 @@ func Emoji(emoji string, fallback string) string {
 
 // SuccessPrefix returns check mark emoji prefix
 func SuccessPrefix() string {
-	return Emoji(CheckMark, "")
+	return color.Success(Emoji(CheckMark, ""))
 }
 
 // ErrorPrefix returns cross mark emoji prefix or default "Error:"

pkg/localize/locales/en/cmd/serviceaccount.en.toml

@@ -79,13 +79,13 @@ one = 'Sets a custom file location to save the credentials'
 description = 'debug message'
 one = '--file-format flag is not set, prompting user to enter a value'
 
-[serviceAccount.common.validation.name.error.required]
+[serviceAccount.common.validation.shortDescription.error.required]
 one = 'service account name is required'
 
-[serviceAccount.common.validation.name.error.lengthError]
+[serviceAccount.common.validation.shortDescription.error.lengthError]
 one = 'service account name cannot exceed {{.MaxNameLen}} characters'
 
-[serviceAccount.common.validation.name.error.invalidChars]
+[serviceAccount.common.validation.shortDescription.error.invalidChars]
 one = 'invalid service account name "{{.Name}}"; only lowercase letters (a-z), numbers, and "-" are accepted'
 
 [serviceAccount.common.validation.description.error.invalidChars]

pkg/localize/locales/en/cmd/serviceaccount_create.en.toml

@@ -32,40 +32,30 @@ $ rhoas service-account create --overwrite
 $ rhoas service-account create --output-file=./service-acct-credentials.json
 '''
 
-[serviceAccount.create.flag.name.description]
-description = 'Description for --name flag'
-one = 'Name of the service account'
-
-[serviceAccount.create.flag.description.description]
-description = 'Description for --description flag'
-one = "Description for the service account (only alphanumeric characters and '-', '.', ',' are valid)"
+[serviceAccount.create.flag.shortDescription.description]
+description = 'Description for --short-description flag'
+one = 'Short description of the service account'
 
 [serviceAccount.create.error.couldNotCreate]
 description = 'Error message when service account could not be created'
 one = 'could not create service account'
 
 [serviceAccount.create.log.info.creating]
-one = 'Creating service account "{{.Name}}"'
+one = 'Creating service account'
 
 [serviceAccount.create.log.info.createdSuccessfully]
-one = 'Service account "{{.Name}}" created successfully with ID "{{.ID}}".'
+one = 'Service account created successfully with ID "{{.ID}}"'
 
-[serviceAccount.create.input.name.message]
-description = 'title for the Name input'
-one = "Name:"
+[serviceAccount.create.input.shortDescription.message]
+one = "Short Description:"
 
-[serviceAccount.create.input.name.help]
-description = 'help for the Name input'
-one = "Give your service account an easily identifiable name"
+[serviceAccount.create.input.shortDescription.help]
+one = "Provide a short description for your service account"
 
 [serviceAccount.create.input.fileFormat.message]
 description = 'Title for credentials format input'
 one = 'Credentials file format:'
 
 [serviceAccount.create.input.fileFormat.help]
 description = 'Help for credentials format input'
-one = 'File format in which to save the service account credentials:'
-
-[serviceAccount.create.input.description.message]
-description = 'Message for service account description'
-one = 'Description [optional]:'
+one = 'File format in which to save the service account credentials:'

pkg/localize/locales/en/cmd/serviceaccount_reset_credentials.en.toml

@@ -38,9 +38,6 @@ one = 'Skip confirmation to forcibly reset service account credentials'
 description = 'Error message when service account could not be created'
 one = 'could not create service account'
 
-[serviceAccount.resetCredentials.log.info.createdSuccessfully]
-one = 'Service account "{{.Name}}" created successfully with ID "{{.ID}}".'
-
 [serviceAccount.resetCredentials.input.id.message]
 one = "Service Account ID:"
 
@@ -61,16 +58,16 @@ description = 'Help for credentials format input'
 one = 'File format in which to save the service account credentials:'
 
 [serviceAccount.resetCredentials.input.confirmReset.message]
-one = 'Are you sure you want to reset the credentials for service account "{{.ID}}"?'
+one = 'Are you sure you want to reset the credentials for service account with ID "{{.ID}}"?'
 
 [serviceAccount.resetCredentials.log.debug.cancelledReset]
 one = 'You have chosen not to reset the service account credentials.'
 
 [serviceAccount.resetCredentials.error.resetError]
-one = 'could not reset credentials for service account "{{.Name}}"'
+one = 'could not reset credentials for service account with ID "{{.ID}}"'
 
 [serviceAccount.resetCredentials.log.info.resetSuccess]
-one = 'Credentials reset for service account "{{.Name}}"'
+one = 'Credentials reset for service account with ID "{{.ID}}"'
 
 [serviceAccount.resetCredentials.log.debug.resettingCredentials]
-one = 'Resetting credentials for service account "{{.Name}}"'
+one = 'Resetting credentials for service account with ID "{{.ID}}"'

pkg/serviceaccount/validation/validation.go

@@ -9,63 +9,37 @@ import (
 
 const (
 	// name validation rules
-	legalNameChars = "^[a-z]([-a-z0-9]*[a-z0-9])?$"
+	legalShortDescriptionChars = "^[a-z]([-a-z0-9]*[a-z0-9])?$"
 	maxNameLength  = 50
 	minNameLength  = 1
 	legalUUID      = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
-	// description validation rules
-	legalDescriptionChars = "^[a-zA-Z0-9.,\\-\\s]*$"
-	maxDescriptionLength  = 255
 )
 
 // Validator is a type for validating service account configuration values
 type Validator struct {
 	Localizer localize.Localizer
 }
 
-func (v *Validator) ValidateName(val interface{}) error {
+// ValidateShortDescription validates the short description value
+func (v *Validator) ValidateShortDescription(val interface{}) error {
 	name, ok := val.(string)
 	if !ok {
 		return commonerr.NewCastError(val, "string")
 	}
 
 	if len(name) < minNameLength {
-		return v.Localizer.MustLocalizeError("serviceAccount.common.validation.name.error.required")
+		return v.Localizer.MustLocalizeError("serviceAccount.common.validation.shortDescription.error.required")
 	} else if len(name) > maxNameLength {
-		return v.Localizer.MustLocalizeError("serviceAccount.common.validation.name.error.lengthError", localize.NewEntry("MaxNameLen", maxNameLength))
+		return v.Localizer.MustLocalizeError("serviceAccount.common.validation.shortDescription.error.lengthError", localize.NewEntry("MaxNameLen", maxNameLength))
 	}
 
-	matched, _ := regexp.Match(legalNameChars, []byte(name))
+	matched, _ := regexp.Match(legalShortDescriptionChars, []byte(name))
 
 	if matched {
 		return nil
 	}
 
-	return v.Localizer.MustLocalizeError("serviceAccount.common.validation.name.error.invalidChars", localize.NewEntry("Name", name))
-}
-
-// ValidateDescription validates the service account description text
-func (v *Validator) ValidateDescription(val interface{}) error {
-	description, ok := val.(string)
-	if !ok {
-		return commonerr.NewCastError(val, "string")
-	}
-
-	if description == "" {
-		return nil
-	}
-
-	if len(description) > maxDescriptionLength {
-		return v.Localizer.MustLocalizeError("serviceAccount.common.validation.description.error.lengthError", localize.NewEntry("MaxLen", maxDescriptionLength))
-	}
-
-	matched, _ := regexp.Match(legalDescriptionChars, []byte(description))
-
-	if matched {
-		return nil
-	}
-
-	return v.Localizer.MustLocalizeError("serviceAccount.common.validation.description.error.invalidChars")
+	return v.Localizer.MustLocalizeError("serviceAccount.common.validation.shortDescription.error.invalidChars", localize.NewEntry("Name", name))
 }
 
 // ValidateUUID validates if ID is a valid UUID

pkg/serviceaccount/validation/validation_test.go

@@ -74,7 +74,7 @@ func TestValidateName(t *testing.T) {
 	// nolint:scopelint
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if err := validator.ValidateName(tt.args.val); (err != nil) != tt.wantErr {
+			if err := validator.ValidateShortDescription(tt.args.val); (err != nil) != tt.wantErr {
 				t.Errorf("ValidateName() error = %v, wantErr %v", err, tt.wantErr)
 			}
 		})