fix: Useful error message when "Properties" key is missing in embedded connectors (#2966)

aaythapa · web-flow · commit be0ddc20cc30 · 2023-02-28T01:13:20.000Z
diff --git a/samtranslator/translator/translator.py b/samtranslator/translator/translator.py
@@ -340,6 +340,7 @@ def _get_embedded_connectors(self, resources: Dict[str, Any]) -> List[Resource]:
                     generated_connector = self._get_generated_connector(
                         source_logical_id,
                         full_connector_logical_id,
+                        connector_logical_id,
                         connector_dict,
                     )
 
@@ -354,40 +355,47 @@ def _get_embedded_connectors(self, resources: Dict[str, Any]) -> List[Resource]:
         return connectors
 
     def _get_generated_connector(
-        self, source_logical_id: str, connector_logical_id: str, connector_dict: Dict[str, Any]
+        self,
+        source_logical_id: str,
+        full_connector_logical_id: str,
+        connector_logical_id: str,
+        connector_dict: Dict[str, Any],
     ) -> Resource:
         """
         Generates the connector resource from the embedded connector
 
         :param str source_logical_id: Logical id of the resource the connector is attached to
-        :param str connector_logical_id: Logical id of the connector
+        :param str full_connector_logical_id: source_logical_id + connector_logical_id
+        :param str connector_logical_id: Logical id of the connector defined by the user
         :param dict connector_dict: The properties of the connector including the Destination, Permissions and optionally the SourceReference
         :return: The generated SAMConnector resource
         """
         connector = copy.deepcopy(connector_dict)
         connector["Type"] = SamConnector.resource_type
 
-        # No need to raise an error for this instance as the error will be caught by the parser
-        if "Properties" in connector_dict and isinstance(connector_dict["Properties"], dict):
-            properties = connector["Properties"]
-            properties["Source"] = {"Id": source_logical_id}
-            if "SourceReference" in properties:
-                sam_expect(
-                    properties.get("SourceReference"),
-                    connector_logical_id,
-                    f"{connector_logical_id}.Properties.SourceReference",
-                ).to_be_a_map()
-
-                # can't allow user to override the Id using SourceReference
-                if "Id" in properties["SourceReference"]:
-                    raise InvalidResourceException(
-                        connector_logical_id, "'Id' shouldn't be defined in 'SourceReference'."
-                    )
-
-                properties["Source"].update(properties["SourceReference"])
-                del properties["SourceReference"]
-
-        return SamConnector.from_dict(connector_logical_id, connector)
+        properties = sam_expect(
+            connector.get("Properties"),
+            source_logical_id,
+            f"Connectors.{connector_logical_id}.Properties",
+            is_resource_attribute=True,
+        ).to_be_a_map()
+
+        properties["Source"] = {"Id": source_logical_id}
+        if "SourceReference" in properties:
+            source_reference = sam_expect(
+                properties.get("SourceReference"),
+                source_logical_id,
+                f"Connectors.{connector_logical_id}.Properties.SourceReference",
+            ).to_be_a_map()
+
+            # can't allow user to override the Id using SourceReference
+            if "Id" in source_reference:
+                raise InvalidResourceException(connector_logical_id, "'Id' shouldn't be defined in 'SourceReference'.")
+
+            properties["Source"].update(source_reference)
+            del properties["SourceReference"]
+
+        return SamConnector.from_dict(full_connector_logical_id, connector)
 
 
 def prepare_plugins(plugins: Optional[List[BasePlugin]], parameters: Optional[Dict[str, Any]] = None) -> SamPlugins:
diff --git a/tests/translator/input/error_embedded_connectors.yaml b/tests/translator/input/error_embedded_connectors.yaml
@@ -10,6 +10,11 @@ Resources:
   MyFunction:
     Type: AWS::Serverless::Function
     Connectors:
+      NoProperties:
+        Destination:
+          Id: MyQueue
+        Permissions:
+        - Write
       NonDictProperties:
         Properties: foo
       EmptyProperties:
@@ -79,6 +84,13 @@ Resources:
             Id: MyQueue
           Permissions:
           - Write
+      NonDictSourceReference:
+        Properties:
+          SourceReference: foo
+          Destination:
+            Id: MyQueue
+          Permissions:
+          - Write
     Properties:
       Runtime: python3.9
       InlineCode: foo
diff --git a/tests/translator/output/error_embedded_connectors.json b/tests/translator/output/error_embedded_connectors.json
@@ -1,7 +1,7 @@
 {
   "_autoGeneratedBreakdownErrorMessage": [
     "Invalid Serverless Application Specification document. ",
-    "Number of errors found: 22. ",
+    "Number of errors found: 24. ",
     "Transforming resource with id [DuplicateTest] attempts to create a new resource with id [DuplicateTestDuplicateId] and type \"AWS::Serverless::Connector\". ",
     "A resource with that id already exists within this template. ",
     "Please use a different id for that resource. ",
@@ -11,6 +11,14 @@
     "Destination.Arn is missing. ",
     "Resource with id [EventsRuleMissingSqsQueueUrl] is invalid. ",
     "Unable to create connector from AWS::Events::Rule to AWS::SQS:Queue; it's not supported or the template is invalid. ",
+    "Resource with id [MyFunction] is invalid. ",
+    "Attribute 'Connectors.NoProperties.Properties' should be a map. ",
+    "Resource with id [MyFunction] is invalid. ",
+    "Attribute 'Connectors.NonDictProperties.Properties' should be a map. ",
+    "Resource with id [MyFunction] is invalid. ",
+    "Attribute 'Connectors.EmptyProperties.Properties' should be a map. ",
+    "Resource with id [MyFunction] is invalid. ",
+    "Property 'Connectors.NonDictSourceReference.Properties.SourceReference' should be a map. ",
     "Resource with id [MyFunctionBothIdAndOtherProps] is invalid. ",
     "Must provide 'Id' (with optional 'Qualifier') or a supported combination of other properties. ",
     "Resource with id [MyFunctionEmptyDestination] is invalid. ",
@@ -19,8 +27,6 @@
     "Missing required property 'Permissions'. ",
     "Resource with id [MyFunctionEmptyPermissionsList] is invalid. ",
     "'Permissions' cannot be empty; valid values are: Read, Write. ",
-    "Resource with id [MyFunctionEmptyProperties] is invalid. ",
-    "Properties of a resource must be an object. ",
     "Resource with id [MyFunctionMissingRoleMissingRole] is invalid. ",
     "Unable to get IAM role name from 'Source' resource. ",
     "Resource with id [MyFunctionNoDestination] is invalid. ",
@@ -33,20 +39,18 @@
     "Missing required property 'Permissions'. ",
     "Resource with id [MyFunctionNoStrId] is invalid. ",
     "'Id' is missing or not a string. ",
-    "Resource with id [MyFunctionNonDictProperties] is invalid. ",
-    "Properties of a resource must be an object. ",
     "Resource with id [MyFunctionNonExistentId] is invalid. ",
     "Unable to find resource with logical ID 'ThisDoesntExist'. ",
-    "Resource with id [MyFunctionTestSourceReferenceId] is invalid. ",
-    "'Id' shouldn't be defined in 'SourceReference'. ",
     "Resource with id [MyFunctionUnsupportedAccessCategory] is invalid. ",
     "Unsupported 'Permissions' provided for connector from AWS::Lambda::Function to AWS::SQS::Queue; valid values are: Read, Write. ",
     "Resource with id [MyQueueMissingRoleDestination] is invalid. ",
     "Unable to get IAM role name from 'Destination' resource. ",
     "Resource with id [MyQueueUnsupportedAccessCategoryCombination] is invalid. ",
     "Unsupported 'Permissions' provided for connector from AWS::SQS::Queue to AWS::Lambda::Function; valid combinations are: Read + Write. ",
     "Resource with id [MyResourceWithoutTypeResourceWithoutType] is invalid. ",
-    "'Type' is missing or not a string."
+    "'Type' is missing or not a string. ",
+    "Resource with id [TestSourceReferenceId] is invalid. ",
+    "'Id' shouldn't be defined in 'SourceReference'."
   ],
-  "errorMessage": "Invalid Serverless Application Specification document. Number of errors found: 22. Transforming resource with id [DuplicateTest] attempts to create a new resource with id [DuplicateTestDuplicateId] and type \"AWS::Serverless::Connector\". A resource with that id already exists within this template. Please use a different id for that resource. Resource with id [EventsRuleMissingLambdaFunctionArn] is invalid. Unable to get Lambda function ARN from 'Destination' resource. Resource with id [EventsRuleMissingSnsTopicArn] is invalid. Destination.Arn is missing. Resource with id [EventsRuleMissingSqsQueueUrl] is invalid. Unable to create connector from AWS::Events::Rule to AWS::SQS:Queue; it's not supported or the template is invalid. Resource with id [MyFunctionBothIdAndOtherProps] is invalid. Must provide 'Id' (with optional 'Qualifier') or a supported combination of other properties. Resource with id [MyFunctionEmptyDestination] is invalid. Missing required property 'Destination'. Resource with id [MyFunctionEmptyPermissions] is invalid. Missing required property 'Permissions'. Resource with id [MyFunctionEmptyPermissionsList] is invalid. 'Permissions' cannot be empty; valid values are: Read, Write. Resource with id [MyFunctionEmptyProperties] is invalid. Properties of a resource must be an object. Resource with id [MyFunctionMissingRoleMissingRole] is invalid. Unable to get IAM role name from 'Source' resource. Resource with id [MyFunctionNoDestination] is invalid. Missing required property 'Destination'. Resource with id [MyFunctionNoDictConnectorNonDictConnector] is invalid. MyFunctionNoDictConnector.MyFunctionNoDictConnectorNonDictConnector should be a map. Resource with id [MyFunctionNoIdMissingType] is invalid. 'Type' is missing or not a string. Resource with id [MyFunctionNoPermissions] is invalid. Missing required property 'Permissions'. Resource with id [MyFunctionNoStrId] is invalid. 'Id' is missing or not a string. Resource with id [MyFunctionNonDictProperties] is invalid. Properties of a resource must be an object. Resource with id [MyFunctionNonExistentId] is invalid. Unable to find resource with logical ID 'ThisDoesntExist'. Resource with id [MyFunctionTestSourceReferenceId] is invalid. 'Id' shouldn't be defined in 'SourceReference'. Resource with id [MyFunctionUnsupportedAccessCategory] is invalid. Unsupported 'Permissions' provided for connector from AWS::Lambda::Function to AWS::SQS::Queue; valid values are: Read, Write. Resource with id [MyQueueMissingRoleDestination] is invalid. Unable to get IAM role name from 'Destination' resource. Resource with id [MyQueueUnsupportedAccessCategoryCombination] is invalid. Unsupported 'Permissions' provided for connector from AWS::SQS::Queue to AWS::Lambda::Function; valid combinations are: Read + Write. Resource with id [MyResourceWithoutTypeResourceWithoutType] is invalid. 'Type' is missing or not a string."
+  "errorMessage": "Invalid Serverless Application Specification document. Number of errors found: 24. Transforming resource with id [DuplicateTest] attempts to create a new resource with id [DuplicateTestDuplicateId] and type \"AWS::Serverless::Connector\". A resource with that id already exists within this template. Please use a different id for that resource. Resource with id [EventsRuleMissingLambdaFunctionArn] is invalid. Unable to get Lambda function ARN from 'Destination' resource. Resource with id [EventsRuleMissingSnsTopicArn] is invalid. Destination.Arn is missing. Resource with id [EventsRuleMissingSqsQueueUrl] is invalid. Unable to create connector from AWS::Events::Rule to AWS::SQS:Queue; it's not supported or the template is invalid. Resource with id [MyFunction] is invalid. Attribute 'Connectors.NoProperties.Properties' should be a map. Resource with id [MyFunction] is invalid. Attribute 'Connectors.NonDictProperties.Properties' should be a map. Resource with id [MyFunction] is invalid. Attribute 'Connectors.EmptyProperties.Properties' should be a map. Resource with id [MyFunction] is invalid. Property 'Connectors.NonDictSourceReference.Properties.SourceReference' should be a map. Resource with id [MyFunctionBothIdAndOtherProps] is invalid. Must provide 'Id' (with optional 'Qualifier') or a supported combination of other properties. Resource with id [MyFunctionEmptyDestination] is invalid. Missing required property 'Destination'. Resource with id [MyFunctionEmptyPermissions] is invalid. Missing required property 'Permissions'. Resource with id [MyFunctionEmptyPermissionsList] is invalid. 'Permissions' cannot be empty; valid values are: Read, Write. Resource with id [MyFunctionMissingRoleMissingRole] is invalid. Unable to get IAM role name from 'Source' resource. Resource with id [MyFunctionNoDestination] is invalid. Missing required property 'Destination'. Resource with id [MyFunctionNoDictConnectorNonDictConnector] is invalid. MyFunctionNoDictConnector.MyFunctionNoDictConnectorNonDictConnector should be a map. Resource with id [MyFunctionNoIdMissingType] is invalid. 'Type' is missing or not a string. Resource with id [MyFunctionNoPermissions] is invalid. Missing required property 'Permissions'. Resource with id [MyFunctionNoStrId] is invalid. 'Id' is missing or not a string. Resource with id [MyFunctionNonExistentId] is invalid. Unable to find resource with logical ID 'ThisDoesntExist'. Resource with id [MyFunctionUnsupportedAccessCategory] is invalid. Unsupported 'Permissions' provided for connector from AWS::Lambda::Function to AWS::SQS::Queue; valid values are: Read, Write. Resource with id [MyQueueMissingRoleDestination] is invalid. Unable to get IAM role name from 'Destination' resource. Resource with id [MyQueueUnsupportedAccessCategoryCombination] is invalid. Unsupported 'Permissions' provided for connector from AWS::SQS::Queue to AWS::Lambda::Function; valid combinations are: Read + Write. Resource with id [MyResourceWithoutTypeResourceWithoutType] is invalid. 'Type' is missing or not a string. Resource with id [TestSourceReferenceId] is invalid. 'Id' shouldn't be defined in 'SourceReference'."
 }
