fix(serviceaccount): update regex pattern for description

redhat-developer · Apr 9, 2021 · 8bb60e5 · 8bb60e5
1 parent 1cdfad8
commit 8bb60e5
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 8 deletions.
diff --git a/cmd/rhoas/pkged.go b/cmd/rhoas/pkged.go
diff --git a/docs/commands/rhoas_serviceaccount_create.adoc b/docs/commands/rhoas_serviceaccount_create.adoc
@@ -41,7 +41,7 @@ $ rhoas serviceaccount create --file-location=./service-acct-credentials.json
 === Options
 
 ....
-      --description string     Description for the service account.
+      --description string     Description for the service account. Only alphanumeric characters and '-', '.', ',' are accepted.
       --file-format string     Format in which to save the service account credentials. Choose from: "env", "json", "properties"
       --file-location string   Sets a custom file location to save the credentials.
       --name string            Name of the service account.

diff --git a/locales/cmd/serviceaccount/active.en.toml b/locales/cmd/serviceaccount/active.en.toml
@@ -81,7 +81,7 @@ one = 'service account name cannot exceed {{.MaxNameLen}} characters'
 one = 'invalid service account name "{{.Name}}"; only lowercase letters (a-z), numbers, and "-" are accepted'
 
 [serviceAccount.common.validation.description.error.invalidChars]
-one = 'invalid service account description "{{.Description}}"; only alphanumeric characters are accepted'
+one = 'invalid service account description; only alphanumeric characters and "-", ".", "," are accepted.'
 
 [serviceAccount.common.validation.description.error.lengthError]
-one = 'service account description cannot exceed {{.MaxNameLen}} characters'
+one = 'service account description cannot exceed {{.MaxLen}} characters'
diff --git a/locales/cmd/serviceaccount/create/active.en.toml b/locales/cmd/serviceaccount/create/active.en.toml
@@ -42,7 +42,7 @@ one = 'Name of the service account.'
 
 [serviceAccount.create.flag.description.description]
 description = 'Description for --description flag'
-one = 'Description for the service account.'
+one = "Description for the service account. Only alphanumeric characters and '-', '.', ',' are accepted."
 
 [serviceAccount.create.error.couldNotCreate]
 description = 'Error message when service account could not be created'

diff --git a/pkg/cmd/serviceaccount/create/create.go b/pkg/cmd/serviceaccount/create/create.go
@@ -246,7 +246,10 @@ func runInteractivePrompt(opts *Options) (err error) {
 		return err
 	}
 
-	promptDescription := &survey.Multiline{Message: localizer.MustLocalizeFromID("serviceAccount.create.input.description.message")}
+	promptDescription := &survey.Multiline{
+		Message: localizer.MustLocalizeFromID("serviceAccount.create.input.description.message"),
+		Help:    localizer.MustLocalizeFromID("serviceAccount.create.flag.description.description"),
+	}
 
 	err = survey.AskOne(promptDescription, &opts.description, survey.WithValidator(validation.ValidateDescription))
 	if err != nil {

diff --git a/pkg/serviceaccount/validation/validation.go b/pkg/serviceaccount/validation/validation.go
@@ -13,7 +13,7 @@ const (
 	maxNameLength  = 50
 	minNameLength  = 1
 	// description validation rules
-	legalDescriptionChars = "^[a-zA-Z0-9\\s]*$"
+	legalDescriptionChars = "^[a-zA-Z0-9.,\\-\\s]*$"
 	maxDescriptionLength  = 255
 )
 
@@ -76,7 +76,7 @@ func ValidateDescription(val interface{}) error {
 		return errors.New(localizer.MustLocalize(&localizer.Config{
 			MessageID: "serviceAccount.common.validation.description.error.lengthError",
 			TemplateData: map[string]interface{}{
-				"MaxNameLen": maxDescriptionLength,
+				"MaxLen": maxDescriptionLength,
 			},
 		}))
 	}