Merge pull request #181 from theburningmonk/feature/support_tagging

Feature/support tagging

Author: horike37

README.md

@@ -48,6 +48,8 @@ stepFunctions:
             Resource: arn:aws:lambda:#{AWS::Region}:#{AWS::AccountId}:function:${self:service}-${opt:stage}-hello
             End: true
       dependsOn: CustomIamRole
+      tags:
+        Team: Atlantis
       alarms:
         topics:
           ok: arn:aws:sns:us-east-1:1234567890:NotifyMe
@@ -72,6 +74,8 @@ stepFunctions:
         - DynamoDBTable
         - KinesisStream
         - CUstomIamRole
+      tags:
+        Team: Atlantis
   activities:
     - myTask
     - yourTask

lib/deploy/stepFunctions/compileStateMachines.js

@@ -16,6 +16,7 @@ module.exports = {
         let DefinitionString;
         let RoleArn;
         let DependsOn = [];
+        const Tags = [];
 
         if (stateMachineObj.definition) {
           if (typeof stateMachineObj.definition === 'string') {
@@ -83,6 +84,17 @@ module.exports = {
           }
         }
 
+        if (stateMachineObj.tags) {
+          if (_.isPlainObject(stateMachineObj.tags)) {
+            _.forEach(
+              stateMachineObj.tags,
+              (Value, Key) => Tags.push({ Key, Value: Value.toString() }));
+          } else {
+            throw new this.serverless.classes
+              .Error('Unable to parse tags, it should be an object.');
+          }
+        }
+
         const stateMachineLogicalId = this.getStateMachineLogicalId(stateMachineName,
           stateMachineObj);
         const stateMachineOutputLogicalId = this
@@ -92,6 +104,7 @@ module.exports = {
           Properties: {
             DefinitionString,
             RoleArn,
+            Tags,
           },
           DependsOn,
         };

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -483,4 +483,55 @@ describe('#compileStateMachines', () => {
     };
     expect(() => serverlessStepFunctions.compileStateMachines()).to.throw(Error);
   });
+
+  it('should add tags', () => {
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          definition: 'definition1',
+          name: 'stateMachineBeta1',
+          tags: {
+            team: 'core',
+            score: 42,
+          },
+        },
+        myStateMachine2: {
+          definition: 'definition2',
+          name: 'stateMachineBeta2',
+          tags: {
+            team: 'core',
+            score: 42,
+          },
+        },
+      },
+    };
+
+    serverlessStepFunctions.compileStateMachines();
+    const stateMachineBeta1 = serverlessStepFunctions.serverless.service
+      .provider.compiledCloudFormationTemplate.Resources
+      .StateMachineBeta1;
+    const stateMachineBeta2 = serverlessStepFunctions.serverless.service
+      .provider.compiledCloudFormationTemplate.Resources
+      .StateMachineBeta2;
+    expect(stateMachineBeta1.Properties.Tags).to.have.lengthOf(2);
+    expect(stateMachineBeta2.Properties.Tags).to.have.lengthOf(2);
+    expect(stateMachineBeta1.Properties.Tags)
+      .to.deep.eq([{ Key: 'team', Value: 'core' }, { Key: 'score', Value: '42' }]);
+    expect(stateMachineBeta2.Properties.Tags)
+      .to.deep.eq([{ Key: 'team', Value: 'core' }, { Key: 'score', Value: '42' }]);
+  });
+
+  it('should throw error when tags property contains malformed tags', () => {
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          definition: 'definition1',
+          name: 'stateMachineBeta1',
+          tags: ['team:core'],
+        },
+      },
+    };
+
+    expect(() => serverlessStepFunctions.compileStateMachines()).to.throw(Error);
+  });
 });