Merge pull request #171 from j0k3r/fix/avoid-log-no-alarms

Avoid alarms logs when no alarms are defined

Author: theburningmonk

lib/deploy/stepFunctions/compileAlarms.js

@@ -74,8 +74,12 @@ function getCloudWatchAlarms(
 }
 
 function validateConfig(serverless, stateMachineName, alarmsObj) {
-  if (!_.isObject(alarmsObj) ||
-      !_.isObject(alarmsObj.topics) ||
+  // no alarms defined at all
+  if (!_.isObject(alarmsObj)) {
+    return false;
+  }
+
+  if (!_.isObject(alarmsObj.topics) ||
       !_.isArray(alarmsObj.metrics) ||
       !_.every(alarmsObj.metrics, _.isString)) {
     serverless.cli.consoleLog(

lib/deploy/stepFunctions/compileAlarms.test.js

@@ -2,21 +2,24 @@
 
 const _ = require('lodash');
 const expect = require('chai').expect;
+const sinon = require('sinon');
 const Serverless = require('serverless/lib/Serverless');
 const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
 const ServerlessStepFunctions = require('./../../index');
 
 describe('#compileAlarms', () => {
+  let consoleLogSpy;
   let serverless;
   let serverlessStepFunctions;
 
   beforeEach(() => {
+    consoleLogSpy = sinon.spy();
     serverless = new Serverless();
     serverless.servicePath = true;
     serverless.service.service = 'step-functions';
     serverless.service.provider.compiledCloudFormationTemplate = { Resources: {} };
     serverless.setProvider('aws', new AwsProvider(serverless));
-    serverless.cli = { consoleLog: console.log };
+    serverless.cli = { consoleLog: consoleLogSpy };
     const options = {
       stage: 'dev',
       region: 'ap-northeast-1',
@@ -87,6 +90,37 @@ describe('#compileAlarms', () => {
     validateCloudWatchAlarm(resources.StateMachineBeta2ExecutionsAbortedAlarm);
     expect(resources).to.have.property('StateMachineBeta2ExecutionThrottledAlarm');
     validateCloudWatchAlarm(resources.StateMachineBeta2ExecutionThrottledAlarm);
+
+    expect(consoleLogSpy.callCount).equal(0);
+  });
+
+  it('should not generate logs when no CloudWatch Alarms are defiened', () => {
+    const genStateMachine = (name) => ({
+      name,
+      definition: {
+        StartAt: 'A',
+        States: {
+          A: {
+            Type: 'Pass',
+            End: true,
+          },
+        },
+      },
+    });
+
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: genStateMachine('stateMachineBeta1'),
+        myStateMachine2: genStateMachine('stateMachineBeta2'),
+      },
+    };
+
+    serverlessStepFunctions.compileAlarms();
+    const resources = serverlessStepFunctions.serverless.service
+      .provider.compiledCloudFormationTemplate.Resources;
+    expect(_.keys(resources)).to.have.lengthOf(0);
+
+    expect(consoleLogSpy.callCount).equal(0);
   });
 
   it('should not generate CloudWatch Alarms when alarms.topics is missing', () => {
@@ -119,6 +153,8 @@ describe('#compileAlarms', () => {
     const resources = serverlessStepFunctions.serverless.service
       .provider.compiledCloudFormationTemplate.Resources;
     expect(_.keys(resources)).to.have.lengthOf(0);
+
+    expect(consoleLogSpy.callCount).equal(2);
   });
 
   it('should not generate CloudWatch Alarms when alarms.topics is empty', () => {
@@ -152,6 +188,8 @@ describe('#compileAlarms', () => {
     const resources = serverlessStepFunctions.serverless.service
       .provider.compiledCloudFormationTemplate.Resources;
     expect(_.keys(resources)).to.have.lengthOf(0);
+
+    expect(consoleLogSpy.callCount).equal(2);
   });
 
   it('should not generate CloudWatch Alarms when alarms.metrics is missing', () => {
@@ -184,6 +222,8 @@ describe('#compileAlarms', () => {
     const resources = serverlessStepFunctions.serverless.service
       .provider.compiledCloudFormationTemplate.Resources;
     expect(_.keys(resources)).to.have.lengthOf(0);
+
+    expect(consoleLogSpy.callCount).equal(2);
   });
 
   it('should not generate CloudWatch Alarms for unsupported metrics', () => {
@@ -225,5 +265,7 @@ describe('#compileAlarms', () => {
 
     // but invalid metric names are skipped
     expect(_.keys(resources)).to.have.lengthOf(2);
+
+    expect(consoleLogSpy.callCount).equal(2);
   });
 });

lib/deploy/stepFunctions/compileIamRole.test.js

@@ -2,6 +2,7 @@
 
 const _ = require('lodash');
 const expect = require('chai').expect;
+const sinon = require('sinon');
 const Serverless = require('serverless/lib/Serverless');
 const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider');
 const ServerlessStepFunctions = require('./../../index');
@@ -16,7 +17,7 @@ describe('#compileIamRole', () => {
     serverless.service.service = 'step-functions';
     serverless.service.provider.compiledCloudFormationTemplate = { Resources: {} };
     serverless.setProvider('aws', new AwsProvider(serverless));
-    serverless.cli = { consoleLog: console.log };
+    serverless.cli = { consoleLog: sinon.spy() };
     const options = {
       stage: 'dev',
       region: 'ap-northeast-1',