Fixing AWS::Serverless::Api.MethodSettings (#222)

* - Fixing wrong type in the specification file - Updating `js-yaml` Typescript module - Removing the definition overloading now patched fixed thanks to the previous update * - Adding test cases and fixing previous according to the standard - Fixing missing `ItemType` in the new schema - Adding required properties in `MethodSetting` * - Adding test templates in the test case - Moving typing module in the devDep - Generating `sam_20161031_cfn.json` * Fix whitespace and IDE changes * Add to changelog
martysweet · Feb 5, 2019 · 9f08c3f · 9f08c3f
1 parent c2690b1
commit 9f08c3f
Show file tree

Hide file tree

Showing 9 changed files with 190 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@ and this project adheres to [Semantic
 Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- Merge PR #222, fixing AWS::Serverless::Api.MethodSettings
 
 ## [1.9.4] - 2018-12-09
 ### Changed

diff --git a/data/sam_20161031_cfn.json b/data/sam_20161031_cfn.json
diff --git a/data/sam_20161031_custom_specification.json b/data/sam_20161031_custom_specification.json
@@ -113,7 +113,7 @@
         "HttpMethod": {
           "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod",
           "PrimitiveType": "String",
-          "Required": false,
+          "Required": true,
           "UpdateType": "Mutable"
         },
         "LoggingLevel": {
@@ -131,7 +131,7 @@
         "ResourcePath": {
           "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath",
           "PrimitiveType": "String",
-          "Required": false,
+          "Required": true,
           "UpdateType": "Mutable"
         },
         "ThrottlingBurstLimit": {
@@ -220,7 +220,8 @@
           "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings",
           "DuplicatesAllowed": false,
           "Required": false,
-          "Type": "MethodSetting",
+          "Type": "List",
+          "ItemType": "MethodSetting",
           "UpdateType": "Mutable"
         }
       }

diff --git a/package.json b/package.json
@@ -32,7 +32,7 @@
     "@types/clone": "^0.1.30",
     "@types/colors": "~1.1.3",
     "@types/commander": "^2.11.0",
-    "@types/js-yaml": "^3.9.1",
+    "@types/js-yaml": "^3.12.0",
     "@types/mocha": "^2.2.44",
     "@types/node": "^8.0.50",
     "@types/opn": "^3.0.28",

diff --git a/src/fixes.d.ts b/src/fixes.d.ts
diff --git a/src/test/validatorTest.ts b/src/test/validatorTest.ts
@@ -1910,5 +1910,19 @@ describe('validator', () => {
             expect(result).to.have.deep.property('templateValid', true);
             expect(result['errors']['crit']).to.have.lengthOf(0);
         });
+
+        it('a invalid APIGateway::Stage.MethodSettings type (sam_20161031_api_methodsettings_not_a_list.yaml) should invalidate successfully', () => {
+            const input = 'testData/invalid/yaml/sam_20161031_api_methodsettings_not_a_list.yaml';
+            let result = validator.validateFile(input);
+            expect(result).to.have.deep.property('templateValid', false);
+            expect(result['errors']['crit']).to.have.lengthOf(1);
+        });
+
+        it('a valid APIGateway::Stage.MethodSettings containing incomplete APIGateway::Stage.MethodSetting (sam_20161031_api_methodsettings_missing_required.yaml) should invalidate successfully', () => {
+            const input = 'testData/invalid/yaml/sam_20161031_api_methodsettings_missing_required.yaml';
+            let result = validator.validateFile(input);
+            expect(result).to.have.deep.property('templateValid', false);
+            expect(result['errors']['crit']).to.have.lengthOf(2);
+        });
     });
 });
diff --git a/testData/invalid/yaml/sam_20161031_api_methodsettings_missing_required.yaml b/testData/invalid/yaml/sam_20161031_api_methodsettings_missing_required.yaml
@@ -0,0 +1,81 @@
+AWSTemplateFormatVersion : '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+Description: A hello world application.
+
+Globals:
+  Function:
+    Handler: index.handler
+    Runtime: nodejs6.10
+    CodeUri: src/
+    DeadLetterQueue:
+      Type: SNS
+      TargetArn: arn:aws:sns:us-east-1:84969EXAMPLE:DeadLetterQueue
+    Description: somethingCool
+    MemorySize: 512
+    Timeout: 10
+    VpcConfig:
+      SecurityGroupIds:
+        - SGID0
+      SubnetIds:
+        - SID0
+    Environment:
+      Variables:
+        VAR0: 0
+    Tags:
+      TAG0: tag0
+    Tracing: PassThrough
+    KmsKeyArn: arn:aws:sns:us-east-1:84969EXAMPLE:KmsKeyArn
+    AutoPublishAlias: live
+    DeploymentPreference:
+      Type: Linear10PercentEvery10Minutes
+
+  Api:
+    Name: ServerlessRestApi
+    DefinitionUri: s3://s3-eu-west-1.amazonaws.com/s3test.example.com
+    CacheClusterEnabled: True
+    CacheClusterSize: 1024M
+    Variables:
+      VAR1: 1
+    EndpointConfiguration: EDGE
+    MethodSettings:
+      - CacheDataEncrypted: True
+    BinaryMediaTypes:
+      - image~1gif
+      - image~1png
+    Cors: example.com
+
+  SimpleTable:
+    SSESpecification:
+      SSEEnabled: True
+
+
+Resources:
+  HelloWorldFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      VpcConfig:
+        SecurityGroupIds:
+          - SGID1
+        SubnetIds:
+          - SID1
+      Tags:
+        TAG1: tag1
+      Environment:
+        Variables:
+          VAR2: shouldBe2
+
+  HelloWorldAPI:
+    Type: AWS::Serverless::Api
+    Properties:
+      StageName: Prod
+      EndpointConfiguration: REGIONAL
+      BinaryMediaTypes:
+        - image~1exe
+      Variables:
+        VAR2: 2
+        VAR3: 3
+
+  HelloWorldTable:
+    Type: AWS::Serverless::SimpleTable
+    Properties:
+      TableName: example-table
diff --git a/testData/invalid/yaml/sam_20161031_api_methodsettings_not_a_list.yaml b/testData/invalid/yaml/sam_20161031_api_methodsettings_not_a_list.yaml
@@ -0,0 +1,83 @@
+AWSTemplateFormatVersion : '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+Description: A hello world application.
+
+Globals:
+  Function:
+    Handler: index.handler
+    Runtime: nodejs6.10
+    CodeUri: src/
+    DeadLetterQueue:
+      Type: SNS
+      TargetArn: arn:aws:sns:us-east-1:84969EXAMPLE:DeadLetterQueue
+    Description: somethingCool
+    MemorySize: 512
+    Timeout: 10
+    VpcConfig:
+      SecurityGroupIds:
+        - SGID0
+      SubnetIds:
+        - SID0
+    Environment:
+      Variables:
+        VAR0: 0
+    Tags:
+      TAG0: tag0
+    Tracing: PassThrough
+    KmsKeyArn: arn:aws:sns:us-east-1:84969EXAMPLE:KmsKeyArn
+    AutoPublishAlias: live
+    DeploymentPreference:
+      Type: Linear10PercentEvery10Minutes
+
+  Api:
+    Name: ServerlessRestApi
+    DefinitionUri: s3://s3-eu-west-1.amazonaws.com/s3test.example.com
+    CacheClusterEnabled: True
+    CacheClusterSize: 1024M
+    Variables:
+      VAR1: 1
+    EndpointConfiguration: EDGE
+    MethodSettings:
+      HttpMethod: GET
+      ResourcePath: /*
+      CacheDataEncrypted: True
+    BinaryMediaTypes:
+      - image~1gif
+      - image~1png
+    Cors: example.com
+
+  SimpleTable:
+    SSESpecification:
+      SSEEnabled: True
+
+
+Resources:
+  HelloWorldFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      VpcConfig:
+        SecurityGroupIds:
+          - SGID1
+        SubnetIds:
+          - SID1
+      Tags:
+        TAG1: tag1
+      Environment:
+        Variables:
+          VAR2: shouldBe2
+
+  HelloWorldAPI:
+    Type: AWS::Serverless::Api
+    Properties:
+      StageName: Prod
+      EndpointConfiguration: REGIONAL
+      BinaryMediaTypes:
+        - image~1exe
+      Variables:
+        VAR2: 2
+        VAR3: 3
+
+  HelloWorldTable:
+    Type: AWS::Serverless::SimpleTable
+    Properties:
+      TableName: example-table
diff --git a/testData/valid/yaml/sam_20161031_globals.yaml b/testData/valid/yaml/sam_20161031_globals.yaml
@@ -39,7 +39,10 @@ Globals:
       VAR1: 1
     EndpointConfiguration: EDGE
     MethodSettings:
-      CacheDataEncrypted: True
+      - HttpMethod: GET
+        ResourcePath: /*
+        MetricsEnabled: 'true'
+        DataTraceEnabled: 'true'
     BinaryMediaTypes:
       - image~1gif
       - image~1png