Merge pull request #32 from alexdrans/master

adding support for existing validator id

Author: RafPe

README.md

@@ -103,6 +103,23 @@ functions:
             Fn::ImportValue: 'myReqValidator'
 ```
 
+### Use an external validator by ID
+If you have an existing request validator defined outside of CloudFormation e.g. Terraform, you can reference it by id.
+
+```
+plugins:
+  - serverless-reqvalidator-plugin
+service: my-service-a
+functions:
+  hello:
+    handler: handler.myHandler
+    events:
+      - http:
+          path: hello
+          reqValidatorName:
+            id: 'g5ch0h'
+```
+
 ### Full example 
 ```
 service:

src/index.js

@@ -29,6 +29,21 @@
  *           reqValidatorName: 
  *            Fn::ImportValue: 'my-import-value'
  * 
+ * Use request validator by Id:
+ * 
+ *   myFuncGetItem:
+ *     handler: myFunc.get
+ *     name: ${self:provider.stage}-myFunc-get-item
+ *     events:
+ *       - http:
+ *           method: GET
+ *           path: mypath
+ *           cors: true
+ *           reqValidatorName: 
+ *             id: 'g5ch0h'
+ * 
+ * 
+ * 
  *  Resources used:
  *  - https://www.snip2code.com/Snippet/1467589/adds-the-posibility-to-configure-AWS_IAM/
  */
@@ -44,6 +59,12 @@ const ServerlessReqValidatorPluginConfigSchema = {
           },
           required: ['Fn::ImportValue'],
         },
+        { type: 'object',
+          properties: {
+            id: { type: 'string' },
+          },
+          required: ['id'],
+        },
       ]
     },
   },
@@ -106,6 +127,8 @@ class ServerlessReqValidatorPlugin {
             case 'object':
               if (reqValidatorName['Fn::ImportValue']) {
                 resources[methodName].Properties.RequestValidatorId = reqValidatorName;
+              } else if (reqValidatorName['id']) {
+                resources[methodName].Properties.RequestValidatorId = reqValidatorName['id']
               } else { // other use cases should be added here
                 resources[methodName].Properties.RequestValidatorId = reqValidatorName;
               }

test/fixtures/externalValidatorId.yaml

@@ -0,0 +1,11 @@
+plugins:
+  - serverless-reqvalidator-plugin
+service: my-service-b
+functions:
+  hello:
+    handler: handler.myHandler
+    events:
+      - http:
+          path: hello
+          reqValidatorName:
+            id: 'abc123'

test/schema.test.js

@@ -38,4 +38,11 @@ describe('serverless-reqvalidator-plugin schema', () => {
     const valid = validateConfig(config.functions.hello.events[0].http);
     expect(valid).toBeFalsy();
   });
+
+  it('should validate a configuration with an external reqValidatorName.id property', () => {
+    const config = yaml.load(fs.readFileSync('./test/fixtures/externalValidatorId.yaml', 'utf8'));
+
+    const valid = validateConfig(config.functions.hello.events[0].http);
+    expect(valid).toBeTruthy();
+  })
 });