Implemented basic CloudFormation create/update

Author: kennu

LICENSE

@@ -0,0 +1,33 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 SC5 Online. https://sc5.io
+
+The following license applies to all parts of this software except as
+documented below:
+
+====
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+====
+
+All files located in the node_modules and external directories are
+externally maintained libraries used by this software which have their
+own licenses; we recommend you read them, as their terms may differ from
+the terms above.

README.md

@@ -78,13 +78,12 @@ permanentResources:
         Name: ${self:service}-data
 ```
 
+The syntax of the Resources section is identical to the normal resources
+in `serverless.yml`, so you can just cut-paste resource definitions around.
 
 The full name of the deployed CloudFormation stack will include the service
 name. If your service is called `my-service` and you deploy it to the `dev`
-stage, the additional stack would be called `my-service-permanent-dev`.
-
-The syntax of the Resources section is identical to the normal resources
-in `serverless.yml`, so you can just cut-paste resource definitions around.
+stage, the additional stack would be called `my-service-dev-permanent`.
 
 ### Using Deploy: After stacks
 
@@ -114,16 +113,20 @@ Your additional stacks will be deployed automatically when you run:
 
     sls deploy
 
+To deploy all additional stacks without deploying tje Serverless service, you can use:
+
+    sls deploy additionalstacks
+
 To deploy an additional stack individually, you can use:
 
-    sls deploy additionalstack [stackname]
+    sls deploy additionalstacks --stack [stackname]
 
 If you want to remove an additional stack, you need to run:
 
-    sls remove additionalstack [stackname]
+    sls remove additionalstacks --stack [stackname]
 
 Or you can remove all additional stacks in the service with:
 
-    sls remove additionalstack -a
+    sls remove additionalstacks
 
 Alternatively, you can remove stacks manually in AWS CloudFormation Console.

index.js

@@ -11,17 +11,12 @@ class ServerlessPlugin {
     this.commands = {
       deploy: {
         commands: {
-          additionalstack: {
+          additionalstacks: {
             usage: 'Deploy additional stacks',
             lifecycleEvents: [
               'deploy',
             ],
             options: {
-              all: {
-                usage: 'Deploy all additional stacks',
-                shortcut: 'a',
-                required: false,
-              },
               stack: {
                 usage: 'Additional stack name to deploy',
                 shortcut: 'k',
@@ -36,7 +31,7 @@ class ServerlessPlugin {
     this.hooks = {
       'before:deploy:deploy': this.beforeDeployGlobal.bind(this),
       'after:deploy:deploy': this.afterDeployGlobal.bind(this),
-      'deploy:additionalstack:deploy': this.deployAdditionalStackDeploy.bind(this),
+      'deploy:additionalstacks:deploy': this.deployAdditionalStackDeploy.bind(this),
     }
   }
 
@@ -90,16 +85,7 @@ class ServerlessPlugin {
   deployAdditionalStackDeploy() {
     const stacks = this.getAdditionalStacks()
 
-    if (this.options.all) {
-      // Deploy all additional stacks
-      if (Object.keys(stacks).length > 0) {
-        this.serverless.cli.log('Deploying all additional stacks...')
-        return this.deployStacks(stacks)
-      } else {
-        this.serverless.cli.log('No additional stacks defined. Add a custom.additionalStacks section to serverless.yml.')
-        return Promise.resolve()
-      }
-    } else if (this.options.stack) {
+    if (this.options.stack) {
       const stack = stacks[this.options.stack]
       if (stack) {
         this.serverless.cli.log('Deploying additional stack ' + this.options.stack + '...')
@@ -108,10 +94,22 @@ class ServerlessPlugin {
         return Promise.reject(new Error('Additional stack not found: ' + this.options.stack))
       }
     } else {
-      return Promise.reject(new Error('Please specify either sls deploy additionalstack -a to deploy all additional stacks or -k [stackName] to deploy a single stack'))
+      // Deploy all additional stacks
+      if (Object.keys(stacks).length > 0) {
+        this.serverless.cli.log('Deploying all additional stacks...')
+        return this.deployStacks(stacks)
+      } else {
+        this.serverless.cli.log('No additional stacks defined. Add a custom.additionalStacks section to serverless.yml.')
+        return Promise.resolve()
+      }
     }
   }
 
+  // Generate a full name for an additional stack (used in AWS)
+  getFullStackName(stackName) {
+    return this.provider.naming.getStackName() + '-' + stackName
+  }
+
   // This deploys all the specified stacks
   deployStacks(stacks) {
     let promise = Promise.resolve()
@@ -126,7 +124,132 @@ class ServerlessPlugin {
 
   // This is where we actually handle the deployment to AWS
   deployStack(stackName, stack) {
-    this.serverless.cli.log('DEPLOYING NOW ' + stackName + ' ' + JSON.stringify(stack))
+    // Generate the CloudFormation template
+    const compiledCloudFormationTemplate = {
+      "AWSTemplateFormatVersion": "2010-09-09",
+      "Description": stack.Description || "Additional AWS CloudFormation template for this Serverless application",
+      "Metadata": stack.Metadata || undefined,
+      "Parameters": stack.Parameters || undefined,
+      "Mappings": stack.Mappings || undefined,
+      "Conditions": stack.Conditions || undefined,
+      "Transform": stack.Transform || undefined,
+      "Resources": stack.Resources || undefined,
+      "Outputs": stack.Outputs || undefined,
+    }
+
+    // Generate tags
+    const stackTags = {
+      STAGE: this.options.stage || this.serverless.service.provider.stage
+    }
+    if (typeof stack.Tags === 'object') {
+      // Add custom tags
+      Object.assign(stackTags, stack.Tags)
+    }
+
+    // Generate full stack name
+    const fullStackName = this.getFullStackName(stackName)
+
+    return this.describeStack(fullStackName)
+    .then(stackStatus => {
+      if (!stackStatus) {
+        // Create stack
+        this.serverless.cli.log('Creating CloudFormation stack ' + fullStackName + '...')
+        console.log('TEMPL', compiledCloudFormationTemplate)
+        console.log('TAGS', stackTags)
+        return this.createStack(fullStackName, compiledCloudFormationTemplate, stackTags)
+      } else {
+        // Update stack
+        this.serverless.cli.log('Updating CloudFormation stack ' + fullStackName + '...')
+        return this.updateStack(fullStackName, compiledCloudFormationTemplate, stackTags)
+      }
+    })
+  }
+
+  describeStack(fullStackName) {
+    return this.provider.request(
+      'CloudFormation',
+      'describeStacks', {
+        StackName: fullStackName,
+      },
+      this.options.stage,
+      this.options.region
+    )
+    .then(response => {
+      return response.Stacks && response.Stacks[0]
+    })
+    .then(null, err => {
+      if (err.message && err.message.match(/does not exist$/)) {
+        // Stack doesn't exist yet
+        return null
+      } else {
+        // Some other error, let it throw
+        return Promise.reject(err)
+      }
+    })
+  }
+
+  createStack(fullStackName, compiledCloudFormationTemplate, stackTags) {
+    // These are the same parameters that Serverless uses in https://github.com/serverless/serverless/blob/master/lib/plugins/aws/deploy/lib/createStack.js
+    const params = {
+      StackName: fullStackName,
+      OnFailure: 'ROLLBACK',
+      Capabilities: [
+        'CAPABILITY_IAM',
+        'CAPABILITY_NAMED_IAM',
+      ],
+      Parameters: [],
+      TemplateBody: JSON.stringify(compiledCloudFormationTemplate),
+      Tags: Object.keys(stackTags).map((key) => ({ Key: key, Value: stackTags[key] })),
+    }
+
+    return this.provider.request(
+      'CloudFormation',
+      'createStack',
+      params,
+      this.options.stage,
+      this.options.region
+    )
+  }
+
+  updateStack(fullStackName, compiledCloudFormationTemplate, stackTags) {
+    // These are the same parameters that Serverless uses in https://github.com/serverless/serverless/blob/master/lib/plugins/aws/lib/updateStack.js
+    const params = {
+      StackName: fullStackName,
+      Capabilities: [
+        'CAPABILITY_IAM',
+        'CAPABILITY_NAMED_IAM',
+      ],
+      Parameters: [],
+      TemplateBody: JSON.stringify(compiledCloudFormationTemplate),
+      Tags: Object.keys(stackTags).map((key) => ({ Key: key, Value: stackTags[key] })),
+    }
+
+    return this.provider.request(
+      'CloudFormation',
+      'updateStack',
+      params,
+      this.options.stage,
+      this.options.region
+    )
+    .then(null, err => {
+      if (err.message && err.message.match(/^No updates/)) {
+        // Stack is unchanged, ignore error
+        return Promise.resolve()
+      } else {
+        return Promise.reject(err)
+      }
+    })
+  }
+
+  waitForStack(fullStackName) {
+    const readMore = () => {
+      return describeStack(fullStackName)
+      .then(response => {
+        console.log('STATUS', response)
+        setTimeout(readMore, 5000)
+      })
+    }
+    return readMore()
   }
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-additional-stacks",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "main": "index.js",
   "repository": {},
   "license": "MIT"