feat: add support for tags

Author: theburningmonk

README.md

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

lib/deploy/stepFunctions/compileStateMachines.js

@@ -16,6 +16,7 @@ module.exports = {
         let DefinitionString;
         let RoleArn;
         let DependsOn = [];
+        let Tags = [];
 
         if (stateMachineObj.definition) {
           if (typeof stateMachineObj.definition === 'string') {
@@ -83,6 +84,19 @@ module.exports = {
           }
         }
 
+        if (_.isArray(stateMachineObj.tags)) {
+          const malformedTags =
+            stateMachineObj.tags.filter(x => !_.isString(x.Key) || !_.isString(x.Value));
+          if (!_.isEmpty(malformedTags)) {
+            const errorMsg = `${malformedTags.length} tags are malformed. ` +
+              'Expect tags to have shape {Key:string, Value: String}';
+            throw new this.serverless.classes
+              .Error(errorMsg);
+          }
+
+          Tags = stateMachineObj.tags;
+        }
+
         const stateMachineLogicalId = this.getStateMachineLogicalId(stateMachineName,
           stateMachineObj);
         const stateMachineOutputLogicalId = this
@@ -92,6 +106,7 @@ module.exports = {
           Properties: {
             DefinitionString,
             RoleArn,
+            Tags,
           },
           DependsOn,
         };

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -483,4 +483,61 @@ describe('#compileStateMachines', () => {
     };
     expect(() => serverlessStepFunctions.compileStateMachines()).to.throw(Error);
   });
+
+  it('should add tags', () => {
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          definition: 'definition1',
+          name: 'stateMachineBeta1',
+          tags: [{
+            Key: 'team',
+            Value: 'core',
+          }, {
+            Key: 'feature',
+            Value: 'tags',
+          }],
+        },
+        myStateMachine2: {
+          definition: 'definition2',
+          name: 'stateMachineBeta2',
+          tags: [{
+            Key: 'team',
+            Value: 'core',
+          }, {
+            Key: 'feature',
+            Value: 'tags',
+          }],
+        },
+      },
+    };
+
+    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: 'feature', Value: 'tags' }]);
+    expect(stateMachineBeta2.Properties.Tags)
+      .to.deep.eq([{ Key: 'team', Value: 'core' }, { Key: 'feature', Value: 'tags' }]);
+  });
+
+  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);
+  });
 });