Merge pull request #31 from nicka/feature/preV1Resources

Bump version to v3.0.0

Author: nicka

.eslintrc

@@ -15,6 +15,7 @@
   },
   "rules": {
     "no-console": 0,
+    "prefer-promise-reject-errors": 0,
     "strict": 0,
     "import/prefer-default-export": 0,
     "import/no-extraneous-dependencies": [

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog - serverless-plugin-diff
 
+<a name="3.0.0"></a>
+## 6 February 2017: v3.0.0
+
+Made the plugin ready for Serverless v3.* and removed custom options from the CLI command -- [@nicka][@nicka]
+
+---
+
 <a name="1.3.0"></a>
 ## 6 February 2017: v1.3.0
 

README.md

@@ -6,7 +6,7 @@
 
 ## Overview
 
-Plugin for Serverless Framework v1.x which compares your local AWS CloudFormation templates against deployed ones.
+Plugin for Serverless Framework v3.x which compares your local AWS CloudFormation templates against deployed ones.
 
 # Usage
 
@@ -16,25 +16,6 @@ serverless 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">
 
-## Command options
-
-```bash
---diffTool ksdiff
-```
-
-Custom diff tool:
-
->Defaults to `diff`
-
-
-```bash
---localTemplate foo.json
-```
-
-Custom CloudFormation template to diff against:
-
->Defaults to `./serverless/cloudformation-template-update-stack.json`
-
 # Install
 
 Execute npm install in your Serverless project.

lib/index.js

@@ -2,7 +2,6 @@
 
 const AWS = require('aws-sdk');
 const diff = require('json-diff').diffString;
-const exec = require('child-process-promise').exec;
 const fs = require('fs-promise');
 
 class ServerlessPlugin {
@@ -14,23 +13,6 @@ class ServerlessPlugin {
       diff: {
         usage: 'Compares local AWS CloudFormation templates against deployed ones',
         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',
-          },
-        },
       },
     };
 
@@ -45,29 +27,33 @@ class ServerlessPlugin {
     this.options.region = this.options.region
       || (this.serverless.service.defaults && this.serverless.service.defaults.region)
       || 'us-east-1';
-    this.options.diffTool = this.options.diffTool;
-    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();
+    this.localTemplate = '.serverless/cloudformation-template-update-stack.json';
+    this.orgTemplate = '.serverless/cloudformation-template-update-stack.org.json';
   }
 
   downloadTemplate() {
     let stackName;
 
-    const orgTemplate = this.options.orgTemplate;
+    const { orgTemplate } = this;
 
     if (this.serverless.service.provider
-        && typeof this.serverless.service.provider.stackName !== 'undefined'
-        && this.serverless.service.provider.stackName !== '') {
+      && typeof this.serverless.service.provider.stackName !== 'undefined'
+      && this.serverless.service.provider.stackName !== '') {
       stackName = this.serverless.service.provider.stackName;
     } else {
       stackName = `${this.serverless.service.service}-${this.options.stage}`;
     }
 
+    if (this.serverless.service.provider
+      && typeof this.serverless.service.provider.preV1Resources !== 'undefined'
+      && this.serverless.service.provider.preV1Resources === true) {
+      stackName += '-r';
+    }
+
     const params = {
       StackName: stackName,
       TemplateStage: 'Processed',
@@ -81,40 +67,32 @@ class ServerlessPlugin {
         templateBody = JSON.stringify(templateBody, null, 2);
 
         return fs.writeFile(orgTemplate, templateBody)
-          .then(() => Promise.resolve());
+          .then(() => {
+            console.log('Downloaded currently deployed template');
+            return Promise.resolve();
+          });
       })
-      .catch(err => Promise.reject(err.message));
+      .catch((err) => Promise.reject(err.message));
   }
 
   diff() {
-    const diffTool = this.options.diffTool;
-    const localTemplate = this.options.localTemplate;
-    const orgTemplate = this.options.orgTemplate;
+    const { localTemplate, orgTemplate } = this;
 
     this.serverless.cli.log('Running diff against deployed template');
 
     return fs.stat(localTemplate)
       .then(() => {
-        if (typeof diffTool === 'undefined') {
-          const orgTemplateJson = JSON.parse(fs.readFileSync(orgTemplate, 'utf8'));
-          const localTemplateJson = JSON.parse(fs.readFileSync(localTemplate, 'utf8'));
-          const differences = diff(orgTemplateJson, localTemplateJson) || {};
-
-          if (differences.trim() === 'undefined') {
-            console.log('Resource templates are equal');
-          } else {
-            console.log(differences);
-          }
-
-          return Promise.resolve(differences);
+        const orgTemplateJson = JSON.parse(fs.readFileSync(orgTemplate, 'utf8'));
+        const localTemplateJson = JSON.parse(fs.readFileSync(localTemplate, 'utf8'));
+        const differences = diff(orgTemplateJson, localTemplateJson) || {};
+
+        if (Object.entries(differences).length === 0) {
+          console.log('Resource templates are equal');
+        } else {
+          console.log(differences);
         }
 
-        return exec(`${diffTool} ${orgTemplate} ${localTemplate} || true`)
-          .then((result) => {
-            const diffData = result.stdout;
-            console.log(diffData);
-            return Promise.resolve(diffData);
-          });
+        return Promise.resolve(differences);
       })
       .catch((err) => {
         if (err.code === 'ENOENT') {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "serverless-plugin-diff",
-  "version": "1.3.0",
-  "description": "Plugin for Serverless Framework v1.x which compares your local AWS CloudFormation templates against deployed ones.",
+  "version": "3.0.0",
+  "description": "Plugin for Serverless Framework v3.x which compares your local AWS CloudFormation templates against deployed ones.",
   "main": "lib/index.js",
   "scripts": {
     "pretest": "eslint .",
@@ -28,17 +28,19 @@
   ],
   "dependencies": {
     "aws-sdk": "^2.6.15",
-    "child-process-promise": "^2.2.0",
     "fs-promise": "^0.5.0",
-    "json-diff": "^0.3.1"
+    "json-diff": "^0.7.3"
   },
   "devDependencies": {
     "aws-sdk-mock": "^1.5.0",
     "coveralls": "^2.11.14",
-    "eslint": "^3.8.1",
-    "eslint-config-airbnb-base": "^9.0.0",
-    "eslint-plugin-import": "^2.0.1",
-    "jest": "^16.0.2"
+    "eslint": "^8.11.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.25.4",
+    "jest": "^27.5.1"
+  },
+  "peerDependencies": {
+    "serverless": "^2.60 || 3"
   },
   "jest": {
     "bail": true,
@@ -51,7 +53,7 @@
         "statements": 90
       }
     },
-    "testPathDirs": ["test"],
+    "roots": ["test"],
     "verbose": true
   }
 }

test/__snapshots__/index.test.js.snap

@@ -1,45 +1,32 @@
-exports[`serverless-plugin-write-env-vars diff could not find locally compiled template unsuccessfully triggers diff 1`] = `".serverless/cloudformation-template-update-stack.json could not be found: run \"sls deploy --noDeploy\" first."`;
+// Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`serverless-plugin-write-env-vars diff runs diff with custom localTemplate template successfully triggers diff 1`] = `
-" {
--  foo: \"custom\"
-+  foo: \"foo\"
- }
-"
-`;
+exports[`serverless-plugin-write-env-vars diff could not find locally compiled template unsuccessfully triggers diff 1`] = `".serverless/cloudformation-template-update-stack.json could not be found: run \\"sls deploy --noDeploy\\" first."`;
 
-exports[`serverless-plugin-write-env-vars diff runs diff without changes successfully triggers diff 1`] = `
-" undefined
-"
-`;
-
-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 runs diff without changes successfully triggers diff 1`] = `Object {}`;
 
 exports[`serverless-plugin-write-env-vars diff successfully triggers diff runs diff with defaults 1`] = `
 " {
-[31m-  foo: \"bar\"[39m
-[32m+  foo: \"foo\"[39m
+[31m-  foo: \\"bar\\"[39m
+[32m+  foo: \\"foo\\"[39m
  }
 "
 `;
 
 exports[`serverless-plugin-write-env-vars downloadTemplate with successful CloudFormation call downloads currently deployed template 1`] = `
 "{
-  \"foo\": \"bar\"
+  \\"foo\\": \\"bar\\"
 }"
 `;
 
 exports[`serverless-plugin-write-env-vars downloadTemplate with successful CloudFormation call downloads currently deployed template with custom stackName 1`] = `
 "{
-  \"foo\": \"bar\"
+  \\"foo\\": \\"bar\\"
+}"
+`;
+
+exports[`serverless-plugin-write-env-vars downloadTemplate with successful CloudFormation call downloads currently deployed template with preV1Resources flag 1`] = `
+"{
+  \\"foo\\": \\"bar\\"
 }"
 `;