Merge pull request #733 from tkambler/master

Adds support for JSON configuration values

Author: indexzero

.editorconfig

@@ -0,0 +1,3 @@
+[*.js]
+indent_style = space
+indent_size = 2

README.md

@@ -98,6 +98,41 @@ There are [several examples][1] designed to test the fault tolerance of forever.
   $ forever -m 5 examples/error-on-timer.js
 ```
 
+### JSON Configuration Files
+
+In addition to passing forever the path to a script (along with accompanying options, described above), you may also pass forever the path to a JSON file, in which these options are defined. For example, consider an application with the following file structure:
+
+```
+.
+├── forever
+│   └── development.json
+└── index.js
+
+// forever/development.json
+{
+	// Comments are supported
+    "uid": "app",
+    "append": true,
+    "watch": true,
+    "script": "index.js",
+    "sourceDir": "/home/myuser/app"
+}
+```
+
+This application could be started with forever, as shown below:
+
+``` bash
+$ forever start ./forever/development.json
+```
+
+Absolute paths to such configuration files are also supported:
+
+``` bash
+$ forever start /home/myuser/app/forever/development.json
+```
+
+**Note:** Forever parses JSON configuration files using [shush](https://github.com/krakenjs/shush), allowing the use of in-line comments within such files.
+
 ### Using In Your Code
 The forever module exposes some useful methods to use in your code. Each method returns an instance of an EventEmitter which emits when complete. See the [forever cli commands][2] for sample usage.
 

lib/forever/cli.js

@@ -12,6 +12,8 @@ var fs = require('fs'),
     colors = require('colors'),
     cliff = require('cliff'),
     flatiron = require('flatiron'),
+    shush = require('shush'),
+    objectAssign = require('object-assign'),
     forever = require('../forever');
 
 var cli = exports;
@@ -196,7 +198,31 @@ function checkColumn(name) {
 // `forever.startDaemon`
 //
 var getOptions = cli.getOptions = function (file) {
-  var options = {};
+  var options = {},
+      absFile = path.isAbsolute(file) ? file : path.resolve(process.cwd(), file),
+      configKeys = [
+        'pidFile', 'logFile', 'errFile', 'watch', 'minUptime', 'append',
+        'silent', 'outFile', 'max', 'command', 'path', 'spinSleepTime',
+        'sourceDir', 'workingDir', 'uid', 'watchDirectory', 'watchIgnore',
+        'killTree', 'killSignal', 'id'
+      ],
+      jsonConfig = {};
+
+  //
+  // Load JSON configuration values
+  //
+  if (path.extname(file) === '.json') {
+    jsonConfig = path.isAbsolute(file) ? shush(file) : shush(absFile);
+    jsonConfig = Object.keys(jsonConfig).reduce(function (acc, curr, i, arr) {
+      if (!!~configKeys.indexOf(curr) || curr === 'script') { acc[curr] = jsonConfig[curr]; }
+      return acc;
+    }, {});
+    if (!jsonConfig.script) {
+      forever.log.error('The \'script\' option is required when using JSON configuration files');
+      process.exit(1);
+    }
+  }
+
   //
   // First isolate options which should be passed to file
   //
@@ -209,12 +235,7 @@ var getOptions = cli.getOptions = function (file) {
   app.config.stores.argv.store = {};
   app.config.use('argv', argvOptions);
 
-  [
-    'pidFile', 'logFile', 'errFile', 'watch', 'minUptime', 'append',
-    'silent', 'outFile', 'max', 'command', 'path', 'spinSleepTime',
-    'sourceDir', 'workingDir', 'uid', 'watchDirectory', 'watchIgnore',
-    'killTree', 'killSignal', 'id'
-  ].forEach(function (key) {
+  configKeys.forEach(function (key) {
     options[key] = app.config.get(key);
   });
 
@@ -240,6 +261,8 @@ var getOptions = cli.getOptions = function (file) {
   options.workingDir = options.workingDir || options.sourceDir;
   options.spawnWith  = { cwd: options.workingDir };
 
+  objectAssign(options, jsonConfig);
+
   return options;
 };
 
@@ -264,6 +287,8 @@ app.cmd(/start (.+)/, cli.startDaemon = function () {
   var file = app.argv._[1],
       options = getOptions(file);
 
+  file = options.script ? options.script : file;
+
   forever.log.info('Forever processing file: ' + file.grey);
   tryStart(file, options, function () {
     forever.startDaemon(file, options);
@@ -559,6 +584,8 @@ cli.run = function () {
   var file = app.argv._[0],
       options = getOptions(file);
 
+  file = options.script ? options.script : file;
+
   tryStart(file, options, function () {
     var monitor = forever.start(file, options);
     monitor.on('start', function () {

package.json

@@ -19,13 +19,15 @@
     "tools"
   ],
   "dependencies": {
-    "colors": "~0.6.2",
     "cliff": "~0.1.9",
+    "colors": "~0.6.2",
     "flatiron": "~0.4.2",
     "forever-monitor": "~1.5.1",
     "nconf": "~0.6.9",
     "nssocket": "~0.5.1",
+    "object-assign": "^3.0.0",
     "optimist": "~0.6.0",
+    "shush": "^1.0.0",
     "timespan": "~2.3.0",
     "utile": "~0.2.1",
     "winston": "~0.8.1"

test/core/start-stop-json-test.js

@@ -0,0 +1,60 @@
+/*
+ * start-stop-json-test.js: start or stop forever using relative paths, the script path could be start with './', '../' ...
+ *
+ * (C) 2010 Charlie Robbins & the Contributors
+ * MIT LICENCE
+ *
+ */
+
+var assert = require('assert'),
+    path = require('path'),
+    fs = require('fs'),
+    spawn = require('child_process').spawn,
+    vows = require('vows'),
+    forever = require('../../lib/forever');
+
+function runCmd(cmd, args) {
+  var proc = spawn(process.execPath, [
+    path.resolve(__dirname, '../../', 'bin/forever'),
+    cmd
+  ].concat(args), {detached: true});
+
+  proc.unref();
+}
+
+vows.describe('forever/core/start-stop-json').addBatch({
+  "When using forever" : {
+    "to start process using JSON configuration file" : {
+      topic: function () {
+        runCmd('start', [
+          './test/fixtures/server.json'
+        ]);
+        setTimeout(function (that) {
+          forever.list(false, that.callback);
+        }, 2000, this);
+      },
+      "the startup should works fine": function (err, procs) {
+        assert.isNull(err);
+        assert.isArray(procs);
+        assert.equal(procs.length, 1);
+      }
+    }
+  }
+}).addBatch({
+    "When the script is running" : {
+      "try to stop by uid" : {
+        topic: function () {
+          runCmd('stop', [
+            'server'
+          ]);
+          setTimeout(function (that) {
+            forever.list(false, that.callback);
+          }, 2000, this);
+        },
+        "the shut down should works fine": function (err, procs) {
+          assert.isNull(err);
+          assert.isNull(procs);
+        }
+      }
+    }
+  }).export(module);

test/core/start-stop-relative-test.js

@@ -1,5 +1,5 @@
 /*
- * start-stop-relative.js: start or stop forever using relative paths, the script path could be start with './', '../' ...
+ * start-stop-relative-test.js: start or stop forever using relative paths, the script path could be start with './', '../' ...
  *
  * (C) 2010 Charlie Robbins & the Contributors
  * MIT LICENCE
@@ -22,7 +22,7 @@ function runCmd(cmd, args) {
   proc.unref();
 }
 
-vows.describe('forever/core/start-stop-peaceful').addBatch({
+vows.describe('forever/core/start-stop-relative').addBatch({
   "When using forever" : {
     "to run script with relative script path" : {
       topic: function () {
@@ -57,4 +57,4 @@ vows.describe('forever/core/start-stop-peaceful').addBatch({
         }
       }
     }
-  }).export(module);
+  }).export(module);

test/fixtures/server.json

@@ -0,0 +1,6 @@
+{
+    "uid": "server",
+    "append": true,
+    "script": "server.js",
+    "sourceDir": "./test/fixtures"
+}