Implementing readOnly and writeOnly on all methods that unmarshal or validate properties

Author: phrfpeixoto

openapi_core/schema/media_types/models.py

@@ -5,7 +5,7 @@
 
 from openapi_core.schema.media_types.exceptions import InvalidMediaTypeValue
 from openapi_core.schema.schemas.exceptions import OpenAPISchemaError
-
+from openapi_core.schema.schemas.util import requires_context
 
 MEDIA_TYPE_DESERIALIZERS = {
     'application/json': loads,

openapi_core/schema/schemas/models.py

@@ -325,8 +325,11 @@ def _unmarshal_object(self, value, model_factory=None,
 
         return model_factory.create(properties, name=self.model)
 
+    @requires_context
     def _unmarshal_properties(self, value, one_of_schema=None,
-                              custom_formatters=None, strict=True):
+                              custom_formatters=None, strict=True,
+                              context=None):
+
         all_props = self.get_all_properties()
         all_props_names = self.get_all_properties_names()
         all_req_props_names = self.get_all_required_properties_names()
@@ -338,6 +341,21 @@ def _unmarshal_properties(self, value, one_of_schema=None,
             all_req_props_names |= one_of_schema.\
                 get_all_required_properties_names()
 
+        if context is UnmarshalContext.REQUEST:
+            forbidden_prop_names = {prop for prop in all_props_names
+                                    if all_props[prop].read_only}
+        else:  # Response
+            forbidden_prop_names = {prop for prop in all_props_names
+                                    if all_props[prop].write_only}
+        all_req_props_names = all_req_props_names - forbidden_prop_names
+        for forbidden_prop in forbidden_prop_names:
+            if forbidden_prop in value:
+                raise InvalidSchemaProperty(
+                    forbidden_prop,
+                    "Field {} is not allowed on a {} context".format(
+                        forbidden_prop, context.value)
+                )
+
         value_props_names = value.keys()
         extra_props = set(value_props_names) - set(all_props_names)
         extra_props_allowed = self.are_additional_properties_allowed(
@@ -350,7 +368,8 @@ def _unmarshal_properties(self, value, one_of_schema=None,
             for prop_name in extra_props:
                 prop_value = value[prop_name]
                 properties[prop_name] = self.additional_properties.unmarshal(
-                    prop_value, custom_formatters=custom_formatters)
+                    prop_value, custom_formatters=custom_formatters,
+                    context=context)
 
         for prop_name, prop in iteritems(all_props):
             try:
@@ -363,12 +382,14 @@ def _unmarshal_properties(self, value, one_of_schema=None,
                 prop_value = prop.default
             try:
                 properties[prop_name] = prop.unmarshal(
-                  prop_value, custom_formatters=custom_formatters)
+                    prop_value, custom_formatters=custom_formatters,
+                    context=context)
             except OpenAPISchemaError as exc:
                 raise InvalidSchemaProperty(prop_name, exc)
 
         self._validate_properties(properties, one_of_schema=one_of_schema,
-                                  custom_formatters=custom_formatters)
+                                  custom_formatters=custom_formatters,
+                                  context=context)
 
         return properties
 
@@ -559,8 +580,9 @@ def _validate_object(self, value, custom_formatters=None):
 
         return True
 
+    @requires_context
     def _validate_properties(self, value, one_of_schema=None,
-                             custom_formatters=None):
+                             custom_formatters=None, context=None):
         all_props = self.get_all_properties()
         all_props_names = self.get_all_properties_names()
         all_req_props_names = self.get_all_required_properties_names()
@@ -572,6 +594,14 @@ def _validate_properties(self, value, one_of_schema=None,
             all_req_props_names |= one_of_schema.\
                 get_all_required_properties_names()
 
+        if context is UnmarshalContext.REQUEST:
+            forbidden_prop_names = {prop for prop in all_props_names
+                                    if all_props[prop].read_only}
+        else:  # Response
+            forbidden_prop_names = {prop for prop in all_props_names
+                                    if all_props[prop].write_only}
+        all_req_props_names = all_req_props_names - forbidden_prop_names
+
         value_props_names = value.keys()
         extra_props = set(value_props_names) - set(all_props_names)
         extra_props_allowed = self.are_additional_properties_allowed(
@@ -583,7 +613,8 @@ def _validate_properties(self, value, one_of_schema=None,
             for prop_name in extra_props:
                 prop_value = value[prop_name]
                 self.additional_properties.validate(
-                    prop_value, custom_formatters=custom_formatters)
+                    prop_value, custom_formatters=custom_formatters,
+                    context=context)
 
         for prop_name, prop in iteritems(all_props):
             try:
@@ -595,7 +626,8 @@ def _validate_properties(self, value, one_of_schema=None,
                     continue
                 prop_value = prop.default
             try:
-                prop.validate(prop_value, custom_formatters=custom_formatters)
+                prop.validate(prop_value, custom_formatters=custom_formatters,
+                              context=context)
             except OpenAPISchemaError as exc:
                 raise InvalidSchemaProperty(prop_name, original_exception=exc)