fix: openapiversion bails if it is not a string

samtranslator/model/api/api_generator.py

@@ -1,7 +1,5 @@
 from collections import namedtuple
 from six import string_types
-import re
-
 from samtranslator.model.intrinsics import ref
 from samtranslator.model.apigateway import (ApiGatewayDeployment, ApiGatewayRestApi,
                                             ApiGatewayStage, ApiGatewayAuthorizer,
@@ -107,9 +105,10 @@ def _construct_rest_api(self):
                                            "Specify either 'DefinitionUri' or 'DefinitionBody' property and not both")
 
         if self.open_api_version:
-            if re.match(SwaggerEditor.get_openapi_versions_supported_regex(), self.open_api_version) is None:
-                raise InvalidResourceException(
-                    self.logical_id, "The OpenApiVersion value must be of the format 3.0.0")
+            if not SwaggerEditor.safe_compare_regex_with_string(SwaggerEditor.get_openapi_versions_supported_regex(),
+                                                                self.open_api_version):
+                raise InvalidResourceException(self.logical_id,
+                                               "The OpenApiVersion value must be of the format \"3.0.0\"")
 
         self._add_cors()
         self._add_auth()
@@ -412,11 +411,12 @@ def _openapi_postprocess(self, definition_body):
         if definition_body.get('swagger') is not None:
             return definition_body
 
-        if definition_body.get('openapi') is not None:
-            if self.open_api_version is None:
-                self.open_api_version = definition_body.get('openapi')
+        if definition_body.get('openapi') is not None and self.open_api_version is None:
+            self.open_api_version = definition_body.get('openapi')
 
-        if self.open_api_version and re.match(SwaggerEditor.get_openapi_version_3_regex(), self.open_api_version):
+        if self.open_api_version and \
+           SwaggerEditor.safe_compare_regex_with_string(SwaggerEditor.get_openapi_version_3_regex(),
+                                                        self.open_api_version):
             if definition_body.get('securityDefinitions'):
                 components = definition_body.get('components', {})
                 components['securitySchemes'] = definition_body['securityDefinitions']

samtranslator/plugins/globals/globals.py

@@ -1,7 +1,7 @@
 from samtranslator.public.sdk.resource import SamResourceType
 from samtranslator.public.intrinsics import is_intrinsics
 from samtranslator.swagger.swagger import SwaggerEditor
-import re
+from six import string_types
 
 
 class Globals(object):
@@ -135,8 +135,11 @@ def fix_openapi_definitions(cls, template):
             if ("Type" in resource) and (resource["Type"] == cls._API_TYPE):
                 properties = resource["Properties"]
                 if (cls._OPENAPIVERSION in properties) and (cls._MANAGE_SWAGGER in properties) and \
-                    (re.match(SwaggerEditor.get_openapi_version_3_regex(),
-                              properties[cls._OPENAPIVERSION]) is not None):
+                    SwaggerEditor.safe_compare_regex_with_string(
+                        SwaggerEditor.get_openapi_version_3_regex(), properties[cls._OPENAPIVERSION]):
+                    if not isinstance(properties[cls._OPENAPIVERSION], string_types):
+                        properties[cls._OPENAPIVERSION] = str(properties[cls._OPENAPIVERSION])
+                        resource["Properties"] = properties
                     if "DefinitionBody" in properties:
                         definition_body = properties['DefinitionBody']
                         definition_body['openapi'] = properties[cls._OPENAPIVERSION]

samtranslator/swagger/swagger.py

@@ -740,8 +740,8 @@ def add_request_model_to_method(self, path, method_name, request_model):
                 method_definition['parameters'] = existing_parameters
 
             elif self._doc.get("openapi") and \
-                    re.search(SwaggerEditor.get_openapi_version_3_regex(), self._doc["openapi"]) is not None:
-
+                    SwaggerEditor.safe_compare_regex_with_string(
+                        SwaggerEditor.get_openapi_version_3_regex(), self._doc["openapi"]):
                 method_definition['requestBody'] = {
                     'content': {
                         "application/json": {
@@ -901,8 +901,8 @@ def is_valid(data):
             if bool(data.get("swagger")):
                 return True
             elif bool(data.get("openapi")):
-                return re.search(SwaggerEditor.get_openapi_version_3_regex(), data["openapi"]) is not None
-            return False
+                return SwaggerEditor.safe_compare_regex_with_string(
+                    SwaggerEditor.get_openapi_version_3_regex(), data["openapi"])
         return False
 
     @staticmethod
@@ -951,3 +951,7 @@ def get_openapi_versions_supported_regex():
     def get_openapi_version_3_regex():
         openapi_version_3_regex = r"\A3(\.\d)(\.\d)?$"
         return openapi_version_3_regex
+
+    @staticmethod
+    def safe_compare_regex_with_string(regex, data):
+        return re.match(regex, str(data)) is not None

samtranslator/translator/translator.py

@@ -1,5 +1,4 @@
 import copy
-
 from samtranslator.model import ResourceTypeResolver, sam_resources
 from samtranslator.translator.verify_logical_id import verify_unique_logical_id
 from samtranslator.model.preferences.deployment_preference_collection import DeploymentPreferenceCollection

tests/translator/input/api_request_model_openapi_3.yaml

@@ -33,7 +33,7 @@ Resources:
     Type: AWS::Serverless::Api
     Properties:
       StageName: Prod
-      OpenApiVersion: '3.0.1'
+      OpenApiVersion: 3.0
       Models:
         User:
           type: object

tests/translator/input/api_with_open_api_version.yaml

@@ -1,6 +1,6 @@
 Globals:
   Api:
-    OpenApiVersion: '3.0.1'
+    OpenApiVersion: 3.0.1
     Cors: '*'
 
 Resources:

tests/translator/input/error_api_with_invalid_open_api_version_type.yaml

@@ -0,0 +1,21 @@
+Resources:
+  MyApi:
+    Type: AWS::Serverless::Api
+    Properties:
+      DefinitionBody: {}
+      OpenApiVersion: 3
+      StageName: 'prod'
+  Function:
+    Type: AWS::Serverless::Function
+    Properties:
+      Handler: lambda.handler
+      CodeUri: s3://bucket/api
+      Runtime: nodejs8.10
+      Events:
+        ProxyApiRoot:
+          Type: Api
+          Properties:
+            RestApiId:
+              Ref: MyApi
+            Path: "/"
+            Method: ANY

tests/translator/output/api_request_model_openapi_3.json

@@ -21,15 +21,6 @@
         }
       }
     }, 
-    "HtmlApiDeploymentefb667b26e": {
-      "Type": "AWS::ApiGateway::Deployment", 
-      "Properties": {
-        "RestApiId": {
-          "Ref": "HtmlApi"
-        }, 
-        "Description": "RestApi deployment id: efb667b26e8a0b0f733f5dfc27d039c1a2867db0"
-      }
-    }, 
     "HtmlFunctionRole": {
       "Type": "AWS::IAM::Role", 
       "Properties": {
@@ -58,7 +49,7 @@
       "Type": "AWS::ApiGateway::Stage", 
       "Properties": {
         "DeploymentId": {
-          "Ref": "HtmlApiDeploymentefb667b26e"
+          "Ref": "HtmlApiDeployment59eeb787ee"
         }, 
         "RestApiId": {
           "Ref": "HtmlApi"
@@ -149,7 +140,7 @@
               }
             }
           }, 
-          "openapi": "3.0.1", 
+          "openapi": "3.0", 
           "components": {
             "securitySchemes": {
               "AWS_IAM": {
@@ -173,6 +164,15 @@
         }
       }
     }, 
+    "HtmlApiDeployment59eeb787ee": {
+      "Type": "AWS::ApiGateway::Deployment", 
+      "Properties": {
+        "RestApiId": {
+          "Ref": "HtmlApi"
+        }, 
+        "Description": "RestApi deployment id: 59eeb787ee1561329a07e10162ac3718998e9f91"
+      }
+    }, 
     "HtmlFunctionGetHtmlPermissionTest": {
       "Type": "AWS::Lambda::Permission", 
       "Properties": {

tests/translator/output/aws-cn/api_request_model_openapi_3.json

@@ -1,5 +1,14 @@
 {
   "Resources": {
+    "HtmlApiDeployment5ae7e42cea": {
+      "Type": "AWS::ApiGateway::Deployment", 
+      "Properties": {
+        "RestApiId": {
+          "Ref": "HtmlApi"
+        }, 
+        "Description": "RestApi deployment id: 5ae7e42cea0640a3318bf508535850cd792a52dc"
+      }
+    }, 
     "HtmlFunctionIamPermissionTest": {
       "Type": "AWS::Lambda::Permission", 
       "Properties": {
@@ -21,15 +30,6 @@
         }
       }
     }, 
-    "HtmlApiDeploymentbe02cbff83": {
-      "Type": "AWS::ApiGateway::Deployment", 
-      "Properties": {
-        "RestApiId": {
-          "Ref": "HtmlApi"
-        }, 
-        "Description": "RestApi deployment id: be02cbff831c2acb5672650bc54b204366bef429"
-      }
-    }, 
     "HtmlFunctionRole": {
       "Type": "AWS::IAM::Role", 
       "Properties": {
@@ -58,7 +58,7 @@
       "Type": "AWS::ApiGateway::Stage", 
       "Properties": {
         "DeploymentId": {
-          "Ref": "HtmlApiDeploymentbe02cbff83"
+          "Ref": "HtmlApiDeployment5ae7e42cea"
         }, 
         "RestApiId": {
           "Ref": "HtmlApi"
@@ -149,7 +149,7 @@
               }
             }
           }, 
-          "openapi": "3.0.1", 
+          "openapi": "3.0", 
           "components": {
             "securitySchemes": {
               "AWS_IAM": {

tests/translator/output/aws-us-gov/api_request_model_openapi_3.json

@@ -21,15 +21,6 @@
         }
       }
     }, 
-    "HtmlApiDeploymente91bc94e87": {
-      "Type": "AWS::ApiGateway::Deployment", 
-      "Properties": {
-        "RestApiId": {
-          "Ref": "HtmlApi"
-        }, 
-        "Description": "RestApi deployment id: e91bc94e874a30084312552d628dd248890ad7f9"
-      }
-    }, 
     "HtmlFunctionRole": {
       "Type": "AWS::IAM::Role", 
       "Properties": {
@@ -58,7 +49,7 @@
       "Type": "AWS::ApiGateway::Stage", 
       "Properties": {
         "DeploymentId": {
-          "Ref": "HtmlApiDeploymente91bc94e87"
+          "Ref": "HtmlApiDeploymenta488cfa4f9"
         }, 
         "RestApiId": {
           "Ref": "HtmlApi"
@@ -149,7 +140,7 @@
               }
             }
           }, 
-          "openapi": "3.0.1", 
+          "openapi": "3.0", 
           "components": {
             "securitySchemes": {
               "AWS_IAM": {
@@ -181,6 +172,15 @@
         }
       }
     }, 
+    "HtmlApiDeploymenta488cfa4f9": {
+      "Type": "AWS::ApiGateway::Deployment", 
+      "Properties": {
+        "RestApiId": {
+          "Ref": "HtmlApi"
+        }, 
+        "Description": "RestApi deployment id: a488cfa4f9c73604187a3a5dfa5f333ef2c52e1e"
+      }
+    }, 
     "HtmlFunctionGetHtmlPermissionTest": {
       "Type": "AWS::Lambda::Permission", 
       "Properties": {

tests/translator/output/error_api_with_invalid_open_api_version.json

@@ -1,8 +1,8 @@
 {
     "errors": [
       {
-        "errorMessage": "Resource with id [MyApi] is invalid. The OpenApiVersion value must be of the format 3.0.0"
+        "errorMessage": "Resource with id [MyApi] is invalid. The OpenApiVersion value must be of the format \"3.0.0\""
       }
     ], 
-    "errorMessage": "Invalid Serverless Application Specification document. Number of errors found: 1. Resource with id [MyApi] is invalid. The OpenApiVersion value must be of the format 3.0.0"
+    "errorMessage": "Invalid Serverless Application Specification document. Number of errors found: 1. Resource with id [MyApi] is invalid. The OpenApiVersion value must be of the format \"3.0.0\""
   }

tests/translator/output/error_api_with_invalid_open_api_version_type.json

@@ -0,0 +1,8 @@
+{
+    "errors": [
+      {
+        "errorMessage": "Resource with id [MyApi] is invalid. Type of property 'OpenApiVersion' is invalid."
+      }
+    ], 
+    "errorMessage": "Invalid Serverless Application Specification document. Number of errors found: 1. Resource with id [MyApi] is invalid. Type of property 'OpenApiVersion' is invalid."
+  }

tests/translator/test_translator.py

@@ -490,7 +490,8 @@ def _generate_new_deployment_hash(self, logical_id, dict_to_hash, rest_api_to_sw
     'error_function_with_unknown_policy_template',
     'error_function_with_invalid_policy_statement',
     'error_function_with_invalid_condition_name',
-    'error_invalid_document_empty_semantic_version'
+    'error_invalid_document_empty_semantic_version',
+    'error_api_with_invalid_open_api_version_type'
 ])
 @patch('boto3.session.Session.region_name', 'ap-southeast-1')
 @patch('samtranslator.plugins.application.serverless_app_plugin.ServerlessAppPlugin._sar_service_call', mock_sar_service_call)