Merge pull request #4 from horike37/master

synch

Author: theburningmonk

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
@@ -707,8 +711,12 @@ stepFunctions:
         ...
 ```
 
+## Tags
+
+You can specify tags on each state machine. Additionally any global tags (specified under `provider` section in your `serverless.yml`) would be merged in as well.
 
 ## Command
+
 ### deploy
 Run `sls deploy`, the defined Stepfunctions are deployed.
 

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

lib/deploy/stepFunctions/compileStateMachines.js

@@ -7,6 +7,25 @@ function isIntrinsic(obj) {
   return isObject && Object.keys(obj).some((k) => k.startsWith('Fn::') || k.startsWith('Ref'));
 }
 
+function toTags(obj, serverless) {
+  const tags = [];
+
+  if (!obj) {
+    return tags;
+  }
+
+  if (_.isPlainObject(obj)) {
+    _.forEach(
+      obj,
+      (Value, Key) => tags.push({ Key, Value: Value.toString() }));
+  } else {
+    throw new serverless.classes
+      .Error('Unable to parse tags, it should be an object.');
+  }
+
+  return tags;
+}
+
 module.exports = {
   isIntrinsic,
   compileStateMachines() {
@@ -16,6 +35,7 @@ module.exports = {
         let DefinitionString;
         let RoleArn;
         let DependsOn = [];
+        const Tags = toTags(this.serverless.service.provider.tags, this.serverless);
 
         if (stateMachineObj.definition) {
           if (typeof stateMachineObj.definition === 'string') {
@@ -83,6 +103,11 @@ module.exports = {
           }
         }
 
+        if (stateMachineObj.tags) {
+          const stateMachineTags = toTags(stateMachineObj.tags, this.serverless);
+          _.forEach(stateMachineTags, tag => Tags.push(tag));
+        }
+
         const stateMachineLogicalId = this.getStateMachineLogicalId(stateMachineName,
           stateMachineObj);
         const stateMachineOutputLogicalId = this
@@ -92,6 +117,7 @@ module.exports = {
           Properties: {
             DefinitionString,
             RoleArn,
+            Tags,
           },
           DependsOn,
         };

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -483,4 +483,128 @@ 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 add global tags', () => {
+    serverless.service.provider.tags = {
+      team: 'core',
+      score: 42,
+    };
+
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          definition: 'definition1',
+          name: 'stateMachineBeta1',
+        },
+        myStateMachine2: {
+          definition: 'definition2',
+          name: 'stateMachineBeta2',
+        },
+      },
+    };
+
+    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 merge global and state machine tags', () => {
+    serverless.service.provider.tags = {
+      team: 'core',
+    };
+
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          definition: 'definition1',
+          name: 'stateMachineBeta1',
+          tags: {
+            score: 42,
+          },
+        },
+        myStateMachine2: {
+          definition: 'definition2',
+          name: 'stateMachineBeta2',
+          tags: {
+            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);
+  });
 });