Skip to content

Commit 1d455bf

Browse files
AshanFernandoAshanFernando
committed
Initial commit
1 parent d16fdd0 commit 1d455bf

9 files changed

+317
-2
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/node_modules
2+
/dynamodb/bin

‎.jshintrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"node": true,
3+
"esnext": true
4+
}

‎README.md

+70-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,70 @@
1-
# dynamodb-localhost
2-
Dynamodb localhost runner for development and testing
1+
dynamodb-localhost
2+
=================================
3+
[![npm version](https://badge.fury.io/js/dynamodb-localhost.svg)](https://badge.fury.io/js/dynamodb-localhost)
4+
[![license](https://img.shields.io/npm/l/dynamodb-localhost.svg)](https://www.npmjs.com/package/dynamodb-localhost)
5+
6+
This library works as a wrapper for AWS DynamoDB Local, intended for use in devops. This library is capable of downloading and installing the DynamoDB Local with a simple set of commands, and pass optional attributes defined in ['DynamoDB Local Documentation'](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html).
7+
8+
## This Plugin Requires
9+
10+
* Java Runtime Engine (JRE) version 6.x or newer
11+
12+
## Features
13+
14+
* Method to Download/Install DynamoDB Local
15+
* Remove/Uninstall DynamoDB Local
16+
* Start/Restart DynamoDB Local with all the options givne in http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html
17+
* Stop individual instances of DynamoDb Local running
18+
19+
## Installation
20+
21+
`npm install --save dynamodb-localhost`
22+
23+
## Usage
24+
25+
Usage example
26+
27+
'var dynamodbLocal = require("dynamodb-localhost")'
28+
'dynamodbLocal.start({port: 8000})'
29+
30+
Provided methods
31+
32+
```
33+
install() To install DynamoDB Local for usage (This is one time operation unless execute remove)
34+
start(options) To start an instance of DynamoDB Local. More information about options shown in the coming section
35+
stop(port) To stop particular instance of DynamoDb Local running on an specified port
36+
remove() To remove DynamoDB Local instance
37+
```
38+
39+
NOTE: After executing start(options), DynamoDB will process incoming requests until you stop it. To stop DynamoDB, type Ctrl+C in the command prompt window. To view dynamodb interactive web shell, go to DynamoDB Local [shell](http://localhost:8000/shell) in your browser.
40+
41+
All options for DynamoDB start:
42+
43+
```
44+
{ port : 8000, /* Port to listen on. Default: 8000 */
45+
cors : '*', /* Enable CORS support (cross-origin resource sharing) for JavaScript. You must provide a comma-separated "allow" list of specific domains. The default setting for cors is an asterisk (*), which allows public access. */
46+
inMemory : true, /* DynamoDB; will run in memory, instead of using a database file. When you stop DynamoDB;, none of the data will be saved. Note that you cannot specify both dbPath and inMemory at once. */
47+
dbPath : '<mypath>/', /* The directory where DynamoDB will write its database file. If you do not specify this option, the file will be written to the current directory. Note that you cannot specify both dbPath and inMemory at once. For the path, current working directory is <projectroot>/node_modules/dynamodb-localhost/dynamob. For example to create <projectroot>/node_modules/dynamodb-localhost/dynamob/<mypath> you should specify '<mypath>/' with a forwardslash at the end. */
48+
sharedDb : true, /* DynamoDB will use a single database file, instead of using separate files for each credential and region. If you specify sharedDb, all DynamoDB clients will interact with the same set of tables regardless of their region and credential configuration. */
49+
delayTransientStatuses : true, /* Causes DynamoDB to introduce delays for certain operations. DynamoDB can perform some tasks almost instantaneously, such as create/update/delete operations on tables and indexes; however, the actual DynamoDB service requires more time for these tasks. Setting this parameter helps DynamoDB simulate the behavior of the Amazon DynamoDB web service more closely. (Currently, this parameter introduces delays only for global secondary indexes that are in either CREATING or DELETING status.) */
50+
optimizeDbBeforeStartup : true } /* Optimizes the underlying database tables before starting up DynamoDB on your computer. You must also specify -dbPath when you use this parameter. */
51+
```
52+
53+
## Links
54+
55+
* [Dynamodb local documentation](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html)
56+
* [Contact Us](mailto:[email protected])
57+
* [NPM Registry](https://www.npmjs.com/package/dynamodb-localhost
58+
59+
## Contributing
60+
61+
We love our contributors! If you'd like to contribute to the project, feel free to submit a PR. But please keep in mind the following guidelines:
62+
63+
* Propose your changes before you start working on a PR. You can reach us by submitting a Github issue. This is just to make sure that no one else is working on the same change, and to figure out the best way to solve the issue.
64+
* If you're out of ideas, but still want to contribute, help us in solving Github issues already verified.
65+
* Contributions are not just PRs! We'd be grateful for having you, and if you could provide some support for new comers, that be great! You can also do that by answering this plugin related questions on Stackoverflow.
66+
You can also contribute by writing. Feel free to let us know if you want to publish a useful guides, improve the documentation (attributed to you, thank you!) that you feel will help the community.
67+
68+
## Credits
69+
70+
Bunch of thanks to doapp-ryanp who started [dynamodb-local](https://github.com/doapp-ryanp/dynamodb-local) project

‎dynamodb/config.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"setup": {
3+
"download_url": "http://dynamodb-local.s3-website-us-west-2.amazonaws.com/dynamodb_local_latest.tar.gz",
4+
"install_path": "/bin",
5+
"jar": "DynamoDBLocal.jar"
6+
},
7+
"start": {
8+
"port": 8000
9+
}
10+
}

‎dynamodb/installer.js

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
'use strict';
2+
3+
var tar = require('tar'),
4+
zlib = require('zlib'),
5+
path = require('path'),
6+
http = require('http'),
7+
fs = require('fs'),
8+
ProgressBar = require('progress'),
9+
utils = require('./utils');
10+
11+
var download = function (downloadUrl, installPath, callback) {
12+
http.get(downloadUrl, function (response) {
13+
if (302 != response.statusCode) {
14+
callback(new Error('Error getting DynamoDb local latest tar.gz location: ' + response.statusCode));
15+
}
16+
http.get(response.headers.location, function (redirectResponse) {
17+
var len = parseInt(redirectResponse.headers['content-length'], 10),
18+
bar = new ProgressBar('Downloading dynamodb-local [:bar] :percent :etas', {
19+
complete: '=',
20+
incomplete: ' ',
21+
width: 40,
22+
total: len
23+
});
24+
if (200 != redirectResponse.statusCode) {
25+
throw new Error('Error getting DynamoDb local latest tar.gz location ' + response.headers.location + ': ' + redirectResponse.statusCode);
26+
}
27+
redirectResponse
28+
.pipe(zlib.Unzip())
29+
.pipe(tar.Extract({
30+
path: installPath
31+
}))
32+
.on('data', function (chunk) {
33+
bar.tick(chunk.length);
34+
})
35+
.on('end', function () {
36+
callback("\n Installation complete!");
37+
})
38+
.on('error', function (err) {
39+
throw new Error("Error in downloading Dynamodb local " + err);
40+
});
41+
})
42+
.on('error', function (err) {
43+
throw Error("Error in downloading Dynamodb local " + err);
44+
});
45+
})
46+
.on('error', function (err) {
47+
throw new Error("Error in downloading Dynamodb local " + err);
48+
});
49+
};
50+
51+
var install = function (config, callback) {
52+
var install_path = utils.absPath(config.setup.install_path),
53+
jar = config.setup.jar,
54+
download_url = config.setup.download_url;
55+
56+
try {
57+
if (fs.existsSync(path.join(install_path, jar))) {
58+
callback("Dynamodb is already installed on path!");
59+
} else {
60+
utils.createDir(config.setup.install_path);
61+
download(download_url, install_path, callback);
62+
}
63+
} catch (e) {}
64+
};
65+
module.exports.install = install;

‎dynamodb/starter.js

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
'use strict';
2+
3+
var spawn = require('child_process').spawn,
4+
utils = require('./utils');
5+
6+
var starter = {
7+
start: function (options, config) {
8+
/* Dynamodb local documentation http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html */
9+
var additionalArgs = [],
10+
port = options.port || config.start.port,
11+
db_dir = utils.absPath(config.setup.install_path),
12+
jar = config.setup.jar;
13+
14+
if (options.dbPath) {
15+
additionalArgs.push('-dbPath', options.dbPath);
16+
} else {
17+
additionalArgs.push('-inMemory');
18+
}
19+
if (options.sharedDb) {
20+
additionalArgs.push('-sharedDb');
21+
}
22+
if (options.cors) {
23+
additionalArgs.push('-cors', options.cors);
24+
}
25+
if (options.delayTransientStatuses) {
26+
additionalArgs.push('-delayTransientStatuses');
27+
}
28+
if (options.optimizeDbBeforeStartup) {
29+
additionalArgs.push('-optimizeDbBeforeStartup');
30+
}
31+
if (options.help) {
32+
additionalArgs.push('-help');
33+
}
34+
35+
var args = ['-Djava.library.path=' + db_dir + '/DynamoDBLocal_lib', '-jar', jar, '-port', port];
36+
args = args.concat(additionalArgs);
37+
38+
var child = spawn('java', args, {
39+
cwd: db_dir,
40+
env: process.env,
41+
stdio: ['pipe', 'pipe', process.stderr]
42+
});
43+
44+
if (!child.pid) {
45+
throw new Error('Unable to start DynamoDB Local process!');
46+
}
47+
48+
child.on('error', function (code) {
49+
throw new Error(code);
50+
});
51+
52+
return {
53+
proc: child,
54+
port: port
55+
};
56+
},
57+
};
58+
59+
module.exports = starter;

‎dynamodb/utils.js

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
'use strict';
2+
3+
var path = require('path'),
4+
rmdir = require('rmdir'),
5+
fs = require('fs');
6+
7+
var absPath = function (relPath) {
8+
return path.dirname(__filename) + '/' + relPath;
9+
};
10+
11+
var removeDir = function (relPath, callback) {
12+
var path = absPath(relPath);
13+
rmdir(path, callback);
14+
};
15+
16+
var createDir = function (relPath) {
17+
if (!fs.existsSync(absPath(relPath))) {
18+
fs.mkdirSync(absPath(relPath));
19+
}
20+
};
21+
22+
module.exports = {
23+
absPath: absPath,
24+
removeDir: removeDir,
25+
createDir: createDir
26+
};

‎index.js

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
'use strict';
2+
3+
var installer = require('./dynamodb/installer'),
4+
starter = require('./dynamodb/starter'),
5+
utils = require('./dynamodb/utils'),
6+
config = require('./dynamodb/config.json'),
7+
dbInstances = {};
8+
9+
var dynamodb = {
10+
install: function () {
11+
installer.install(config, function (msg) {
12+
console.log(msg);
13+
});
14+
},
15+
start: function (options) {
16+
var instance = starter.start(options, config);
17+
dbInstances[instance.port] = {
18+
process: instance.proc,
19+
options: options
20+
};
21+
instance.proc.on('close', function (code) {
22+
if (code !== null && code !== 0) {
23+
console.log('DynamoDB Local failed to start with code', code);
24+
}
25+
});
26+
console.log('Dynamodb Local Started, Visit: http://localhost:' + (options.port || config.start.port) + '/shell');
27+
},
28+
stop: function (port) {
29+
if (dbInstances[port]) {
30+
dbInstances[port].process.kill('SIGKILL');
31+
delete dbInstances[port];
32+
}
33+
},
34+
restart: function (port) {
35+
var options = dbInstances[port].options;
36+
this.stop(port);
37+
this.start(options);
38+
console.log("Successfully restarted dynamodb local on port: " + port);
39+
},
40+
remove: function () {
41+
utils.removeDir(config.setup.install_path, function () {
42+
console.log("Successfully removed dynamodb local!");
43+
});
44+
}
45+
};
46+
module.exports = dynamodb;

‎package.json

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"name": "dynamodb-localhost",
3+
"version": "0.0.1",
4+
"engines": {
5+
"node": ">=4.0"
6+
},
7+
"description": "Dynamodb local plugin for development and testing",
8+
"author": "99xtechnology.com",
9+
"license": "MIT",
10+
"repository": {
11+
"type": "git",
12+
"url": "https://github.com/99xt/dynamodb-localhost"
13+
},
14+
"keywords": [
15+
"aws",
16+
"dynamodb",
17+
"dynamo",
18+
"testing",
19+
"development",
20+
"tool",
21+
"local",
22+
"localhost",
23+
"local-dynamodb",
24+
"dynamodb-local",
25+
"dynamodb-localhost"
26+
],
27+
"main": "index.js",
28+
"bin": {},
29+
"dependencies": {
30+
"mkdirp": "^0.5.0",
31+
"progress": "^1.1.8",
32+
"rmdir": "^1.2.0",
33+
"tar": "^2.0.0"
34+
}
35+
}

0 commit comments

Comments
 (0)