- make tags an object instead of Array and provide better syntax for the plugin

Author: theburningmonk

README.md

@@ -49,8 +49,7 @@ stepFunctions:
             End: true
       dependsOn: CustomIamRole
       tags:
-        - Key: Team
-          Value: Atlantis
+        Team: Atlantis
       alarms:
         topics:
           ok: arn:aws:sns:us-east-1:1234567890:NotifyMe
@@ -76,8 +75,7 @@ stepFunctions:
         - KinesisStream
         - CUstomIamRole
       tags:
-        - Key: Team
-          Value: Atlantis
+        Team: Atlantis
   activities:
     - myTask
     - yourTask

lib/deploy/stepFunctions/compileStateMachines.js

@@ -16,7 +16,7 @@ module.exports = {
         let DefinitionString;
         let RoleArn;
         let DependsOn = [];
-        let Tags = [];
+        const Tags = [];
 
         if (stateMachineObj.definition) {
           if (typeof stateMachineObj.definition === 'string') {
@@ -84,17 +84,15 @@ 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}';
+        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(errorMsg);
+              .Error('Unable to parse tags, it should be an object.');
           }
-
-          Tags = stateMachineObj.tags;
         }
 
         const stateMachineLogicalId = this.getStateMachineLogicalId(stateMachineName,

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -490,24 +490,18 @@ describe('#compileStateMachines', () => {
         myStateMachine1: {
           definition: 'definition1',
           name: 'stateMachineBeta1',
-          tags: [{
-            Key: 'team',
-            Value: 'core',
-          }, {
-            Key: 'feature',
-            Value: 'tags',
-          }],
+          tags: {
+            team: 'core',
+            score: 42,
+          },
         },
         myStateMachine2: {
           definition: 'definition2',
           name: 'stateMachineBeta2',
-          tags: [{
-            Key: 'team',
-            Value: 'core',
-          }, {
-            Key: 'feature',
-            Value: 'tags',
-          }],
+          tags: {
+            team: 'core',
+            score: 42,
+          },
         },
       },
     };
@@ -522,9 +516,9 @@ describe('#compileStateMachines', () => {
     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' }]);
+      .to.deep.eq([{ Key: 'team', Value: 'core' }, { Key: 'score', Value: '42' }]);
     expect(stateMachineBeta2.Properties.Tags)
-      .to.deep.eq([{ Key: 'team', Value: 'core' }, { Key: 'feature', Value: 'tags' }]);
+      .to.deep.eq([{ Key: 'team', Value: 'core' }, { Key: 'score', Value: '42' }]);
   });
 
   it('should throw error when tags property contains malformed tags', () => {