Add support for Wildcard Hook Targets (#945)

* Added support for full wildcard target matching for HOOK types

Author: Brianwithay21

src/rpdk/core/contract/hook_client.py

@@ -2,6 +2,7 @@
 # pylint: disable=R0904
 # have to skip B404, import_subprocess is required for executing typescript
 # have to skip B60*, to allow typescript code to be executed using subprocess
+import fnmatch
 import json
 import logging
 import re
@@ -98,6 +99,7 @@ def __init__(
         self._docker_client = docker.from_env() if self._docker_image else None
         self._executable_entrypoint = executable_entrypoint
         self._target_info = self._setup_target_info(target_info)
+        self._resolved_targets = {}
 
     @staticmethod
     def _properties_to_paths(schema, key):
@@ -140,12 +142,24 @@ def get_hook_type_name(self):
         return self._type_name if self._type_name else self._schema["typeName"]
 
     def get_handler_targets(self, invocation_point):
-        try:
-            handlers = self._schema["handlers"]
-            handler = handlers[generate_handler_name(invocation_point)]
-            return handler["targetNames"]
-        except KeyError:
-            return set()
+        handler = self._schema["handlers"][generate_handler_name(invocation_point)]
+
+        targets = set()
+        for target_name in handler.get("targetNames", []):
+            if self._contains_wildcard(target_name):
+                if target_name not in self._resolved_targets:
+                    self._resolved_targets[target_name] = fnmatch.filter(
+                        self._target_info.keys(), target_name
+                    )
+                targets.update(self._resolved_targets[target_name])
+            else:
+                targets.add(target_name)
+
+        return sorted(targets)
+
+    @staticmethod
+    def _contains_wildcard(pattern):
+        return pattern and ("*" in pattern or "?" in pattern)
 
     @staticmethod
     def assert_in_progress(status, response, target=""):
@@ -239,7 +253,7 @@ def _generate_target_example(self, target):
             return {}
 
         info = self._target_info.get(target)
-        if not info.get("SchemaStrategy"):
+        if not info.get("SchemaStrategy"):  # pragma: no cover
             # imported here to avoid hypothesis being loaded before pytest is loaded
             from .resource_generator import ResourceGenerator
 
@@ -260,7 +274,7 @@ def _generate_target_update_example(self, target, model):
             return {}
 
         info = self._target_info.get(target)
-        if not info.get("UpdateSchemaStrategy"):
+        if not info.get("UpdateSchemaStrategy"):  # pragma: no cover
             # imported here to avoid hypothesis being loaded before pytest is loaded
             from .resource_generator import ResourceGenerator
 
@@ -497,3 +511,11 @@ def call(
             status = HookStatus[response["hookStatus"]]
 
         return status, response
+
+    def handler_has_wildcard_targets(self, invocation_point):
+        return any(
+            self._contains_wildcard(target_name)
+            for target_name in self._schema["handlers"][
+                generate_handler_name(invocation_point)
+            ]["targetNames"]
+        )

src/rpdk/core/contract/interface.py

@@ -53,4 +53,5 @@ class HandlerErrorCode(AutoName):
     InvalidTypeConfiguration = auto()
     HandlerInternalFailure = auto()
     NonCompliant = auto()
+    UnsupportedTarget = auto()
     Unknown = auto()

src/rpdk/core/contract/suite/hook/handler_pre_create.py

@@ -6,6 +6,7 @@
 from rpdk.core.contract.suite.hook.hook_handler_commons import (
     test_hook_handlers_failed,
     test_hook_handlers_success,
+    test_hook_unsupported_target,
 )
 
 LOG = logging.getLogger(__name__)
@@ -21,3 +22,8 @@ def contract_pre_create_success(hook_client):
 @pytest.mark.create_pre_provision
 def contract_pre_create_failed(hook_client):
     test_hook_handlers_failed(hook_client, INVOCATION_POINT)
+
+
+@pytest.mark.create_pre_provision
+def contract_pre_create_failed_unsupported_target(hook_client):
+    test_hook_unsupported_target(hook_client, INVOCATION_POINT)

src/rpdk/core/contract/suite/hook/handler_pre_delete.py

@@ -6,6 +6,7 @@
 from rpdk.core.contract.suite.hook.hook_handler_commons import (
     test_hook_handlers_failed,
     test_hook_handlers_success,
+    test_hook_unsupported_target,
 )
 
 LOG = logging.getLogger(__name__)
@@ -21,3 +22,8 @@ def contract_pre_delete_success(hook_client):
 @pytest.mark.delete_pre_provision
 def contract_pre_delete_failed(hook_client):
     test_hook_handlers_failed(hook_client, INVOCATION_POINT)
+
+
+@pytest.mark.delete_pre_provision
+def contract_pre_delete_failed_unsupported_target(hook_client):
+    test_hook_unsupported_target(hook_client, INVOCATION_POINT)

src/rpdk/core/contract/suite/hook/handler_pre_update.py

@@ -6,6 +6,7 @@
 from rpdk.core.contract.suite.hook.hook_handler_commons import (
     test_hook_handlers_failed,
     test_hook_handlers_success,
+    test_hook_unsupported_target,
 )
 
 LOG = logging.getLogger(__name__)
@@ -21,3 +22,8 @@ def contract_pre_update_success(hook_client):
 @pytest.mark.update_pre_provision
 def contract_pre_update_failed(hook_client):
     test_hook_handlers_failed(hook_client, INVOCATION_POINT)
+
+
+@pytest.mark.update_pre_provision
+def contract_pre_update_failed_unsupported_target(hook_client):
+    test_hook_unsupported_target(hook_client, INVOCATION_POINT)

src/rpdk/core/contract/suite/hook/hook_handler_commons.py

@@ -1,10 +1,25 @@
+# pylint: disable=import-outside-toplevel
 import logging
 
+import pytest
+
 from rpdk.core.contract.hook_client import HookClient
-from rpdk.core.contract.interface import HookStatus
+from rpdk.core.contract.interface import HandlerErrorCode, HookStatus
+from rpdk.core.contract.suite.contract_asserts_commons import failed_event
 
 LOG = logging.getLogger(__name__)
 
+TARGET_NAME_REGEX = "^[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}$"
+
+UNSUPPORTED_TARGET_SCHEMA = {
+    "type": "object",
+    "properties": {
+        "id": {"type": "string", "format": "arn"},
+        "property1": {"type": "string", "pattern": "^[a-zA-Z0-9]{2,26}$"},
+        "property2": {"type": "integer", "minimum": 1, "maximum": 100},
+    },
+}
+
 
 def test_hook_success(hook_client, invocation_point, target, target_model):
     if HookClient.is_update_invocation_point(invocation_point):
@@ -66,3 +81,37 @@ def test_hook_handlers_failed(hook_client, invocation_point):
         target_model,
     ) in hook_client.generate_invalid_request_examples(invocation_point):
         test_hook_failed(hook_client, invocation_point, target, target_model)
+
+
+@failed_event(
+    error_code=HandlerErrorCode.UnsupportedTarget,
+    msg="A hook handler MUST return FAILED with a UnsupportedTarget error code if the target is not supported",
+)
+def test_hook_unsupported_target(hook_client, invocation_point):
+    if not hook_client.handler_has_wildcard_targets(invocation_point):
+        pytest.skip("No wildcard hook targets. Skipping test.")
+
+    # imported here to avoid hypothesis being loaded before pytest is loaded
+    from ...resource_generator import ResourceGenerator
+
+    unsupported_target = ResourceGenerator(
+        UNSUPPORTED_TARGET_SCHEMA
+    ).generate_schema_strategy(UNSUPPORTED_TARGET_SCHEMA)
+
+    target_model = {"resourceProperties": unsupported_target.example()}
+    if HookClient.is_update_invocation_point(invocation_point):
+        target_model["previousResourceProperties"] = unsupported_target.example()
+        target_model["previousResourceProperties"]["id"] = target_model[
+            "resourceProperties"
+        ]["id"]
+
+    _response, error_code = test_hook_failed(
+        hook_client,
+        invocation_point,
+        ResourceGenerator.generate_string_strategy(
+            {"pattern": TARGET_NAME_REGEX}
+        ).example(),
+        target_model,
+    )
+
+    return error_code

src/rpdk/core/contract/type_configuration.py

@@ -41,12 +41,13 @@ def get_type_configuration():
 
     @staticmethod
     def get_hook_configuration():
+        # pylint: disable=unsubscriptable-object
         type_configuration = TypeConfiguration.get_type_configuration()
         if type_configuration:
             try:
-                return type_configuration.get("CloudFormationConfiguration", {})[
+                return type_configuration["CloudFormationConfiguration"][
                     "HookConfiguration"
-                ]["Properties"]
+                ].get("Properties")
             except KeyError as e:
                 LOG.warning("Hook configuration is invalid")
                 raise InvalidProjectError("Hook configuration is invalid") from e

src/rpdk/core/data/pytest-contract.ini

@@ -19,4 +19,4 @@ markers =
     delete_pre_provision: preDelete handler related tests.
 
 filterwarnings =
-    ignore::hypothesis.errors.NonInteractiveExampleWarning:hypothesis
+    ignore::hypothesis.errors.NonInteractiveExampleWarning

src/rpdk/core/data_loaders.py

@@ -399,18 +399,23 @@ def load_hook_spec(hook_spec_file):  # pylint: disable=R # noqa: C901
         raise SpecValidationError(str(e)) from e
 
     blocked_handler_permissions = {"cloudformation:RegisterType"}
-    for handler in hook_spec.get("handlers", []):
-        for permission in hook_spec.get("handlers", [])[handler]["permissions"]:
+    for handler in hook_spec.get("handlers", {}).values():
+        for permission in handler["permissions"]:
             if "cloudformation:*" in permission:
                 raise SpecValidationError(
                     f"Wildcards for cloudformation are not allowed for hook handler permissions: '{permission}'"
                 )
-
             if permission in blocked_handler_permissions:
                 raise SpecValidationError(
                     f"Permission is not allowed for hook handler permissions: '{permission}'"
                 )
 
+        for target_name in handler["targetNames"]:
+            if "*?" in target_name:
+                raise SpecValidationError(
+                    f"Wildcard pattern '*?' is not allowed in target name: '{target_name}'"
+                )
+
     try:
         base_uri = hook_spec["$id"]
     except KeyError:

src/rpdk/core/exceptions.py

@@ -60,3 +60,7 @@ class ModelResolverError(RPDKBaseException):
 
 class InvalidFragmentFileError(RPDKBaseException):
     pass
+
+
+class InvalidTypeSchemaError(RPDKBaseException):
+    pass