Merge branch 'v1' into aneil/allowCustomInstallPath

Author: mjzone

README.md

@@ -53,18 +53,23 @@ All CLI options are optional:
 --optimizeDbBeforeStartup -o  Optimizes the underlying database tables before starting up DynamoDB on your computer. You must also specify -dbPath when you use this parameter.
 --migrate                 -m  After starting DynamoDB local, create DynamoDB tables from the Serverless configuration.
 --seed                    -s  After starting and migrating dynamodb local, injects seed data into your tables. The --seed option determines which data categories to onload.
+--convertEmptyValues      -e  Set to true if you would like the document client to convert empty values (0-length strings, binary buffers, and sets) to be converted to NULL types when persisting to DynamoDB.
 ```
 
 All the above options can be added to serverless.yml to set default configuration: e.g.
 
 ```yml
 custom:
   dynamodb:
+  # If you only want to use DynamoDB Local in some stages, declare them here
+    stages:
+      - dev
     start:
       port: 8000
       inMemory: true
       migrate: true
       seed: true
+      convertEmptyValues: true
     # Uncomment only if you already have a DynamoDB running locally
     # noStart: true
 ```

index.js

@@ -74,6 +74,10 @@ class ServerlessDynamodbLocal {
                             seed: {
                                 shortcut: "s",
                                 usage: "After starting and migrating dynamodb local, injects seed data into your tables. The --seed option determines which data categories to onload.",
+                            },
+                            convertEmptyValues: {
+                                shortcut: "e",
+                                usage: "Set to true if you would like the document client to convert empty values (0-length strings, binary buffers, and sets) to be converted to NULL types when persisting to DynamoDB.",
                             }
                         }
                     },
@@ -101,6 +105,13 @@ class ServerlessDynamodbLocal {
             }
         };
 
+        const stage = this.options.stage || this.service.provider.stage;
+        if (this.config.stages && !this.config.stages.includes(stage)) {
+          // don't do anything for this stage
+          this.hooks = {};
+          return;
+        }
+
         this.hooks = {
             "dynamodb:migrate:migrateHandler": this.migrateHandler.bind(this),
             "dynamodb:seed:seedHandler": this.seedHandler.bind(this),
@@ -113,13 +124,13 @@ class ServerlessDynamodbLocal {
     }
 
     get port() {
-        const config = this.config;
+        const config = this.service.custom && this.service.custom.dynamodb || {};
         const port = _.get(config, "start.port", 8000);
         return port;
     }
 
     get host() {
-        const config = this.config;
+        const config = this.service.custom && this.service.custom.dynamodb || {};
         const host = _.get(config, "start.host", "localhost");
         return host;
     }
@@ -134,13 +145,15 @@ class ServerlessDynamodbLocal {
             }
             dynamoOptions = {
                 region: options.region,
+                convertEmptyValues: options && options.convertEmptyValues ? options.convertEmptyValues : false,
             };
         } else {
             dynamoOptions = {
                 endpoint: `http://${this.host}:${this.port}`,
                 region: "localhost",
                 accessKeyId: "MOCK_ACCESS_KEY_ID",
-                secretAccessKey: "MOCK_SECRET_ACCESS_KEY"
+                secretAccessKey: "MOCK_SECRET_ACCESS_KEY",
+                convertEmptyValues: options && options.convertEmptyValues ? options.convertEmptyValues : false,
             };
         }
 
@@ -182,7 +195,7 @@ class ServerlessDynamodbLocal {
     }
 
     startHandler() {
-        const config = this.config;
+        const config = this.service.custom && this.service.custom.dynamodb || {};
         const options = _.merge({
                 sharedDb: this.options.sharedDb || true,
                 install_path: this.options.localPath
@@ -279,6 +292,9 @@ class ServerlessDynamodbLocal {
               migration.SSESpecification.Enabled = migration.SSESpecification.SSEEnabled;
               delete migration.SSESpecification.SSEEnabled;
             }
+            if (migration.PointInTimeRecoverySpecification) {
+              delete migration.PointInTimeRecoverySpecification;
+            }
             if (migration.Tags) {
                 delete migration.Tags;
             }

src/seeder.js

@@ -96,7 +96,8 @@ function fileExists(fileName) {
  */
 function unmarshalBuffer(json) {
   _.forEach(json, function(value, key) {
-    if (value.type==="Buffer") {
+    // Null check to prevent creation of Buffer when value is null
+    if (value !== null && value.type==="Buffer") {
       json[key]= new Buffer(value.data);
     }
   });

test/indexTest.js

@@ -6,16 +6,19 @@ const expect = require("chai").expect;
 const should = require("should");
 const aws = require ("aws-sdk");
 const seeder = require("../src/seeder.js");
-const dataApp = require("../index.js");
+const Plugin = require("../index.js");
+
+const serverlessMock = require("./serverlessMock");
 
 describe("Port function",function(){
   it("Port should return number",function(){
-    let myport = dataApp.prototype.port;
-    assert(typeof myport, "number");
+    let service = new Plugin(serverlessMock, {});
+    assert(typeof service.port, "number");
   });
 
   it("Port value should be >= 0 and < 65536",function(done){
-    http.get(`http://localhost:${dataApp.prototype.port}/shell/`, function (response) {
+    let service = new Plugin(serverlessMock, {});
+    http.get(`http://localhost:${service.port}/shell/`, function (response) {
       assert.equal(response.statusCode, 200);
       done();
     });
@@ -34,29 +37,29 @@ describe("Check the dynamodb function",function(){
     });
 
   it("Should be an object",function(){
-    let dynamoOptions = dataApp.prototype.dynamodbOptions;
+    let dynamoOptions = Plugin.prototype.dynamodbOptions;
     let raw = new aws.DynamoDB(dynamoOptions);
     raw.should.be.type("object");
   });
 
   it("Should be an object",function(){
-    let dynamoOptions =  dataApp.prototype.dynamodbOptions;
+    let dynamoOptions =  Plugin.prototype.dynamodbOptions;
     let doc = new aws.DynamoDB(dynamoOptions);
     doc.should.be.type("object");
   });
 });
 
 describe ("Start handler function",function(){
   it ("Should not  be null",function(){
-    let handler = dataApp.prototype.startHandler;
+    let handler = Plugin.prototype.startHandler;
     assert(handler =! null);
   });
 });
 
 
 describe ("createTable functon",function(){
   it ("Should check as a function",function(){
-    const tbl = dataApp.prototype.createTable;
+    const tbl = Plugin.prototype.createTable;
     assert.equal(typeof tbl, "function");
   });
 }); 

test/serverlessMock.js

@@ -0,0 +1,7 @@
+module.exports = {
+    service: {},
+    cli: {
+        log: () => {}
+    },
+    custom: {}
+};