zcash-hackworks
/
bitcore-node-zcash
mirror of https://github.com/zcash-hackworks/bitcore-node-zcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #332 from braydonf/config 

Changes to be able to run with only a configuration file.
This commit is contained in:
Chris Kleeschulte 2015-10-20 14:11:37 -04:00
parent 9b0ea9873d e046f7294e
commit de96d7d936
11 changed files with 202 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/cli/bitcore.js
View File

@ -2,7 +2,7 @@
var Liftoff = require('liftoff');
function main() {
function main(parentServicesPath, additionalServices) {
var liftoff = new Liftoff({
name: 'bitcore',
@ -23,16 +23,14 @@ function main() {
}, function(env){
var node;
if (env.modulePackage && env.configPath) {
// use the configured version
node = require(env.modulePath);
if (typeof env.modulePath === 'undefined') {
node = require('../../');
node.cli.main(parentServicesPath, additionalServices);
} else {
// use this version
node = require('..');
node = require(env.modulePath);
node.cli.main();
}
node.cli.main();
});
}

17
lib/cli/bitcored.js
View File

@ -2,7 +2,7 @@
var Liftoff = require('liftoff');
function main() {
function main(parentServicesPath, additionalServices) {
var liftoff = new Liftoff({
name: 'bitcored',
@ -23,15 +23,14 @@ function main() {
}, function(env){
var node;
if (env.modulePackage && env.configPath) {
// use the configured version
node = require(env.modulePath);
} else {
// use this version
node = require('..');
}
node.cli.daemon();
if (typeof env.modulePath === 'undefined') {
node = require('../../');
node.cli.daemon(parentServicesPath, additionalServices);
} else {
node = require(env.modulePath);
node.cli.daemon();
}
});

9
lib/cli/daemon.js
View File

@ -4,7 +4,7 @@ var program = require('commander');
var path = require('path');
var bitcore = require('..');
function main() {
function main(servicesPath, additionalServices) {
/* jshint maxstatements: 100 */
var version = bitcore.version;
@ -25,11 +25,16 @@ function main() {
}
var configInfo = findConfig(program.config || process.cwd());
if (!configInfo) {
configInfo = defaultConfig();
configInfo = defaultConfig({
additionalServices: additionalServices
});
}
if(program.daemon) {
configInfo.config.daemon = true;
}
if (servicesPath) {
configInfo.servicesPath = servicesPath;
}
start(configInfo);
}

9
lib/cli/main.js
View File

@ -4,7 +4,7 @@ var program = require('commander');
var path = require('path');
var bitcorenode = require('..');
function main() {
function main(servicesPath, additionalServices) {
/* jshint maxstatements: 100 */
var version = bitcorenode.version;
@ -52,11 +52,16 @@ function main() {
}
var configInfo = findConfig(cmd.config || process.cwd());
if (!configInfo) {
configInfo = defaultConfig();
configInfo = defaultConfig({
additionalServices: additionalServices
});
}
if(cmd.daemon) {
configInfo.config.daemon = true;
}
if (servicesPath) {
configInfo.servicesPath = servicesPath;
}
start(configInfo);
});

4
lib/scaffold/create.js
View File

@ -9,7 +9,7 @@ var path = require('path');
var packageFile = require('../../package.json');
var mkdirp = require('mkdirp');
var fs = require('fs');
var defaultConfig = require('./default-config');
var defaultBaseConfig = require('./default-base-config');
var version;
if (packageFile.version.match('-dev')) {
@ -55,7 +55,7 @@ function createConfigDirectory(configDir, datadir, isGlobal, done) {
throw err;
}
var configInfo = defaultConfig();
var configInfo = defaultBaseConfig();
var config = configInfo.config;
config.datadir = datadir;

21
lib/scaffold/default-base-config.js Normal file
View File

@ -0,0 +1,21 @@
'use strict';
var path = require('path');
/**
* Will return the path and default bitcore-node configuration on environment variables
* or default locations.
*/
function getDefaultBaseConfig() {
return {
path: process.cwd(),
config: {
datadir: path.resolve(process.env.HOME, '.bitcoin'),
network: 'livenet',
port: 3001,
services: ['bitcoind', 'db', 'address', 'web']
}
};
}
module.exports = getDefaultBaseConfig;

56
lib/scaffold/default-config.js
View File

@ -1,21 +1,57 @@
'use strict';
var path = require('path');
var mkdirp = require('mkdirp');
var fs = require('fs');
/**
* Will return the path and default bitcore-node configuration on environment variables
* or default locations.
* Will return the path and default bitcore-node configuration. It will search for the
* configuration file in the "~/.bitcore" directory, and if it doesn't exist, it will create one
* based on default settings.
* @param {Object} [options]
* @param {Array} [options.additionalServices] - An optional array of services.
*/
function getDefaultConfig() {
function getDefaultConfig(options) {
/* jshint maxstatements: 40 */
if (!options) {
options = {};
}
var defaultPath = path.resolve(process.env.HOME, './.bitcore');
var defaultConfigFile = path.resolve(defaultPath, './bitcore-node.json');
if (!fs.existsSync(defaultPath)) {
mkdirp.sync(defaultPath);
}
var defaultServices = ['bitcoind', 'db', 'address', 'web'];
if (options.additionalServices) {
defaultServices = defaultServices.concat(options.additionalServices);
}
if (!fs.existsSync(defaultConfigFile)) {
var defaultConfig = {
datadir: path.resolve(defaultPath, './data'),
network: 'livenet',
port: 3001,
services: defaultServices
};
fs.writeFileSync(defaultConfigFile, JSON.stringify(defaultConfig, null, 2));
}
var defaultDataDir = path.resolve(defaultPath, './data');
if (!fs.existsSync(defaultDataDir)) {
mkdirp.sync(defaultDataDir);
}
var config = JSON.parse(fs.readFileSync(defaultConfigFile, 'utf-8'));
return {
path: process.cwd(),
config: {
datadir: process.env.BITCORENODE_DIR || path.resolve(process.env.HOME, '.bitcoin'),
network: process.env.BITCORENODE_NETWORK || 'livenet',
port: Number(process.env.BITCORENODE_PORT) || 3001,
services: ['bitcoind', 'db', 'address', 'web']
}
path: defaultPath,
config: config
};
}
module.exports = getDefaultConfig;

17
lib/scaffold/start.js
View File

@ -24,14 +24,14 @@ log.debug = function() {};
* }
* ]
* @param {Function} req - The require function to use
* @param {Array} cwd - The local path (for requiring services)
* @param {Array} servicesPath - The local path (for requiring services)
* @param {Object} config
* @param {Array} config.services - An array of strings of service names.
* @returns {Array}
*/
function setupServices(req, cwd, config) {
function setupServices(req, servicesPath, config) {
module.paths.push(path.resolve(cwd, './node_modules'));
module.paths.push(path.resolve(servicesPath, './node_modules'));
var services = [];
if (config.services) {
@ -180,6 +180,7 @@ function exitHandler(options, _process, node, err) {
* This function will instantiate and start a Node, requiring the necessary service
* modules, and registering event handlers.
* @param {Object} options
* @param {Object} options.servicesPath - The path to the location of service modules
* @param {String} options.path - The absolute path of the configuration file
* @param {Object} options.config - The parsed bitcore-node.json configuration file
* @param {Array} options.config.services - An array of services names.
@ -191,7 +192,15 @@ function exitHandler(options, _process, node, err) {
function start(options) {
var fullConfig = _.clone(options.config);
fullConfig.services = start.setupServices(require, options.path, options.config);
var servicesPath;
if (options.servicesPath) {
servicesPath = options.servicesPath; // services are in a different directory than the config
} else {
servicesPath = options.path; // defaults to the same directory
}
fullConfig.services = start.setupServices(require, servicesPath, options.config);
fullConfig.datadir = path.resolve(options.path, options.config.datadir);
if (fullConfig.daemon) {

4
test/scaffold/create.integration.js
View File

@ -53,10 +53,6 @@ describe('#create', function() {
});
it('will create scaffold files', function() {
delete process.env.BITCORENODE_DIR;
delete process.env.BITCORENODE_NETWORK;
delete process.env.BITCORENODE_PORT;
create({
cwd: testDir,
dirname: 'mynode',

17
test/scaffold/default-base-config.integration.js Normal file
View File

@ -0,0 +1,17 @@
'use strict';
var should = require('chai').should();
var defaultBaseConfig = require('../../lib/scaffold/default-base-config');
describe('#defaultConfig', function() {
it('will return expected configuration', function() {
var cwd = process.cwd();
var home = process.env.HOME;
var info = defaultBaseConfig();
info.path.should.equal(cwd);
info.config.datadir.should.equal(home + '/.bitcoin');
info.config.network.should.equal('livenet');
info.config.port.should.equal(3001);
info.config.services.should.deep.equal(['bitcoind', 'db', 'address', 'web']);
});
});

95
test/scaffold/default-config.integration.js
View File

@ -1,35 +1,90 @@
'use strict';
var should = require('chai').should();
var defaultConfig = require('../../lib/scaffold/default-config');
var sinon = require('sinon');
var proxyquire = require('proxyquire');
describe('#defaultConfig', function() {
it('will return expected configuration', function() {
var config = JSON.stringify({
datadir: process.env.HOME + '/.bitcore/data',
network: 'livenet',
port: 3001,
services: [
'bitcoind',
'db',
'address',
'web'
]
}, null, 2);
var defaultConfig = proxyquire('../../lib/scaffold/default-config', {
fs: {
existsSync: sinon.stub().returns(false),
writeFileSync: function(path, data) {
path.should.equal(process.env.HOME + '/.bitcore/bitcore-node.json');
data.should.equal(config);
},
readFileSync: function() {
return config;
}
},
mkdirp: {
sync: sinon.stub()
}
});
var cwd = process.cwd();
delete process.env.BITCORENODE_DIR;
delete process.env.BITCORENODE_NETWORK;
delete process.env.BITCORENODE_PORT;
var home = process.env.HOME;
var info = defaultConfig();
info.path.should.equal(cwd);
info.config.datadir.should.equal(home + '/.bitcoin');
info.path.should.equal(home + '/.bitcore');
info.config.datadir.should.equal(home + '/.bitcore/data');
info.config.network.should.equal('livenet');
info.config.port.should.equal(3001);
info.config.services.should.deep.equal(['bitcoind', 'db', 'address', 'web']);
});
it('will return expected configuration from environment variables', function() {
var cwd = process.cwd();
process.env.BITCORENODE_DIR = '/home/bitcore-node/.bitcoin';
process.env.BITCORENODE_NETWORK = 'testnet';
process.env.BITCORENODE_PORT = 3002;
var info = defaultConfig();
info.path.should.equal(cwd);
info.config.datadir.should.equal('/home/bitcore-node/.bitcoin');
info.config.network.should.equal('testnet');
info.config.port.should.equal(3002);
info.config.services.should.deep.equal(['bitcoind', 'db', 'address', 'web']);
it('will include additional services', function() {
var config = JSON.stringify({
datadir: process.env.HOME + '/.bitcore/data',
network: 'livenet',
port: 3001,
services: [
'bitcoind',
'db',
'address',
'web',
'insight-api',
'insight-ui'
]
}, null, 2);
var defaultConfig = proxyquire('../../lib/scaffold/default-config', {
fs: {
existsSync: sinon.stub().returns(false),
writeFileSync: function(path, data) {
path.should.equal(process.env.HOME + '/.bitcore/bitcore-node.json');
data.should.equal(config);
},
readFileSync: function() {
return config;
}
},
mkdirp: {
sync: sinon.stub()
}
});
var home = process.env.HOME;
var info = defaultConfig({
additionalServices: ['insight-api', 'insight-ui']
});
info.path.should.equal(home + '/.bitcore');
info.config.datadir.should.equal(home + '/.bitcore/data');
info.config.network.should.equal('livenet');
info.config.port.should.equal(3001);
info.config.services.should.deep.equal([
'bitcoind',
'db',
'address',
'web',
'insight-api',
'insight-ui'
]);
});
});