Merge pull request nicka#2 from nicka/release/1.0.0

Release/1.0.1

Author: nicka

.eslintignore

@@ -0,0 +1,7 @@
+.tmp/
+build/
+coverage/
+docs/
+node_modules/
+results/
+.serverless

.eslintrc

@@ -0,0 +1,26 @@
+{
+  "extends": "airbnb-base",
+  "globals": {
+    "afterAll": true,
+    "applyToAll": true,
+    "afterEach": true,
+    "beforeAll": true,
+    "beforeEach": true,
+    "describe": true,
+    "expect": true,
+    "jest": true,
+    "register": true,
+    "it": true,
+    "test": true
+  },
+  "rules": {
+    "no-console": 0,
+    "strict": 0,
+    "import/prefer-default-export": 0,
+    "import/no-extraneous-dependencies": [
+      "error", {
+        "devDependencies": ["**/*.test.js", "**/*.spec.js"]
+      }
+    ]
+  }
+}

.gitignore

@@ -6,6 +6,7 @@ build
 dist
 logs
 pids
+*.tgz
 
 # OS
 .DS_Store

.npmignore

@@ -0,0 +1,21 @@
+__snapshots__
+.env
+.eslintignore
+.eslintrc
+.serverless
+.tgz
+.tmp
+.travis.yml
+*.env
+*.log
+*.pid
+*.seed
+*.test.js
+build
+coverage
+dist
+jspm_packages
+logs
+node_modules
+pids
+results

.travis.yml

@@ -0,0 +1,16 @@
+language: node_js
+node_js:
+- '4'
+cache:
+  directories:
+  - node_modules
+branches:
+  only:
+  - develop
+  - master
+  - "/^feature\\/.*$/"
+  - "/^release\\/.*$/"
+install:
+- travis_retry npm install
+after_success:
+  - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage

README.md

@@ -1,19 +1,21 @@
 [![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
+[![Coverage-Status](https://coveralls.io/repos/github/nicka/serverless-plugin-diff/badge.svg?branch=master)](https://coveralls.io/github/nicka/serverless-plugin-diff?branch=master)
+[![Build-Status](https://travis-ci.org/nicka/serverless-plugin-diff.svg?branch=master)](https://travis-ci.org/nicka/serverless-plugin-diff)
 
 # Serverless CloudFormation Diff
 
-WIP
-
 ## Overview
 
 Plugin for Serverless Framework v1.x which compares your locale AWS CloudFormation templates against deployed ones.
 
 ## Usage
 
 ```bash
-serverless deploy --diff --noDeploy --stage REPLACEME --region REPLACEME
+serverless deploy diff --stage REPLACEME --region REPLACEME
 ```
 
+<img width="1255" alt="screen shot 2016-11-05 at 14 53 04" src="https://cloud.githubusercontent.com/assets/195404/20030536/9e1a552c-a367-11e6-8e6d-2043f2a5d038.png">
+
 ## Install
 
 Execute npm install in your Serverless project.

lib/__snapshots__/index.test.js.snap

@@ -0,0 +1,39 @@
+exports[`serverless-plugin-write-env-vars diff successfully triggers diff runs diff with custom diff tool 1`] = `
+"1c1
+< {\"foo\":\"bar\"}
+\\ No newline at end of file
+---
+> {\"foo\":\"foo\"}
+\\ No newline at end of file
+"
+`;
+
+exports[`serverless-plugin-write-env-vars diff successfully triggers diff runs diff with custom localTemplate template 1`] = `
+"1c1
+< {\"foo\":\"custom\"}
+\\ No newline at end of file
+---
+> {\"foo\":\"foo\"}
+\\ No newline at end of file
+"
+`;
+
+exports[`serverless-plugin-write-env-vars diff successfully triggers diff runs diff with defaults 1`] = `
+"1c1
+< {\"foo\":\"bar\"}
+\\ No newline at end of file
+---
+> {\"foo\":\"foo\"}
+\\ No newline at end of file
+"
+`;
+
+exports[`serverless-plugin-write-env-vars diff unsuccessfully triggers diff could not find locally compiled template 1`] = `".serverless/cloudformation-template-update-stack.json could not be found: run \"sls deploy --noDeploy\" first."`;
+
+exports[`serverless-plugin-write-env-vars downloadTemplate with successful CloudFormation call downloads currently deployed template 1`] = `
+"{
+  \"foo\": \"bar\"
+}"
+`;
+
+exports[`serverless-plugin-write-env-vars downloadTemplate with unsuccessful CloudFormation call could not download deployed template 1`] = `"Stack with id foo-foo does not exist"`;

lib/index.js

@@ -0,0 +1,114 @@
+'use strict';
+
+const AWS = require('aws-sdk');
+const fs = require('fs-promise');
+const exec = require('child-process-promise').exec;
+const Q = require('q');
+
+class ServerlessPlugin {
+  constructor(serverless, options) {
+    this.serverless = serverless;
+    this.options = options;
+
+    this.commands = {
+      diff: {
+        usage: 'Helps you start your first Serverless plugin',
+        lifecycleEvents: ['diff'],
+        options: {
+          diffTool: {
+            usage:
+              'Specify the diff tool you want to use '
+              + '(e.g. "--diffTool \'ksdiff\'")',
+            required: false,
+            shortcut: 'dt',
+          },
+          localTemplate: {
+            usage:
+              'Specify your locally compiled CloudFormation template'
+              + '(e.g. "--localTemplate \'./serverless/'
+              + 'cloudformation-template-update-stack.json\'")',
+            required: false,
+            shortcut: 'lt',
+          },
+        },
+      },
+    };
+
+    this.hooks = {
+      'before:diff:diff': this.downloadTemplate.bind(this),
+      'diff:diff': this.diff.bind(this),
+    };
+
+    this.options.stage = this.options.stage
+      || (this.serverless.service.defaults && this.serverless.service.defaults.stage)
+      || 'dev';
+    this.options.region = this.options.region
+      || (this.serverless.service.defaults && this.serverless.service.defaults.region)
+      || 'us-east-1';
+    this.options.diffTool = this.options.diffTool
+      || 'diff';
+    this.options.localTemplate = this.options.localTemplate
+      || '.serverless/cloudformation-template-update-stack.json';
+    this.options.orgTemplate = this.options.localTemplate.replace('.json', '.org.json');
+
+    AWS.config.update({ region: this.options.region });
+
+    this.cloudFormation = new AWS.CloudFormation();
+  }
+
+  downloadTemplate() {
+    const deferred = Q.defer();
+    const orgTemplate = this.options.orgTemplate;
+    const params = {
+      StackName: `${this.serverless.service.service}-${this.options.stage}`,
+      TemplateStage: 'Processed',
+    };
+
+    this.serverless.cli.log('Downloading currently deployed template');
+
+    this.cloudFormation.getTemplate(params, (err, data) => {
+      if (err) {
+        deferred.reject(err.message);
+      } else {
+        let templateBody = JSON.parse(data.TemplateBody);
+        templateBody = JSON.stringify(templateBody, null, 2);
+
+        fs.writeFile(orgTemplate, templateBody)
+          .then(() => deferred.resolve())
+          .catch(fsErr => deferred.reject(fsErr.message));
+      }
+    });
+
+    return deferred.promise;
+  }
+
+  diff() {
+    const deferred = Q.defer();
+    const diffTool = this.options.diffTool;
+    const localTemplate = this.options.localTemplate;
+    const orgTemplate = this.options.orgTemplate;
+
+    this.serverless.cli.log('Running diff against deployed template');
+
+    fs.stat(localTemplate)
+      .then(() => {
+        exec(`${diffTool} ${orgTemplate} ${localTemplate} || true`)
+          .then((result) => {
+            const diffData = result.stdout;
+            console.log(diffData);
+            deferred.resolve(diffData);
+          })
+          .catch(execErr => deferred.reject(execErr.message));
+      })
+      .catch((err) => {
+        if (err.code === 'ENOENT') {
+          const errorPrefix = `${localTemplate} could not be found:`;
+          deferred.reject(`${errorPrefix} run "sls deploy --noDeploy" first.`);
+        }
+      });
+
+    return deferred.promise;
+  }
+}
+
+module.exports = ServerlessPlugin;