refactor(sns-validation): merge sns validation schema with main schema

Author: erezrokah

lib/apiGateway/schema.js

@@ -102,6 +102,28 @@ const key = Joi.alternatives().try([
     )
 ])
 
+const stringOrGetAtt = (attributeName) => {
+  return Joi.alternatives().try([
+    Joi.string(),
+    Joi.object({
+      'Fn::GetAtt': Joi.array()
+        .length(2)
+        .ordered(
+          Joi.string().required(),
+          Joi.string()
+            .valid(attributeName)
+            .required()
+        )
+        .required()
+    }).error(
+      customErrorBuilder(
+        'object.child',
+        `"topicName" must be in the format "{ 'Fn::GetAtt': ['<ResourceId>', '${attributeName}'] }"`
+      )
+    )
+  ])
+}
+
 const allowedProxies = ['kinesis', 'sqs', 's3', 'sns']
 
 const proxiesSchemas = {
@@ -117,7 +139,7 @@ const proxiesSchemas = {
       key: key.required()
     })
   }),
-  sns: Joi.object({ sns: proxy }),
+  sns: Joi.object({ sns: proxy.append({ topicName: stringOrGetAtt('TopicName').required() }) }),
   sqs: Joi.object({ sqs: proxy.append({ requestParameters }) })
 }
 

lib/apiGateway/validate.test.js

@@ -412,7 +412,7 @@ describe('#validateServiceProxies()', () => {
       expect(json.events[0].http.cors.methods).to.deep.equal(['POST', 'OPTIONS'])
     })
 
-    it('should throw if "authorizationType" is not a string', async () => {
+    it('should throw if "authorizationType" is not a string', () => {
       serverlessApigatewayServiceProxy.serverless.service.custom = {
         apiGatewayServiceProxies: [
           {
@@ -581,7 +581,7 @@ describe('#validateServiceProxies()', () => {
     const proxiesToTest = [
       { proxy: 'kinesis', props: { streamName: 'streamName' } },
       { proxy: 's3', props: { bucket: 'bucket', action: 'PutObject', key: 'myKey' } },
-      { proxy: 'sns', props: {} }
+      { proxy: 'sns', props: { topicName: 'topicName' } }
     ]
     proxiesToTest.forEach(({ proxy, props }) => {
       it(`should throw if requestParameters is set for ${proxy}`, () => {
@@ -851,6 +851,115 @@ describe('#validateServiceProxies()', () => {
     })
   })
 
+  describe('sns', () => {
+    it('should throw error if the "topicName" property doesn\'t exist', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sns: {
+              path: 'sns',
+              method: 'post'
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.throw(
+        serverless.classes.Error,
+        'child "sns" fails because [child "topicName" fails because ["topicName" is required]]'
+      )
+    })
+
+    it('should throw error if the "topicName" property is not a string or an AWS intrinsic function', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sns: {
+              path: 'sns',
+              method: 'post',
+              topicName: ['xx', 'yy']
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.throw(
+        serverless.classes.Error,
+        'child "sns" fails because [child "topicName" fails because ["topicName" must be a string, "topicName" must be an object]]'
+      )
+    })
+
+    it('should throw error if the "topicName" property is missing the AWS intrinsic function "Fn::GetAtt"', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sns: {
+              path: 'sns',
+              method: 'post',
+              topicName: { xxx: 'SNSResourceId' }
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.throw(
+        serverless.classes.Error,
+        `child "sns" fails because [child "topicName" fails because ["topicName" must be a string, "topicName" must be in the format "{ 'Fn::GetAtt': ['<ResourceId>', 'TopicName'] }"]]`
+      )
+    })
+
+    it('should throw error if the "topicName" property is an intrinsic function "Fn::GetAtt" but specifies a property other than TopicName', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sns: {
+              path: 'sns',
+              method: 'post',
+              topicName: { 'Fn::GetAtt': ['SNSResourceId', 'Arn'] }
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.throw(
+        serverless.classes.Error,
+        `child "sns" fails because [child "topicName" fails because ["topicName" must be a string, "topicName" must be in the format "{ 'Fn::GetAtt': ['<ResourceId>', 'TopicName'] }"]]`
+      )
+    })
+
+    it('should not show error if topicName is valid string', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sns: {
+              path: 'sns',
+              method: 'post',
+              topicName: 'someTopicName'
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.not.throw()
+    })
+
+    it('should not show error if topicName is valid intrinsic function', () => {
+      serverlessApigatewayServiceProxy.serverless.service.custom = {
+        apiGatewayServiceProxies: [
+          {
+            sns: {
+              path: 'sns',
+              method: 'post',
+              topicName: { 'Fn::GetAtt': ['SNSResourceId', 'TopicName'] }
+            }
+          }
+        ]
+      }
+
+      expect(() => serverlessApigatewayServiceProxy.validateServiceProxies()).to.not.throw()
+    })
+  })
+
   describe('sqs', () => {
     it('should throw if requestParameters is not a string to string', () => {
       serverlessApigatewayServiceProxy.serverless.service.custom = {

lib/index.js

@@ -27,7 +27,6 @@ const compileS3ServiceProxy = require('./package/s3/compileS3ServiceProxy')
 // SNS
 const compileMethodsToSns = require('./package/sns/compileMethodsToSns')
 const compileIamRoleToSns = require('./package/sns/compileIamRoleToSns')
-const validateSnsServiceProxy = require('./package/sns/validateSnsServiceProxy')
 const compileSnsServiceProxy = require('./package/sns/compileSnsServiceProxy')
 
 class ServerlessApigatewayServiceProxy {
@@ -57,7 +56,6 @@ class ServerlessApigatewayServiceProxy {
       compileS3ServiceProxy,
       compileMethodsToSns,
       compileIamRoleToSns,
-      validateSnsServiceProxy,
       compileSnsServiceProxy,
       getStackInfo,
       validate,

lib/package/sns/compileSnsServiceProxy.js

@@ -1,7 +1,6 @@
 'use strict'
 module.exports = {
   async compileSnsServiceProxy() {
-    this.validateSnsServiceProxy()
     this.compileIamRoleToSns()
     this.compileMethodsToSns()
   }