Add provider_options validation arg, fix test JSON schema

Author: danieljnchen

aws_lambda_powertools/utilities/validation/base.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Dict, Optional, Union
+from typing import Any, Dict, Optional, Union
 
 import fastjsonschema  # type: ignore
 
@@ -9,7 +9,11 @@
 
 
 def validate_data_against_schema(
-    data: Union[Dict, str], schema: Dict, formats: Optional[Dict] = None, handlers: Optional[Dict] = None
+    data: Union[Dict, str],
+    schema: Dict,
+    formats: Optional[Dict] = None,
+    handlers: Optional[Dict] = None,
+    **provider_options: Any,
 ):
     """Validate dict data against given JSON Schema
 
@@ -23,6 +27,8 @@ def validate_data_against_schema(
         Custom formats containing a key (e.g. int64) and a value expressed as regex or callback returning bool
     handlers: Dict
         Custom methods to retrieve remote schemes, keyed off of URI scheme
+    **provider options: Dict, optional
+        Arguments that will be passed directly to the underlying validate call
 
     Raises
     ------
@@ -34,7 +40,7 @@ def validate_data_against_schema(
     try:
         formats = formats or {}
         handlers = handlers or {}
-        fastjsonschema.validate(definition=schema, data=data, formats=formats, handlers=handlers)
+        fastjsonschema.validate(definition=schema, data=data, formats=formats, handlers=handlers, **provider_options)
     except (TypeError, AttributeError, fastjsonschema.JsonSchemaDefinitionException) as e:
         raise InvalidSchemaFormatError(f"Schema received: {schema}, Formats: {formats}. Error: {e}")
     except fastjsonschema.JsonSchemaValueException as e:

aws_lambda_powertools/utilities/validation/validator.py

@@ -17,9 +17,11 @@ def validator(
     inbound_schema: Optional[Dict] = None,
     inbound_formats: Optional[Dict] = None,
     inbound_handlers: Optional[Dict] = None,
+    inbound_provider_options: Dict = {},
     outbound_schema: Optional[Dict] = None,
     outbound_formats: Optional[Dict] = None,
     outbound_handlers: Optional[Dict] = None,
+    outbound_provider_options: Dict = {},
     envelope: str = "",
     jmespath_options: Optional[Dict] = None,
     **kwargs: Any,
@@ -50,6 +52,10 @@ def validator(
         Custom methods to retrieve remote schemes, keyed off of URI scheme
     outbound_handlers: Dict
         Custom methods to retrieve remote schemes, keyed off of URI scheme
+    inbound_provider_options: Dict
+        Arguments that will be passed directly to the underlying validate call for the inbound event
+    outbound_provider_options: Dict
+        Arguments that will be passed directly to the underlying validate call for the outbound event
 
     Example
     -------
@@ -134,15 +140,23 @@ def handler(event, context):
     if inbound_schema:
         logger.debug("Validating inbound event")
         validate_data_against_schema(
-            data=event, schema=inbound_schema, formats=inbound_formats, handlers=inbound_handlers
+            data=event,
+            schema=inbound_schema,
+            formats=inbound_formats,
+            handlers=inbound_handlers,
+            **inbound_provider_options,
         )
 
     response = handler(event, context, **kwargs)
 
     if outbound_schema:
         logger.debug("Validating outbound event")
         validate_data_against_schema(
-            data=response, schema=outbound_schema, formats=outbound_formats, handlers=outbound_handlers
+            data=response,
+            schema=outbound_schema,
+            formats=outbound_formats,
+            handlers=outbound_handlers,
+            **outbound_provider_options,
         )
 
     return response
@@ -153,6 +167,7 @@ def validate(
     schema: Dict,
     formats: Optional[Dict] = None,
     handlers: Optional[Dict] = None,
+    provider_options: Dict = {},
     envelope: Optional[str] = None,
     jmespath_options: Optional[Dict] = None,
 ):
@@ -174,6 +189,8 @@ def validate(
         Custom formats containing a key (e.g. int64) and a value expressed as regex or callback returning bool
     handlers: Dict
         Custom methods to retrieve remote schemes, keyed off of URI scheme
+    provider_options: Dict
+        Arguments that will be passed directly to the underlying validate call
 
     Example
     -------
@@ -242,4 +259,4 @@ def handler(event, context):
             jmespath_options=jmespath_options,
         )
 
-    validate_data_against_schema(data=event, schema=schema, formats=formats, handlers=handlers)
+    validate_data_against_schema(data=event, schema=schema, formats=formats, handlers=handlers, **provider_options)

tests/functional/validator/conftest.py

@@ -95,7 +95,7 @@ def schema_refs():
             "title": "Sample schema",
             "description": "Sample JSON Schema that references another schema",
             "examples": [{"parent_object": {"child_string": "hello world"}}],
-            "required": "parent_object",
+            "required": ["parent_object"],
             "properties": {
                 "parent_object": {
                     "$id": "#/properties/parent_object",
@@ -110,7 +110,7 @@ def schema_refs():
             "title": "Sample schema",
             "description": "Sample JSON Schema that is referenced by another schema",
             "examples": [{"child_string": "hello world"}],
-            "required": "child_string",
+            "required": ["child_string"],
             "properties": {
                 "child_string": {
                     "$id": "#/properties/child_string",