tweak validation

aslilac · aslilac · commit 55be1bc80aba · 2024-06-05T16:51:36.000Z
diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go
@@ -46,25 +46,27 @@ func init() {
 		valid := NameValid(str)
 		return valid == nil
 	}
-	for _, tag := range []string{"username", "template_name", "workspace_name", "oauth2_app_name"} {
+	for _, tag := range []string{"username", "organization_name", "template_name", "workspace_name", "oauth2_app_name"} {
 		err := Validate.RegisterValidation(tag, nameValidator)
 		if err != nil {
 			panic(err)
 		}
 	}
 
-	templateDisplayNameValidator := func(fl validator.FieldLevel) bool {
+	displayNameValidator := func(fl validator.FieldLevel) bool {
 		f := fl.Field().Interface()
 		str, ok := f.(string)
 		if !ok {
 			return false
 		}
-		valid := TemplateDisplayNameValid(str)
+		valid := DisplayNameValid(str)
 		return valid == nil
 	}
-	err := Validate.RegisterValidation("template_display_name", templateDisplayNameValidator)
-	if err != nil {
-		panic(err)
+	for _, displayNameTag := range []string{"organization_display_name", "template_display_name"} {
+		err := Validate.RegisterValidation(displayNameTag, displayNameValidator)
+		if err != nil {
+			panic(err)
+		}
 	}
 
 	templateVersionNameValidator := func(fl validator.FieldLevel) bool {
@@ -76,7 +78,7 @@ func init() {
 		valid := TemplateVersionNameValid(str)
 		return valid == nil
 	}
-	err = Validate.RegisterValidation("template_version_name", templateVersionNameValidator)
+	err := Validate.RegisterValidation("template_version_name", templateVersionNameValidator)
 	if err != nil {
 		panic(err)
 	}
diff --git a/coderd/httpapi/name.go b/coderd/httpapi/name.go
@@ -65,8 +65,8 @@ func TemplateVersionNameValid(str string) error {
 	return nil
 }
 
-// TemplateDisplayNameValid returns whether the input string is a valid template display name.
-func TemplateDisplayNameValid(str string) error {
+// DisplayNameValid returns whether the input string is a valid template display name.
+func DisplayNameValid(str string) error {
 	if len(str) == 0 {
 		return nil // empty display_name is correct
 	}
diff --git a/coderd/httpapi/name_test.go b/coderd/httpapi/name_test.go
@@ -115,7 +115,7 @@ func TestTemplateDisplayNameValid(t *testing.T) {
 		testCase := testCase
 		t.Run(testCase.Name, func(t *testing.T) {
 			t.Parallel()
-			valid := httpapi.TemplateDisplayNameValid(testCase.Name)
+			valid := httpapi.DisplayNameValid(testCase.Name)
 			require.Equal(t, testCase.Valid, valid == nil)
 		})
 	}
diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -58,14 +58,14 @@ type OrganizationMember struct {
 }
 
 type CreateOrganizationRequest struct {
-	Name        string `json:"name" validate:"required,username"`
-	DisplayName string `json:"display_name" validate:"required"`
+	Name        string `json:"name" validate:"required,organization_name"`
+	DisplayName string `json:"display_name" validate:"required,organization_display_name"`
 	Description string `json:"description,omitempty"`
 }
 
 type UpdateOrganizationRequest struct {
-	Name        string `json:"name,omitempty" validate:"omitempty,username"`
-	DisplayName string `json:"display_name,omitempty"`
+	Name        string `json:"name,omitempty" validate:"omitempty,organization_name"`
+	DisplayName string `json:"display_name,omitempty" validate:"omitempty,organization_display_name"`
 	Description string `json:"description,omitempty"`
 }
 

Original file line number	Diff line number	Diff line change
`@@ -46,25 +46,27 @@ func init() {`
`46`	`46`	`valid := NameValid(str)`
`47`	`47`	`return valid == nil`
`48`	`48`	`}`
`49`		`- for _, tag := range []string{"username", "template_name", "workspace_name", "oauth2_app_name"} {`
	`49`	`+ for _, tag := range []string{"username", "organization_name", "template_name", "workspace_name", "oauth2_app_name"} {`
`50`	`50`	`err := Validate.RegisterValidation(tag, nameValidator)`
`51`	`51`	`if err != nil {`
`52`	`52`	`panic(err)`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`
`56`		`- templateDisplayNameValidator := func(fl validator.FieldLevel) bool {`
	`56`	`+ displayNameValidator := func(fl validator.FieldLevel) bool {`
`57`	`57`	`f := fl.Field().Interface()`
`58`	`58`	`str, ok := f.(string)`
`59`	`59`	`if !ok {`
`60`	`60`	`return false`
`61`	`61`	`}`
`62`		`- valid := TemplateDisplayNameValid(str)`
	`62`	`+ valid := DisplayNameValid(str)`
`63`	`63`	`return valid == nil`
`64`	`64`	`}`
`65`		`- err := Validate.RegisterValidation("template_display_name", templateDisplayNameValidator)`
`66`		`- if err != nil {`
`67`		`- panic(err)`
	`65`	`+ for _, displayNameTag := range []string{"organization_display_name", "template_display_name"} {`
	`66`	`+ err := Validate.RegisterValidation(displayNameTag, displayNameValidator)`
	`67`	`+ if err != nil {`
	`68`	`+ panic(err)`
	`69`	`+ }`
`68`	`70`	`}`
`69`	`71`
`70`	`72`	`templateVersionNameValidator := func(fl validator.FieldLevel) bool {`
`@@ -76,7 +78,7 @@ func init() {`
`76`	`78`	`valid := TemplateVersionNameValid(str)`
`77`	`79`	`return valid == nil`
`78`	`80`	`}`
`79`		`- err = Validate.RegisterValidation("template_version_name", templateVersionNameValidator)`
	`81`	`+ err := Validate.RegisterValidation("template_version_name", templateVersionNameValidator)`
`80`	`82`	`if err != nil {`
`81`	`83`	`panic(err)`
`82`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,8 @@ func TemplateVersionNameValid(str string) error {`
`65`	`65`	`return nil`
`66`	`66`	`}`
`67`	`67`
`68`		`-// TemplateDisplayNameValid returns whether the input string is a valid template display name.`
`69`		`-func TemplateDisplayNameValid(str string) error {`
	`68`	`+// DisplayNameValid returns whether the input string is a valid template display name.`
	`69`	`+func DisplayNameValid(str string) error {`
`70`	`70`	`if len(str) == 0 {`
`71`	`71`	`return nil // empty display_name is correct`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ func TestTemplateDisplayNameValid(t *testing.T) {`
`115`	`115`	`testCase := testCase`
`116`	`116`	`t.Run(testCase.Name, func(t *testing.T) {`
`117`	`117`	`t.Parallel()`
`118`		`- valid := httpapi.TemplateDisplayNameValid(testCase.Name)`
	`118`	`+ valid := httpapi.DisplayNameValid(testCase.Name)`
`119`	`119`	`require.Equal(t, testCase.Valid, valid == nil)`
`120`	`120`	`})`
`121`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,14 +58,14 @@ type OrganizationMember struct {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`type CreateOrganizationRequest struct {`
`61`		- Name string `json:"name" validate:"required,username"`
`62`		- DisplayName string `json:"display_name" validate:"required"`
	`61`	+ Name string `json:"name" validate:"required,organization_name"`
	`62`	+ DisplayName string `json:"display_name" validate:"required,organization_display_name"`
`63`	`63`	Description string `json:"description,omitempty"`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`type UpdateOrganizationRequest struct {`
`67`		- Name string `json:"name,omitempty" validate:"omitempty,username"`
`68`		- DisplayName string `json:"display_name,omitempty"`
	`67`	+ Name string `json:"name,omitempty" validate:"omitempty,organization_name"`
	`68`	+ DisplayName string `json:"display_name,omitempty" validate:"omitempty,organization_display_name"`
`69`	`69`	Description string `json:"description,omitempty"`
`70`	`70`	`}`
`71`	`71`