Implement strategy for unique validations (#391)

* Implement strategy to use unique validations

* Refactor app to use validation context

* Update schemas/property.py

Co-authored-by: Chris Boe <cboe15@gmail.com>

Co-authored-by: Chris Boe <cboe15@gmail.com>

Author: NickSchimek

models/base_model.py

@@ -12,6 +12,9 @@ class BaseModel(db.Model):
         db.DateTime, onupdate=datetime.utcnow, default=datetime.utcnow, nullable=False
     )
 
+    def validation_context(self):
+        return {}
+
     @classmethod
     def find(cls, id):
         return cls.query.get_or_404(id, f"{cls._name()} not found")
@@ -31,8 +34,10 @@ def create(cls, schema, payload):
 
         return obj
 
-    def update(self, schema, payload, context=None):
-        attrs = self.validate(schema, payload, context=context, partial=True)
+    def update(self, schema, payload):
+        attrs = self.validate(
+            schema, payload, context=self.validation_context(), partial=True
+        )
 
         for k, v in attrs.items():
             setattr(self, k, v)

models/emergency_contact.py

@@ -19,6 +19,9 @@ class EmergencyContactModel(BaseModel):
         collection_class=NobiruList,
     )
 
+    def validation_context(self):
+        return {"name": self.name}
+
     def json(self):
         return {
             "id": self.id,

models/property.py

@@ -33,6 +33,9 @@ class PropertyModel(BaseModel):
         collection_class=NobiruList,
     )
 
+    def validation_context(self):
+        return {"name": self.name}
+
     def json(self, include_tenants=False, include_managers=True):
         property = {
             "id": self.id,

models/user.py

@@ -73,6 +73,9 @@ def password(self, plaintext_password):
             bcrypt.gensalt(current_app.config["WORK_FACTOR"]),
         )
 
+    def validation_context(self):
+        return {"email": self.email}
+
     def update_last_active(self):
         self.lastActive = datetime.utcnow()
         db.session.commit()

resources/property.py

@@ -20,11 +20,7 @@ def delete(self, id):
     def put(self, id):
         property = PropertyModel.find(id)
 
-        return property.update(
-            schema=PropertySchema,
-            context={"name": property.name},
-            payload=request.json,
-        ).json()
+        return property.update(schema=PropertySchema, payload=request.json).json()
 
 
 class Properties(Resource):

schemas/emergency_contact.py

@@ -12,8 +12,10 @@ class Meta:
     contact_numbers = fields.List(fields.Nested(ContactNumberSchema), required=True)
 
     @validates("name")
-    def validate_name(self, value):
-        if EmergencyContactModel.find_by_name(value):
+    def validates_uniqueness_of_name(self, value):
+        if self.context.get("name") != value and EmergencyContactModel.find_by_name(
+            value
+        ):
             raise ValidationError(f"{value} is already an emergency contact")
 
     @validates("contact_numbers")

schemas/property.py

@@ -27,13 +27,11 @@ def validates_property_manager_ids(self, value):
 
     @validates("name")
     def validates_uniqueness_of_name(self, value):
-        def _assigning_name():
-            if "name" in self.context and value == self.context["name"]:
-                return False
-            return True
-
-        if _assigning_name() and PropertyModel.find_by_name(value):
+        if self.context.get("name") != value and PropertyModel.find_by_name(value):
             raise ValidationError("A property with this name already exists")
+
+    @validates("name")
+    def validates_presence_of_name(self, value):
         if blank(value):
             raise ValidationError("Property name cannot be blank")
 

schemas/user.py

@@ -1,7 +1,8 @@
 from ma import ma
-from models.user import UserModel, RoleEnum
 from marshmallow import fields, validates, ValidationError
 
+from models.user import UserModel, RoleEnum
+
 
 class UserSchema(ma.SQLAlchemyAutoSchema):
     class Meta:
@@ -12,7 +13,7 @@ class Meta:
 
     @validates("email")
     def validate_uniqueness_of_email(self, value):
-        if UserModel.find_by_email(value):
+        if self.context.get("email") != value and UserModel.find_by_email(value):
             raise ValidationError(f"A user with email '{value}' already exists")
 
     def get_role_value(self, obj):

tests/integration/test_properties.py

@@ -46,7 +46,6 @@ def test_put(self, valid_header, create_property):
 
         mock_update.assert_called_once_with(
             schema=PropertySchema,
-            context={"name": property.name},
             payload={"num_units": 2},
         )
         assert response.status_code == 200

tests/integration/test_users.py

@@ -132,7 +132,9 @@ def test_role_update(self, valid_header, create_unauthorized_user):
         payload = {"role": RoleEnum.ADMIN.value}
         self.client.patch(f"api/user/{id}", json=payload, headers=valid_header)
 
-        assert Admin.find(id).role == RoleEnum.ADMIN
+        user = Admin.find(id)
+        assert user.role == RoleEnum.ADMIN
+        assert user.type == "admin"
 
 
 @pytest.mark.usefixtures("client_class", "empty_test_db")