feature(api,pkg): add validation rule to device's name

Author: henrybarreto

api/services/device.go

@@ -350,7 +350,8 @@ func (s *service) UpdateDevice(ctx context.Context, tenant string, uid models.UI
 			return nil
 		}
 
-		if ok := validator.ValidateField(models.Device{}, "Name", *name); !ok {
+		v := validator.New()
+		if ok, err := v.Var(*name, "device_name"); err != nil || !ok {
 			return NewErrDeviceInvalid(map[string]interface{}{"name": *name}, nil)
 		}
 

pkg/models/device.go

@@ -19,7 +19,7 @@ const (
 type Device struct {
 	// UID is the unique identifier for a device.
 	UID              string          `json:"uid"`
-	Name             string          `json:"name" bson:"name,omitempty" validate:"required,hostname_rfc1123,excludes=."`
+	Name             string          `json:"name" bson:"name,omitempty" validate:"required,device_name"`
 	Identity         *DeviceIdentity `json:"identity"`
 	Info             *DeviceInfo     `json:"info"`
 	PublicKey        string          `json:"public_key" bson:"public_key"`

pkg/validator/deprecated.go

@@ -31,6 +31,10 @@ func init() {
 		return regexp.MustCompile(`^([a-zA-Z0-9-_.@]){3,30}$`).MatchString(fl.Field().String())
 	})
 
+	_ = validate.RegisterValidation("device_name", func(fl validator.FieldLevel) bool {
+		return regexp.MustCompile(`^([a-zA-Z0-9_-]){1,64}$`).MatchString(fl.Field().String())
+	})
+
 	instance = validate
 }
 

pkg/validator/validator.go

@@ -39,6 +39,13 @@ var Rules = []Rule{
 		},
 		Error: fmt.Errorf("the password cannot be empty and must be between 5 and 30 characters"),
 	},
+	{
+		Tag: "device_name",
+		Handler: func(field validator.FieldLevel) bool {
+			return regexp.MustCompile(`^([a-zA-Z0-9_.-] ){1,64}$`).MatchString(field.Field().String())
+		},
+		Error: fmt.Errorf("the device name can only contain `_`, `.` and alpha numeric characters"),
+	},
 }
 
 // Validator is the ShellHub validator.