Handler schema definition (#1009)

Parametrized Handler Definition

---------

Co-authored-by: Anton Mokhovikov <[email protected]>

Author: AkifRafique

setup.py

@@ -41,7 +41,7 @@ def find_version(*file_paths):
         "boto3>=1.10.20",
         "Jinja2>=3.1.2",
         "markupsafe>=2.1.0",
-        "jsonschema>=4.0.0,<5.0",
+        "jsonschema>=3.0.0,<=4.17.3",
         "pytest>=4.5.0",
         "pytest-random-order>=1.0.4",
         "pytest-localserver>=0.5.0",

src/rpdk/core/data/schema/provider.definition.schema.v1.json

@@ -4,6 +4,55 @@
     "title": "CloudFormation Resource Provider Definition MetaSchema",
     "description": "This schema validates a CloudFormation resource provider definition.",
     "definitions": {
+	"handlerSchema": {
+            "type": "object",
+            "properties": {
+                "properties": {
+                    "$ref": "base.definition.schema.v1.json#/properties/properties"
+                },
+                "required": {
+                    "$ref": "base.definition.schema.v1.json#/properties/required"
+                },
+                "allOf": {
+                    "$ref": "base.definition.schema.v1.json#/definitions/schemaArray"
+                },
+                "anyOf": {
+                    "$ref": "base.definition.schema.v1.json#/definitions/schemaArray"
+                },
+                "oneOf": {
+                    "$ref": "base.definition.schema.v1.json#/definitions/schemaArray"
+                }
+            },
+            "required": ["properties"],
+            "additionalProperties": false
+        },
+        "handlerDefinitionWithSchemaOverride": {
+            "description": "Defines any execution operations which can be performed on this resource provider",
+            "type": "object",
+            "properties": {
+                "handlerSchema": {
+                    "$ref": "#/definitions/handlerSchema"
+                },
+                "permissions": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "additionalItems": false
+                },
+                "timeoutInMinutes": {
+                    "description": "Defines the timeout for the entire operation to be interpreted by the invoker of the handler.  The default is 120 (2 hours).",
+                    "type": "integer",
+                    "minimum": 2,
+                    "maximum": 2160,
+                    "default": 120
+                }
+            },
+            "additionalProperties": false,
+            "required": [
+                "permissions"
+            ]
+        },
         "handlerDefinition": {
             "description": "Defines any execution operations which can be performed on this resource provider",
             "type": "object",
@@ -190,7 +239,7 @@
                     "$ref": "#/definitions/handlerDefinition"
                 },
                 "list": {
-                    "$ref": "#/definitions/handlerDefinition"
+                    "$ref": "#/definitions/handlerDefinitionWithSchemaOverride"
                 }
             },
             "additionalProperties": false

src/rpdk/core/jsonutils/inliner.py

@@ -1,7 +1,7 @@
 import logging
 from collections.abc import Iterable, Mapping
 
-from jsonschema import RefResolver
+from jsonschema import RefResolutionError, RefResolver
 
 from .renamer import RefRenamer
 from .utils import BASE, rewrite_ref, traverse
@@ -12,6 +12,8 @@
 class RefInliner(RefResolver):
     """Mutates the schema."""
 
+    META_SCHEMA = "resource-schema.json"
+
     def __init__(self, base_uri, schema):
         self.schema = schema
         self.ref_graph = {}
@@ -33,7 +35,7 @@ def resolve(self, ref):
         url = self._urljoin_cache(self.resolution_scope, ref)
         return url, self._remote_cache(url)
 
-    def _walk(self, obj, old_path):
+    def _walk(self, obj, old_path):  # noqa: C901 # pylint: disable=R0912
         if isinstance(obj, str):
             return  # very common, easier to debug this case
 
@@ -43,7 +45,16 @@ def _walk(self, obj, old_path):
                     if old_path in self.ref_graph:
                         LOG.debug("Already visited '%s' (%s)", old_path, value)
                         return
-                    url, resolved = self.resolve(value)
+                    try:
+                        url, resolved = self.resolve(value)
+                    except RefResolutionError:  # noqa: E203
+                        if self.META_SCHEMA in value:  # noqa: E203
+                            url, resolved = self.resolve(  # noqa: E203
+                                value[len(self.META_SCHEMA) :]  # noqa: E203
+                            )  # noqa: E203
+                        else:  # noqa: E203
+                            raise
+
                     LOG.debug("Resolved '%s' to '%s'", value, url)
                     # parse the URL into
                     new_path = self.renamer.parse_ref_url(url)

tests/jsonutils/test_inliner.py

@@ -47,6 +47,7 @@ def test_refinliner_local_refs_simple_are_walked_and_unchanged():
         "definitions": {"bar": {"type": "string"}},
         "properties": {"foo": {"$ref": "#/definitions/bar"}},
     }
+
     inliner = make_inliner(local)
     schema = inliner.inline()
     assert schema == local