Adding support for TypeConfiguration (#160)

Author: ammokhov

python/rpdk/python/codegen.py

@@ -149,6 +149,18 @@ def generate(self, project):
 
         models = resolve_models(project.schema)
 
+        if project.configuration_schema:
+            configuration_schema_path = (
+                project.root / project.configuration_schema_filename
+            )
+            project.write_configuration_schema(configuration_schema_path)
+            configuration_models = resolve_models(
+                project.configuration_schema, "TypeConfigurationModel"
+            )
+        else:
+            configuration_models = {"TypeConfigurationModel": {}}
+        models.update(configuration_models)
+
         path = self.package_root / self.package_name / "models.py"
         LOG.debug("Writing file: %s", path)
         template = self.env.get_template("models.py")
@@ -158,7 +170,7 @@ def generate(self, project):
         LOG.debug("Generate complete")
 
     def _pre_package(self, build_path):
-        f = TemporaryFile("w+b")  # pylint: disable=consider-using-with
+        f = TemporaryFile("w+b")  # pylint: disable=R1732
 
         with zipfile.ZipFile(f, mode="w") as zip_file:
             self._recursive_relative_write(build_path, build_path, zip_file)

python/rpdk/python/templates/models.py

@@ -35,6 +35,7 @@ class ResourceHandlerRequest(BaseResourceHandlerRequest):
     # pylint: disable=invalid-name
     desiredResourceState: Optional["ResourceModel"]
     previousResourceState: Optional["ResourceModel"]
+    typeConfiguration: Optional["TypeConfigurationModel"]
 
 
 {% for model, properties in models.items() %}

setup.py

@@ -38,9 +38,7 @@ def find_version(*file_paths):
     include_package_data=True,
     zip_safe=True,
     python_requires=">=3.6",
-    install_requires=[
-        "cloudformation-cli>=0.1.14",
-    ],
+    install_requires=["cloudformation-cli>=0.2.13", "types-dataclasses>=0.1.5"],
     entry_points={
         "rpdk.v1.languages": [
             "python37 = rpdk.python.codegen:Python37LanguagePlugin",

src/cloudformation_cli_python_lib/exceptions.py

@@ -74,3 +74,11 @@ class NetworkFailure(_HandlerError):
 
 class InternalFailure(_HandlerError):
     pass
+
+
+class InvalidTypeConfiguration(_HandlerError):
+    def __init__(self, type_name: str, message: str):
+        super().__init__(
+            f"Invalid TypeConfiguration provided for type {type_name}."
+            f" Reason: {message}"
+        )

src/cloudformation_cli_python_lib/interface.py

@@ -56,6 +56,7 @@ class HandlerErrorCode(str, _AutoName):
     ServiceInternalError = auto()
     NetworkFailure = auto()
     InternalFailure = auto()
+    InvalidTypeConfiguration = auto()
 
 
 class BaseModel:
@@ -137,6 +138,7 @@ class BaseResourceHandlerRequest:
     previousSystemTags: Optional[Mapping[str, Any]]
     awsAccountId: Optional[str]
     logicalResourceIdentifier: Optional[str]
+    typeConfiguration: Optional[BaseModel]
     nextToken: Optional[str]
     region: Optional[str]
     awsPartition: Optional[str]

src/cloudformation_cli_python_lib/resource.py

@@ -56,9 +56,17 @@ def wrapper(self: Any, event: MutableMapping[str, Any], context: Any) -> Any:
 
 
 class Resource:
-    def __init__(self, type_name: str, resouce_model_cls: Type[BaseModel]) -> None:
+    def __init__(
+        self,
+        type_name: str,
+        resouce_model_cls: Type[BaseModel],
+        type_configuration_model_cls: Optional[BaseModel] = None,
+    ) -> None:
         self.type_name = type_name
         self._model_cls: Type[BaseModel] = resouce_model_cls
+        self._type_configuration_model_cls: Optional[
+            BaseModel
+        ] = type_configuration_model_cls
         self._handlers: MutableMapping[Action, HandlerSignature] = {}
 
     def handler(self, action: Action) -> Callable[[HandlerSignature], HandlerSignature]:
@@ -101,7 +109,7 @@ def _parse_test_request(
             creds = Credentials(**event.credentials)
             request: BaseResourceHandlerRequest = UnmodelledRequest(
                 **event.request
-            ).to_modelled(self._model_cls)
+            ).to_modelled(self._model_cls, self._type_configuration_model_cls)
 
             session = _get_boto_session(creds, event.region)
             action = Action[event.action]
@@ -164,7 +172,8 @@ def _cast_resource_request(
                 logicalResourceIdentifier=request.requestData.logicalResourceId,
                 stackId=request.stackId,
                 region=request.region,
-            ).to_modelled(self._model_cls)
+                typeConfiguration=request.requestData.typeConfiguration,
+            ).to_modelled(self._model_cls, self._type_configuration_model_cls)
         except Exception as e:  # pylint: disable=broad-except
             LOG.exception("Invalid request")
             raise InvalidRequest(f"{e} ({type(e).__name__})") from e

src/cloudformation_cli_python_lib/utils.py

@@ -59,6 +59,7 @@ class RequestData:
     previousResourceProperties: Optional[Mapping[str, Any]] = None
     previousStackTags: Optional[Mapping[str, Any]] = None
     previousSystemTags: Optional[Mapping[str, Any]] = None
+    typeConfiguration: Optional[Mapping[str, Any]] = None
 
     def __init__(self, **kwargs: Any) -> None:
         dataclass_fields = {f.name for f in fields(self)}
@@ -129,13 +130,18 @@ class UnmodelledRequest:
     previousResourceTags: Optional[Mapping[str, Any]] = None
     systemTags: Optional[Mapping[str, Any]] = None
     previousSystemTags: Optional[Mapping[str, Any]] = None
+    typeConfiguration: Optional[Mapping[str, Any]] = None
     awsAccountId: Optional[str] = None
     logicalResourceIdentifier: Optional[str] = None
     nextToken: Optional[str] = None
     stackId: Optional[str] = None
     region: Optional[str] = None
 
-    def to_modelled(self, model_cls: Type[BaseModel]) -> BaseResourceHandlerRequest:
+    def to_modelled(
+        self,
+        model_cls: Type[BaseModel],
+        type_configuration_model_cls: Optional[BaseModel],
+    ) -> BaseResourceHandlerRequest:
         # pylint: disable=protected-access
         return BaseResourceHandlerRequest(
             clientRequestToken=self.clientRequestToken,
@@ -147,6 +153,9 @@ def to_modelled(self, model_cls: Type[BaseModel]) -> BaseResourceHandlerRequest:
             previousSystemTags=self.previousSystemTags,
             awsAccountId=self.awsAccountId,
             logicalResourceIdentifier=self.logicalResourceIdentifier,
+            typeConfiguration=None
+            if not type_configuration_model_cls
+            else type_configuration_model_cls._deserialize(self.typeConfiguration),
             nextToken=self.nextToken,
             stackId=self.stackId,
             region=self.region,

tests/data/schema-with-typeconfiguration.json

@@ -0,0 +1,50 @@
+{
+    "typeName": "Company::Test::Type",
+    "description": "Test type",
+    "typeConfiguration": {
+        "properties": {
+            "Credentials": {
+                "$ref": "#/definitions/Credentials"
+            }
+        },
+        "additionalProperties": false,
+        "required": [
+            "Credentials"
+        ]
+    },
+    "definitions": {
+        "Credentials": {
+            "type": "object",
+            "properties": {
+                "ApiKey": {
+                    "description": "API key",
+                    "type": "string"
+                },
+                "ApplicationKey": {
+                    "description": "application key",
+                    "type": "string"
+                },
+                "CountryCode": {
+                    "type": "string"
+                }
+            },
+            "additionalProperties": false
+        }
+    },
+    "properties": {
+        "Type": {
+            "type": "string",
+            "description": "The type of the monitor",
+            "enum": [
+                "composite"
+            ]
+        }
+    },
+    "required": [
+        "Type"
+    ],
+    "primaryIdentifier": [
+        "/properties/Type"
+    ],
+    "additionalProperties": false
+}

tests/lib/interface_test.py

@@ -127,9 +127,3 @@ def test_operation_status_enum_matches_sdk(client):
     sdk = set(client.meta.service_model.shape_for("OperationStatus").enum)
     enum = set(OperationStatus.__members__)
     assert enum == sdk
-
-
-def test_handler_error_code_enum_matches_sdk(client):
-    sdk = set(client.meta.service_model.shape_for("HandlerErrorCode").enum)
-    enum = set(HandlerErrorCode.__members__)
-    assert enum == sdk

tests/lib/resource_test.py

@@ -45,6 +45,7 @@
         "previousSystemTags": {},
         "stackTags": {"tag1": "abc"},
         "previousStackTags": {"tag1": "def"},
+        "typeConfiguration": sentinel.type_configuration,
     },
     "stackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/e"
     "722ae60-fe62-11e8-9a0e-0ae8cc519968",
@@ -76,7 +77,7 @@ def test_entrypoint_handler_error(resource):
 
 
 def test_entrypoint_success():
-    resource = Resource(TYPE_NAME, Mock())
+    resource = Resource(TYPE_NAME, Mock(), Mock())
     event = ProgressEvent(status=OperationStatus.SUCCESS, message="")
     mock_handler = resource.handler(Action.CREATE)(Mock(return_value=event))
 
@@ -106,7 +107,15 @@ class ResourceModel(BaseModel):
         def _deserialize(cls, json_data):
             return cls("test")
 
-    resource = Resource(Mock(), ResourceModel)
+    @dataclass
+    class TypeConfigurationModel(BaseModel):
+        a_string: str
+
+        @classmethod
+        def _deserialize(cls, json_data):
+            return cls("test")
+
+    resource = Resource(Mock(), ResourceModel, TypeConfigurationModel)
 
     with patch(
         "cloudformation_cli_python_lib.resource.ProviderLogHandler.setup"
@@ -132,7 +141,7 @@ def _deserialize(cls, json_data):
 def test_entrypoint_non_mutating_action():
     payload = ENTRYPOINT_PAYLOAD.copy()
     payload["action"] = "READ"
-    resource = Resource(TYPE_NAME, Mock())
+    resource = Resource(TYPE_NAME, Mock(), Mock())
     event = ProgressEvent(status=OperationStatus.SUCCESS, message="")
     resource.handler(Action.CREATE)(Mock(return_value=event))
 
@@ -148,7 +157,7 @@ def test_entrypoint_non_mutating_action():
 def test_entrypoint_with_context():
     payload = ENTRYPOINT_PAYLOAD.copy()
     payload["callbackContext"] = {"a": "b"}
-    resource = Resource(TYPE_NAME, Mock())
+    resource = Resource(TYPE_NAME, Mock(), Mock())
     event = ProgressEvent(
         status=OperationStatus.SUCCESS, message="", callbackContext={"c": "d"}
     )
@@ -163,7 +172,7 @@ def test_entrypoint_with_context():
 
 
 def test_entrypoint_success_without_caller_provider_creds():
-    resource = Resource(TYPE_NAME, Mock())
+    resource = Resource(TYPE_NAME, Mock(), Mock())
     event = ProgressEvent(status=OperationStatus.SUCCESS, message="")
     resource.handler(Action.CREATE)(Mock(return_value=event))
 
@@ -208,7 +217,12 @@ def test__parse_request_valid_request_and__cast_resource_request():
     mock_model = Mock(spec_set=["_deserialize"])
     mock_model._deserialize.side_effect = [sentinel.state_out1, sentinel.state_out2]
 
-    resource = Resource(TYPE_NAME, mock_model)
+    mock_type_configuration_model = Mock(spec_set=["_deserialize"])
+    mock_type_configuration_model._deserialize.side_effect = [
+        sentinel.type_configuration
+    ]
+
+    resource = Resource(TYPE_NAME, mock_model, mock_type_configuration_model)
 
     with patch(
         "cloudformation_cli_python_lib.resource._get_boto_session"
@@ -229,6 +243,7 @@ def test__parse_request_valid_request_and__cast_resource_request():
     # credentials are used when rescheduling, so can't zero them out (for now)
     assert request.requestData.callerCredentials is not None
     assert request.requestData.providerCredentials is not None
+    assert request.requestData.typeConfiguration is sentinel.type_configuration
 
     caller_sess, provider_sess = sessions
     assert caller_sess is mock_session.return_value
@@ -245,6 +260,7 @@ def test__parse_request_valid_request_and__cast_resource_request():
     assert modeled_request.clientRequestToken == request.bearerToken
     assert modeled_request.desiredResourceState is sentinel.state_out1
     assert modeled_request.previousResourceState is sentinel.state_out2
+    assert modeled_request.typeConfiguration is sentinel.type_configuration
     assert modeled_request.logicalResourceIdentifier == "myBucket"
     assert modeled_request.nextToken is None
 
@@ -337,6 +353,11 @@ def test__parse_test_request_valid_request():
     mock_model = Mock(spec_set=["_deserialize"])
     mock_model._deserialize.side_effect = [sentinel.state_out1, sentinel.state_out2]
 
+    mock_type_configuration_model = Mock(spec_set=["_deserialize"])
+    mock_type_configuration_model._deserialize.side_effect = [
+        sentinel.type_configuration
+    ]
+
     payload = {
         "credentials": {"accessKeyId": "", "secretAccessKey": "", "sessionToken": ""},
         "action": "CREATE",
@@ -345,11 +366,12 @@ def test__parse_test_request_valid_request():
             "desiredResourceState": sentinel.state_in1,
             "previousResourceState": sentinel.state_in2,
             "logicalResourceIdentifier": None,
+            "typeConfiguration": sentinel.type_configuration,
         },
         "callbackContext": None,
     }
 
-    resource = Resource(TYPE_NAME, mock_model)
+    resource = Resource(TYPE_NAME, mock_model, mock_type_configuration_model)
 
     with patch(
         "cloudformation_cli_python_lib.resource._get_boto_session"
@@ -366,6 +388,7 @@ def test__parse_test_request_valid_request():
     )
     assert request.desiredResourceState is sentinel.state_out1
     assert request.previousResourceState is sentinel.state_out2
+    assert request.typeConfiguration is sentinel.type_configuration
     assert request.logicalResourceIdentifier is None
 
     assert action == Action.CREATE
@@ -394,7 +417,10 @@ def test_test_entrypoint_success():
     mock_model = Mock(spec_set=["_deserialize"])
     mock_model._deserialize.side_effect = [None, None]
 
-    resource = Resource(TYPE_NAME, mock_model)
+    mock_type_configuration_model = Mock(spec_set=["_deserialize"])
+    mock_type_configuration_model._deserialize.side_effect = [None]
+
+    resource = Resource(TYPE_NAME, mock_model, mock_type_configuration_model)
     progress_event = ProgressEvent(status=OperationStatus.SUCCESS)
     mock_handler = resource.handler(Action.CREATE)(Mock(return_value=progress_event))
 
@@ -415,4 +441,5 @@ def test_test_entrypoint_success():
     assert event is progress_event
 
     mock_model._deserialize.assert_has_calls([call(None), call(None)])
+    mock_type_configuration_model._deserialize.assert_has_calls([call(None)])
     mock_handler.assert_called_once()