feat(schema): serverless http api cors configuration

neoandroid · Sep 2, 2022 · a90bb03 · a90bb03
1 parent 81b9d25
commit a90bb03
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 20 deletions.
diff --git a/cloudformation/serverless/aws-serverless-httpapi_corsconfigurationobject.go b/cloudformation/serverless/aws-serverless-httpapi_corsconfigurationobject.go
diff --git a/generate/sam-2016-10-31.json b/generate/sam-2016-10-31.json
@@ -2291,25 +2291,28 @@
                 "AllowMethods": {
                     "Documentation": "https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration-object",
                     "Required": false,
-                    "PrimitiveType": "String",
+                    "Type": "List",
+                    "PrimitiveItemType": "String",
                     "UpdateType": "Immutable"
                 },
                 "AllowHeaders": {
                     "Documentation": "https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration-object",
                     "Required": false,
-                    "PrimitiveType": "String",
+                    "Type": "List",
+                    "PrimitiveItemType": "String",
                     "UpdateType": "Immutable"
                 },
-                "AllowOrigin": {
+                "AllowOrigins": {
                     "Documentation": "https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration-object",
                     "Required": false,
-                    "PrimitiveType": "String",
+                    "Type": "List",
+                    "PrimitiveItemType": "String",
                     "UpdateType": "Immutable"
                 },
                 "MaxAge": {
                     "Documentation": "https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#cors-configuration-object",
                     "Required": false,
-                    "PrimitiveType": "String",
+                    "PrimitiveType": "Integer",
                     "UpdateType": "Immutable"
                 },
                 "AllowCredentials": {

diff --git a/goformation_test.go b/goformation_test.go
@@ -491,6 +491,39 @@ var _ = Describe("Goformation", func() {
 
 	})
 
+	Context("with a template that defines an AWS::Serverless::HttpApi with a CorsConfiguration", func() {
+
+		template, err := goformation.Open("test/yaml/aws-serverless-http-api-cors-configuration.yaml")
+		It("should successfully parse the template", func() {
+			Expect(err).To(BeNil())
+			Expect(template).ShouldNot(BeNil())
+		})
+
+		apis := template.GetAllServerlessHttpApiResources()
+
+		It("should have exactly an API", func() {
+			Expect(apis).To(HaveLen(1))
+			Expect(apis).To(HaveKey("HttpApiWithCorsConfiguration"))
+		})
+
+		api1 := apis["HttpApiWithCorsConfiguration"]
+		It("should parse a CorsConfiguration object", func() {
+			Expect(api1.CorsConfiguration.CorsConfigurationObject.AllowOrigins).
+				To(Equal(cloudformation.Strings("https://www.example.com")))
+			Expect(api1.CorsConfiguration.CorsConfigurationObject.AllowMethods).
+				To(Equal(cloudformation.Strings("GET", "OPTIONS")))
+			Expect(api1.CorsConfiguration.CorsConfigurationObject.AllowHeaders).
+				To(Equal(cloudformation.Strings("x-apigateway-header")))
+			Expect(api1.CorsConfiguration.CorsConfigurationObject.ExposeHeaders).
+				To(Equal(cloudformation.Strings("*")))
+			Expect(api1.CorsConfiguration.CorsConfigurationObject.AllowCredentials).
+				To(Equal(cloudformation.Bool(true)))
+			Expect(api1.CorsConfiguration.CorsConfigurationObject.MaxAge).
+				To(Equal(cloudformation.Int(300)))
+		})
+
+	})
+
 	Context("with a Serverless template containing different CodeUri formats", func() {
 
 		template, err := goformation.Open("test/yaml/aws-serverless-function-string-or-s3-location.yaml")

diff --git a/schema/sam.go b/schema/sam.go
@@ -134112,13 +134112,22 @@ var SamSchema = `{
                     "type": "boolean"
                 },
                 "AllowHeaders": {
-                    "type": "string"
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
                 },
                 "AllowMethods": {
-                    "type": "string"
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
                 },
-                "AllowOrigin": {
-                    "type": "string"
+                "AllowOrigins": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
                 },
                 "ExposeHeaders": {
                     "items": {
@@ -134127,7 +134136,7 @@ var SamSchema = `{
                     "type": "array"
                 },
                 "MaxAge": {
-                    "type": "string"
+                    "type": "number"
                 }
             },
             "type": "object"

diff --git a/schema/sam.schema.json b/schema/sam.schema.json
@@ -134107,13 +134107,22 @@
                     "type": "boolean"
                 },
                 "AllowHeaders": {
-                    "type": "string"
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
                 },
                 "AllowMethods": {
-                    "type": "string"
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
                 },
-                "AllowOrigin": {
-                    "type": "string"
+                "AllowOrigins": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
                 },
                 "ExposeHeaders": {
                     "items": {
@@ -134122,7 +134131,7 @@
                     "type": "array"
                 },
                 "MaxAge": {
-                    "type": "string"
+                    "type": "number"
                 }
             },
             "type": "object"

diff --git a/test/yaml/aws-serverless-http-api-cors-configuration.yaml b/test/yaml/aws-serverless-http-api-cors-configuration.yaml
@@ -0,0 +1,20 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+Description: SAM template for testing AWS::Serverless::HttpApi.CorsConfigurationObject
+Resources:
+
+  HttpApiWithCorsConfiguration:
+    Type: AWS::Serverless::HttpApi
+    Properties:
+      CorsConfiguration:
+        AllowOrigins:
+          - "https://www.example.com"
+        AllowMethods: 
+          - GET
+          - OPTIONS
+        AllowHeaders:
+          - x-apigateway-header
+        ExposeHeaders:
+           - "*"
+        AllowCredentials: true
+        MaxAge: 300