Binary media types bug fix

samtranslator/model/sam_resources.py

@@ -475,6 +475,9 @@ def to_cloudformation(self, **kwargs):
         """
         resources = []
 
+        intrinsics_resolver = kwargs["intrinsics_resolver"]
+        self.BinaryMediaTypes = intrinsics_resolver.resolve_parameter_refs(self.BinaryMediaTypes)
+
         api_generator = ApiGenerator(self.logical_id,
                                      self.CacheClusterEnabled,
                                      self.CacheClusterSize,

samtranslator/swagger/swagger.py

@@ -1,4 +1,5 @@
 import copy
+import json
 import re
 from six import string_types
 
@@ -257,7 +258,8 @@ def add_cors(self, path, allowed_origins, allowed_headers=None, allowed_methods=
                                                                                            allow_credentials)
 
     def add_binary_media_types(self, binary_media_types):
-        self._doc[self._X_APIGW_BINARY_MEDIA_TYPES] = binary_media_types
+        bmt = json.loads(json.dumps(binary_media_types).replace('~1', '/'))
+        self._doc[self._X_APIGW_BINARY_MEDIA_TYPES] = bmt
 
     def _options_method_response_for_cors(self, allowed_origins, allowed_headers=None, allowed_methods=None,
                                           max_age=None, allow_credentials=None):

tests/translator/input/api_with_binary_media_types.yaml

@@ -1,8 +1,12 @@
+Parameters:
+  BMT:
+    Type: String
+    Default: 'image~1jpg'
 Globals:
   Api:
     BinaryMediaTypes:
-      - image/jpg
-      - {"Fn::Join": ["/", ["image", "png"]]}
+      - image~1gif
+      - {"Fn::Join": ["~1", ["image", "png"]]}
 
 Resources:
   ImplicitApiFunction:
@@ -24,4 +28,5 @@ Resources:
       StageName: Prod
       DefinitionUri: s3://sam-demo-bucket/webpage_swagger.json
       BinaryMediaTypes:
-        - image/gif
+        - application~1octet-stream
+        - !Ref BMT

tests/translator/input/api_with_binary_media_types_definition_body.yaml

@@ -1,23 +1,28 @@
+Parameters:
+  BMT:
+    Type: String
+    Default: image~1jpeg
 Globals:
   Api:
     BinaryMediaTypes:
-      - image/jpg
-      - {"Fn::Join": ["/", ["image", "png"]]}
+      - !Ref BMT
+      - image~1jpg
+      - {"Fn::Join": ["~1", ["image", "png"]]}
 
 Resources:
   ExplicitApiManagedSwagger:
     Type: AWS::Serverless::Api
     Properties:
       StageName: Prod
       BinaryMediaTypes:
-        - image/gif
+        - image~1gif
 
   ExplicitApiDefinitionBody:
     Type: AWS::Serverless::Api
     Properties:
       StageName: Prod
       BinaryMediaTypes:
-        - application/json
+        - application~1json
       DefinitionBody: {
           "paths": {}, 
           "swagger": "2.0", 

tests/translator/output/api_with_binary_media_types.json

@@ -1,4 +1,10 @@
 {
+  "Parameters": {
+    "BMT": {
+      "Default": "image~1jpg", 
+      "Type": "String"
+    }
+  }, 
   "Resources": {
     "ImplicitApiFunction": {
       "Type": "AWS::Lambda::Function", 
@@ -47,16 +53,6 @@
         }
       }
     }, 
-    "ExplicitApiDeploymentf117c932f7": {
-      "Type": "AWS::ApiGateway::Deployment", 
-      "Properties": {
-        "RestApiId": {
-          "Ref": "ExplicitApi"
-        }, 
-        "Description": "RestApi deployment id: f117c932f75cfa87d23dfed64e9430d0081ef289", 
-        "StageName": "Stage"
-      }
-    }, 
     "ImplicitApiFunctionGetHtmlPermissionTest": {
       "Type": "AWS::Lambda::Permission", 
       "Properties": {
@@ -103,17 +99,18 @@
       "Type": "AWS::ApiGateway::RestApi", 
       "Properties": {
         "BinaryMediaTypes": [
-          "image/jpg", 
+          "image~1gif", 
           {
             "Fn::Join": [
-              "/", 
+              "~1", 
               [
                 "image", 
                 "png"
               ]
             ]
           }, 
-          "image/gif"
+          "application~1octet-stream", 
+          "image~1jpg"
         ], 
         "BodyS3Location": {
           "Bucket": "sam-demo-bucket", 
@@ -137,21 +134,31 @@
       "Type": "AWS::ApiGateway::Stage", 
       "Properties": {
         "DeploymentId": {
-          "Ref": "ServerlessRestApiDeployment706c6ba929"
+          "Ref": "ServerlessRestApiDeployment4f3fcf6bd1"
         }, 
         "RestApiId": {
           "Ref": "ServerlessRestApi"
         }, 
         "StageName": "Prod"
       }
     }, 
-    "ServerlessRestApiDeployment706c6ba929": {
+    "ExplicitApiDeploymentf117c932f7": {
+      "Type": "AWS::ApiGateway::Deployment", 
+      "Properties": {
+        "RestApiId": {
+          "Ref": "ExplicitApi"
+        }, 
+        "Description": "RestApi deployment id: f117c932f75cfa87d23dfed64e9430d0081ef289", 
+        "StageName": "Stage"
+      }
+    }, 
+    "ServerlessRestApiDeployment4f3fcf6bd1": {
       "Type": "AWS::ApiGateway::Deployment", 
       "Properties": {
         "RestApiId": {
           "Ref": "ServerlessRestApi"
         }, 
-        "Description": "RestApi deployment id: 706c6ba9298c730536b2f4c51409cf33e5d616d4", 
+        "Description": "RestApi deployment id: 4f3fcf6bd13686961885c787e3a117b084ec6c3a", 
         "StageName": "Stage"
       }
     }, 
@@ -181,7 +188,7 @@
           }, 
           "swagger": "2.0", 
           "x-amazon-apigateway-binary-media-types": [
-            "image/jpg", 
+            "image/gif", 
             {
               "Fn::Join": [
                 "/", 
@@ -194,10 +201,10 @@
           ]
         }, 
         "BinaryMediaTypes": [
-          "image/jpg", 
+          "image~1gif", 
           {
             "Fn::Join": [
-              "/", 
+              "~1", 
               [
                 "image", 
                 "png"
@@ -208,4 +215,4 @@
       }
     }
   }
-}
+}

tests/translator/output/api_with_binary_media_types_definition_body.json

@@ -1,34 +1,30 @@
 {
+  "Parameters": {
+    "BMT": {
+      "Default": "image~1jpeg", 
+      "Type": "String"
+    }
+  }, 
   "Resources": {
-    "ExplicitApiManagedSwaggerDeployment51ba79c0e7": {
-      "Type": "AWS::ApiGateway::Deployment", 
-      "Properties": {
-        "RestApiId": {
-          "Ref": "ExplicitApiManagedSwagger"
-        }, 
-        "Description": "RestApi deployment id: 51ba79c0e7185c019037fb7f9f9f2235547af57b", 
-        "StageName": "Stage"
-      }
-    }, 
     "ExplicitApiManagedSwaggerProdStage": {
       "Type": "AWS::ApiGateway::Stage", 
       "Properties": {
         "DeploymentId": {
-          "Ref": "ExplicitApiManagedSwaggerDeployment51ba79c0e7"
+          "Ref": "ExplicitApiManagedSwaggerDeploymentfe9c2c09a2"
         }, 
         "RestApiId": {
           "Ref": "ExplicitApiManagedSwagger"
         }, 
         "StageName": "Prod"
       }
     }, 
-    "ExplicitApiDefinitionBodyDeploymentcb68c305fb": {
+    "ExplicitApiManagedSwaggerDeploymentfe9c2c09a2": {
       "Type": "AWS::ApiGateway::Deployment", 
       "Properties": {
         "RestApiId": {
-          "Ref": "ExplicitApiDefinitionBody"
+          "Ref": "ExplicitApiManagedSwagger"
         }, 
-        "Description": "RestApi deployment id: cb68c305fb80d8e723c6c5d51a7b62462a25f5ba", 
+        "Description": "RestApi deployment id: fe9c2c09a27ce00c2fa53d5a491cf343e6a3278e", 
         "StageName": "Stage"
       }
     }, 
@@ -39,6 +35,7 @@
           "paths": {}, 
           "swagger": "2.0", 
           "x-amazon-apigateway-binary-media-types": [
+            "image/jpeg", 
             "image/jpg", 
             {
               "Fn::Join": [
@@ -53,25 +50,36 @@
           ]
         }, 
         "BinaryMediaTypes": [
-          "image/jpg", 
+          "image~1jpeg", 
+          "image~1jpg", 
           {
             "Fn::Join": [
-              "/", 
+              "~1", 
               [
                 "image", 
                 "png"
               ]
             ]
           }, 
-          "application/json"
+          "application~1json"
         ]
       }
     }, 
+    "ExplicitApiDefinitionBodyDeployment1f26996adb": {
+      "Type": "AWS::ApiGateway::Deployment", 
+      "Properties": {
+        "RestApiId": {
+          "Ref": "ExplicitApiDefinitionBody"
+        }, 
+        "Description": "RestApi deployment id: 1f26996adbe5077359ecb2bb0688a9cc0ae8e4fc", 
+        "StageName": "Stage"
+      }
+    }, 
     "ExplicitApiDefinitionBodyProdStage": {
       "Type": "AWS::ApiGateway::Stage", 
       "Properties": {
         "DeploymentId": {
-          "Ref": "ExplicitApiDefinitionBodyDeploymentcb68c305fb"
+          "Ref": "ExplicitApiDefinitionBodyDeployment1f26996adb"
         }, 
         "RestApiId": {
           "Ref": "ExplicitApiDefinitionBody"
@@ -92,6 +100,7 @@
           "paths": {}, 
           "swagger": "2.0", 
           "x-amazon-apigateway-binary-media-types": [
+            "image/jpeg", 
             "image/jpg", 
             {
               "Fn::Join": [
@@ -106,19 +115,20 @@
           ]
         }, 
         "BinaryMediaTypes": [
-          "image/jpg", 
+          "image~1jpeg", 
+          "image~1jpg", 
           {
             "Fn::Join": [
-              "/", 
+              "~1", 
               [
                 "image", 
                 "png"
               ]
             ]
           }, 
-          "image/gif"
+          "image~1gif"
         ]
       }
     }
   }
-}
+}