Merge pull request #2 from redgeoff/cl

feat(command-line)

Author: redgeoff

README.md

@@ -5,4 +5,76 @@
 A fault-tolerant way to replicate an entire CouchDB cluster
 
 
+## Installation
+
+    $ npm install -g replicate-couchdb-cluster
+
+
+## Usage
+
+    Usage: replicate-couchdb-cluster -s source -t target options
+
+      -s source           The URL for the CouchDB cluster from which we will be
+                          replicating
+
+      -s target           The URL for the CouchDB cluster to which we will be
+                          replicating
+
+    Options:
+
+      -c max-concurrency  The maximum number of concurrent replications. If this
+                          value is omitted then the max-concurrency is defaulted
+                          to 20.
+
+      -i dbs-to-skip      A comma separated list of DBS to skip
+
+      -a                  Use the target's _replicate API when replicating. This is
+                          particularly useful when you are trying to replicate from
+                          a remote source to localhost. By default, the source's
+                          _replicate API is used.
+
+      -v                  Verbose
+
+    Examples:
+
+      Replicate all DBs on example1.com to example2.com:
+
+        $ replicate-couchdb-cluster -s http://example1.com:5984 -t http://example2.com:5984
+
+      Replicate all DBs, except the _users and _replicator DBs:
+
+        $ replicate-couchdb-cluster -s http://example1.com:5984 -t http://example2.com:5984 \
+                                    -i _users,replicator
+
+      Replicate all DBs using SSL and authentication:
+
+        $ replicate-couchdb-cluster -s https://admin1:secrect1@example1.com:6984 \
+                                    -t https://admin2:secrect2@example2.com:6984
+
+      Replicate all DBs from a remote source to a local source:
+
+        $ replicate-couchdb-cluster -s https://admin1:secrect1@example1.com \
+                                    -t http://localhost:5984
+                                    -a
+
+## API
+
+You can also use the API.
+
+Example:
+
+```js
+var replicate = require('replicate-couchdb-cluster');
+replicate({
+  source: https://admin1:secrect1@example1.com:6984,
+  target: https://admin2:secrect2@example2.com:6984,
+  concurrency: 10,
+  skip: ['_users', '_replicator'],
+  verbose: true,
+  useTargetAPI: true
+}).then(function () {
+  // Replication done
+});
+```
+
 ## [Testing](TESTING.md)

bin/cmd.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+
+'use strict';
+
+var replicate = require('../scripts'),
+  argv = require('minimist')(process.argv.slice(2)),
+  fs = require('fs');
+
+if (!argv.s || !argv.t) {
+  return fs.createReadStream(__dirname + '/usage.txt')
+    .pipe(process.stdout)
+    .on('close', function () {
+      process.exit(1);
+    });
+} else {
+  var skip = null;
+  if (argv.i) {
+    skip = argv.i.split(',');
+  }
+
+  replicate({
+    source: argv.s,
+    target: argv.t,
+    concurrency: argv.c,
+    skip: skip,
+    verbose: argv.v ? true : false,
+    useTargetAPI: argv.a ? true : false
+  }).catch(function (err) {
+    console.error('Fatal Error:', err.message);
+    process.exit(1);
+  });
+}

bin/usage.txt

@@ -0,0 +1,45 @@
+
+Usage: replicate-couchdb-cluster -s source -t target options
+
+  -s source           The URL for the CouchDB cluster from which we will be
+                      replicating
+
+  -s target           The URL for the CouchDB cluster to which we will be
+                      replicating
+
+Options:
+
+  -c max-concurrency  The maximum number of concurrent replications. If this
+                      value is omitted then the max-concurrency is defaulted
+                      to 20.
+
+  -i dbs-to-skip      A comma separated list of DBS to skip
+
+  -a                  Use the target's _replicate API when replicating. This is
+                      particularly useful when you are trying to replicate from
+                      a remote source to localhost. By default, the source's
+                      _replicate API is used.
+
+  -v                  Verbose
+
+Examples:
+
+  Replicate all DBs on example1.com to example2.com:
+
+    $ replicate-couchdb-cluster -s http://example1.com:5984 -t http://example2.com:5984
+
+  Replicate all DBs, except the _users and _replicator DBs:
+
+    $ replicate-couchdb-cluster -s http://example1.com:5984 -t http://example2.com:5984 \
+                                -i _users,replicator
+
+  Replicate all DBs using SSL and authentication:
+
+    $ replicate-couchdb-cluster -s https://admin1:secrect1@example1.com:6984 \
+                                -t https://admin2:secrect2@example2.com:6984
+
+  Replicate all DBs from a remote source to a local source:
+
+    $ replicate-couchdb-cluster -s https://admin1:secrect1@example1.com \
+                                -t http://localhost:5984
+                                -a

package.json

@@ -3,6 +3,9 @@
   "version": "0.0.1",
   "description": "A fault-tolerant way to replicate an entire CouchDB cluster",
   "main": "index.js",
+  "bin": {
+    "replicate-couchdb-cluster": "bin/cmd.js"
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/redgeoff/replicate-couchdb-cluster"
@@ -19,9 +22,9 @@
     "url": "https://github.com/redgeoff/replicate-couchdb-cluster/issues"
   },
   "scripts": {
-    "assert-beautified": "beautify-proj -i test -c beautify.json && beautify-proj -i scripts -c beautify.json",
-    "beautify": "beautify-proj -i test -o . -c beautify.json && beautify-proj -i scripts -o . -c beautify.json",
-    "jshint": "jshint -c .jshintrc test scripts",
+    "assert-beautified": "beautify-proj -i test -c beautify.json && beautify-proj -i scripts -c beautify.json && beautify-proj -i bin -c beautify.json",
+    "beautify": "beautify-proj -i test -o . -c beautify.json && beautify-proj -i scripts -o . -c beautify.json && beautify-proj -i bin -o . -c beautify.json",
+    "jshint": "jshint -c .jshintrc test scripts bin",
     "node-test": "istanbul test --dir cache/coverage/node node_modules/mocha/bin/_mocha test/node.js",
     "node-full-test": "npm run node-test --coverage && istanbul check-coverage --lines 100 --function 100 --statements 100 --branches 100",
     "browser-server": "node_modules/gofur/scripts/browser/serve.js -c cache -t test/browser.js",
@@ -55,8 +58,9 @@
     ]
   },
   "dependencies": {
-    "couch-slouch": "0.0.3",
-    "sporks": "0.0.1",
-    "squadron": "0.0.3"
+    "couch-slouch": "^0.0.4",
+    "minimist": "^1.2.0",
+    "sporks": "^0.0.1",
+    "squadron": "^0.0.3"
   }
 }

scripts/cluster.js

@@ -8,6 +8,8 @@ var Slouch = require('couch-slouch'),
 //   target
 //   concurrency
 //   skip
+//   verbose
+//   useTargetAPI
 var Cluster = function (params) {
   this._params = params;
 
@@ -24,6 +26,12 @@ var Cluster = function (params) {
   }
 };
 
+Cluster.prototype._log = function (msg) {
+  if (this._params.verbose) {
+    console.log(new Date() + ': ' + msg);
+  }
+};
+
 Cluster.prototype.replicate = function () {
   var self = this;
   return self._sourceSlouch.db.all().each(function (db) {
@@ -50,19 +58,23 @@ Cluster.prototype._replicateSecurity = function (sourceDB, targetDB) {
 };
 
 Cluster.prototype._replicateRawDB = function (sourceDB, targetDB) {
-  return this._sourceSlouch.db.replicate({
+  var slouch = this._params.useTargetAPI ? this._targetSlouch : this._sourceSlouch;
+  return slouch.db.replicate({
     source: this._params.source + '/' + sourceDB,
     target: this._params.target + '/' + targetDB
   });
 };
 
 Cluster.prototype._replicateDB = function (sourceDB, targetDB) {
   var self = this;
+  self._log('beginning replication of ' + sourceDB + '...');
   return self._createDBIfMissing(targetDB).then(function () {
     // Replicate security first so that security is put in place before data is copied over
     return self._replicateSecurity(sourceDB, targetDB);
   }).then(function () {
     return self._replicateRawDB(sourceDB, targetDB);
+  }).then(function () {
+    self._log('finished replicating ' + sourceDB);
   });
 };
 

scripts/index.js

@@ -1,3 +1,8 @@
 'use strict';
 
-module.exports = require('./cluster');
+var Cluster = require('./cluster');
+
+module.exports = function (params) {
+  var cluster = new Cluster(params);
+  return cluster.replicate();
+};

test/node-and-browser.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var Promise = require('sporks/scripts/promise'),
-  Cluster = require('../scripts'),
+  Cluster = require('../scripts/cluster'),
   sporks = require('sporks'),
   Slouch = require('couch-slouch');
 
@@ -11,7 +11,8 @@ describe('node and browser', function () {
     id = 0,
     cluster = null,
     replicatedDBs = null,
-    differentCluster = false;
+    differentCluster = false,
+    consoleLog = null;
 
   var data = {
     db1: {
@@ -169,11 +170,15 @@ describe('node and browser', function () {
 
     differentCluster = false;
 
+    consoleLog = console.log;
+
     return createData();
   });
 
   afterEach(function () {
-    return destroyData();
+    return destroyData().then(function () {
+      console.log = consoleLog;
+    });
   });
 
   it('should replicate', function () {
@@ -223,4 +228,28 @@ describe('node and browser', function () {
     });
   });
 
+  it('should replicate with targets api', function () {
+    return replicate({
+      source: 'http://admin:admin@localhost:5984',
+      target: 'http://admin:admin@localhost:5984',
+      useTargetAPI: true
+    });
+  });
+
+  it('should log when verbose on', function () {
+    // Mock
+    var msg = null;
+    console.log = function (_msg) {
+      msg = _msg;
+    };
+
+    return replicate({
+      source: 'http://admin:admin@localhost:5984',
+      target: 'http://admin:admin@localhost:5984',
+      verbose: true
+    }).then(function () {
+      (msg === null).should.eql(false);
+    });
+  });
+
 });

test/node.js

@@ -4,6 +4,41 @@ var chai = require('chai');
 chai.use(require('chai-as-promised'));
 chai.should();
 
+var path = require('path'),
+  spawn = require('child_process').spawn;
+
 require('./node-and-browser');
 
-// TODO: use spawn to test CL interface
+describe('node', function () {
+
+  // The test sometimes takes longer than the default of 2 secs
+  this.timeout(4000);
+
+  it('should work via command line', function (done) {
+
+    var options = [
+      '-s', 'http://admin:admin@localhost:5984',
+      '-t', 'http://admin:admin@localhost:5984'
+    ];
+
+    var child = spawn(path.join(__dirname, '/../bin/cmd.js'), options);
+
+    child.stderr.on('data', function ( /* data */ ) {
+      throw new Error('should not get data on stderr');
+    });
+
+    child.on('error', function (err) {
+      throw err;
+    });
+
+    child.on('close', function (code) {
+      if (code > 0) {
+        throw new Error('non-zero code');
+      } else {
+        done();
+      }
+    });
+
+  });
+
+});