gina 0.1.1-alpha.117 → 0.1.1-alpha.118

package/README.md

@@ -25,17 +25,33 @@ Gina aims to be at the same time a framework, a deployment and monitoring enviro
 > For Microsoft Windows, you might have to run the command line with Administrator privileges.
 > For Linux & Mac OS X, __the use of `sudo` is discouraged.__
 
-#### 1st method (prefered)
+#### 1st method (prefered) - Custom PREFIX
+
+This will install Gina in the user's home directory avoiding at the same time the need to use `sudo` or the `root` user.
+By adding at the end the `--reset` argument, you will ensure a factory reset for the `~/.gina` preferences folder: all preferences will be lost, but your existing projects will not be erased.
+
+```tty
+npm install -g gina@latest --prefix=~/.npm-global
+```
+
+You can now check if Gina is properly installed.
+
+```  tty
+gina version
+```
+__NB.:__ This is a shortcut for `gina framework:version`
+
+#### 2nd method - Classical
 
 ```  tty
 npm install -g gina@latest
 ```
 
 __A few words about this method__
-Gina will try to install itself using the default $NPM_PREFIX. If the target is not writable, the prefix used will be updated for the time of the install process to `~/.npm-global` and restored back to your default $NPM_PREFIX after installation.
-This is why you should not get errors on installation.
+This method is mainly used if you wish to install gina with the `root` user.
+Gina will try to install itself using the default $NPM_PREFIX (`/usr/local`). If the target is not writable you will get permission errors.
 
-Still, __if you are not enterely satisfyied with this method__, you can setup permissions for your user in order to be able to write to : `$NPM_PREFIX/lib/node_modules`.
+__Note that for this method__, if the user is not `root`, you can setup permissions for your user in order to be able to write to : `$NPM_PREFIX/lib/node_modules`.
 
 If you don't already have done it, you should start with :
 
@@ -44,7 +60,7 @@ sudo chown -R $USER $(npm config get prefix)/lib/node_modules
 ```
 
 
-> __NB. :__ If you choose to use `sudo npm install -g gina`, you will also o use the `sudo` for specific commands like `npm link gina`.
+> __Important :__ If you choose to use `sudo npm install -g gina`, you will also have to use the `sudo` for specific commands like `npm link gina`.
 > Again, the use of `sudo` is discouraged.
 
 
@@ -54,26 +70,14 @@ You can now check if Gina is properly installed.
 ```  tty
 gina version
 ```
-__NB.:__ This is a shortcut for `gina framework:version`
-
-
-#### 2nd method - Custom PREFIX
-
-This will install Gina in the user's home directory avoiding at the same time the need to use `sudo`.
-By adding at the end the `--reset` argument, you will ensure a factory reset for the `~/.gina` preferences folder: all preferences will be lost, but your existing projects will not be erased.
-
-```tty
-npm install -g gina@latest --prefix=~/.npm-global
-```
-
-You can now check if Gina is properly installed.
-
+or
 ```  tty
-gina version
+sudo gina version
 ```
 __NB.:__ This is a shortcut for `gina framework:version`
 
 
+
 #### 3rd method - local to your project
 
 If you feel like you do not need to install globally Gina for some reasons like only using the framework for a single project, you can install Gina without the `-g` argument.
@@ -89,7 +93,7 @@ You can now check if Gina is properly installed.
 ```  tty
 ./gina version
 ```
-__NB.:__ This is a shortcut for `gina framework:version`
+__NB.:__ This is a shortcut for `./gina framework:version`
 
 
 

package/bin/cli

@@ -26,6 +26,10 @@ async function onExec() {
         , debugBrkEnabled   = false
         , isUpdateRequired  = false
         , params            = process.argv
+        , settings          = null
+        , hostname          = os.hostname() // by default
+        , hostV4            = null
+        , mqPort            = null
     ;
     try {
         var packObj         = require(pack);
@@ -48,6 +52,27 @@ async function onExec() {
                     continue;
                 }
 
+                if ( /^\-\-mq\-port/.test(params[p]) ) {
+                    let mqPort = params[p].split(/\=/)[1];
+                    setEnvVar('GINA_MQ_PORT', ~~mqPort);// jshint ignore:line
+                    isUpdateRequired = true;
+                    continue;
+                }
+
+                if ( /^\-\-host\-v4/.test(params[p]) ) {
+                    let host = params[p].split(/\=/)[1];
+                    setEnvVar('GINA_HOST_V4', host);// jshint ignore:line
+                    isUpdateRequired = true;
+                    continue;
+                }
+
+                if ( /^\-\-hostname/.test(params[p]) ) {
+                    hostname = params[p].split(/\=/)[1];
+                    setEnvVar('GINA_HOSTNAME', hostname);// jshint ignore:line
+                    isUpdateRequired = true;
+                    continue;
+                }
+
                 if ( /^\-\-debug(\_|\-)port/.test(params[p]) ) {
                     let port = params[p].split(/\=/)[1];
                     setEnvVar('GINA_DEBUG_PORT', ~~port);// jshint ignore:line
@@ -65,6 +90,7 @@ async function onExec() {
         }
 
 
+
         var shortVersion = version.split('.');
         shortVersion.splice(2);
         shortVersion = shortVersion.join('.');
@@ -76,8 +102,8 @@ async function onExec() {
         }
         home = getEnvVar('GINA_HOMEDIR');// jshint ignore:line
 
-        var settings = { 'log_level': 'info'}; // First time launch or reset
-        if ( new _( home +'/'+ shortVersion +'/settings.json', true ).existsSync() ) {
+        settings = { 'log_level': 'info'}; // First time launch or reset
+        if ( new _( home +'/'+ shortVersion +'/settings.json', true ).existsSync() ) {// jshint ignore:line
             var settingsPath =  _( home +'/'+ shortVersion +'/settings.json', true );// jshint ignore:line
             settings = requireJSON(settingsPath);// jshint ignore:line
         }
@@ -89,6 +115,14 @@ async function onExec() {
         setEnvVar('GINA_LOGDIR', settings['logdir']);// jshint ignore:line
         setEnvVar('GINA_TMPDIR', settings['tmpdir']);// jshint ignore:line
 
+        // prior to what settings says
+        if (hostname != settings['hostname'] && !isUpdateRequired) {
+            setEnvVar('GINA_TMPDIR', settings['hostname']);// jshint ignore:line
+            hostname = settings['hostname'];
+        }
+        hostV4 = getEnvVar('GINA_HOST_V4') || settings['host_v4'] || '127.0.0.1';// jshint ignore:line
+        mqPort = getEnvVar('GINA_MQ_PORT')|| settings['mq_port'] || 8125;// jshint ignore:line
+
         if ( typeof(packObj.config) != 'undefined' ) {
             if (typeof(packObj.config.prefix) != 'undefined' ) {
                 setEnvVar('GINA_PREFIX', packObj.config.prefix);// jshint ignore:line
@@ -111,10 +145,9 @@ async function onExec() {
 
             var MQListener = require(frameworkPath + '/lib/logger/src/containers/mq/listener.js');
 
-            var mqPort = 8125;
-            var mqListener = await new MQListener({ port: 8125 });
+            var mqListener = await new MQListener({ port: mqPort, host: hostV4 });
             // required for tail command
-            var mqPortFile = getTmpDir() + '/mq-listener-v'+ version +'.port';
+            var mqPortFile = getTmpDir() + '/mq-listener-v'+ version +'.port';// jshint ignore:line
             console.debug('Writting: '+ mqPortFile);
             fs.writeFileSync( mqPortFile, ''+mqPort );
             process.on('exit', function() {
@@ -154,19 +187,27 @@ async function onExec() {
     }
     setEnvVar('GINA_IS_WIN32', isWin32, true);// jshint ignore:line
 
+    if (!settings) {
+        settings = requireJSON(settingsPath);// jshint ignore:line
+    }
     if (isUpdateRequired) {
-        settings['port'] = getEnvVar('GINA_PORT') || null;// jshint ignore:line
-        settings['debug_port'] = getEnvVar('GINA_DEBUG_PORT') || null;// jshint ignore:line
-        console.debug('Updating debug settings: #'+  getEnvVar('GINA_DEBUG_PORT'));// jshint ignore:line
+        console.debug('Updating debug settings ...');// jshint ignore:line
+        settings['port'] = getEnvVar('GINA_PORT') || settings['port'] || null;// jshint ignore:line
+        settings['debug_port'] = getEnvVar('GINA_DEBUG_PORT') || settings['debug_port'] || null;// jshint ignore:line
+
+        settings['mq_port'] = getEnvVar('GINA_MQ_PORT') || settings['mq_port'] || null;// jshint ignore:line
+        settings['host_v4'] = getEnvVar('GINA_HOST_V4') || settings['host_v4'] || null;// jshint ignore:line
+        settings['hostname'] = getEnvVar('GINA_HOSTNAME') || settings['hostname'] || null;// jshint ignore:line
         generator.createFileFromDataSync(settings, settingsPath);// jshint ignore:line
     }
 
 
     /**
      * Framework port
+     * To change it: gina framework:set --port=<port_number>
      * TODO - Add a port scanner & compare with ~/.gina/{shortVersion}/settings.json on `post_install`
      * */
-    var port = 8124;
+    var port = settings['port'] || 8124;
 
     // |-> framework/{version}/lib/cmd
     var allowedOffline = [
@@ -212,6 +253,9 @@ async function onExec() {
             frameworkPath   : frameworkPath,
             homedir         : home,
             port            : port,
+            hostV4          : hostV4,
+            mqPort          : mqPort,
+            hostname        : hostname,
             debugPort       : debugPort,
             debugBrkEnabled : debugBrkEnabled,
             pack            : pack
@@ -232,6 +276,9 @@ async function onExec() {
             frameworkPath   : frameworkPath,
             homedir         : home,
             port            : port,
+            hostV4          : hostV4,
+            mqPort          : mqPort,
+            hostname        : hostname,
             debugPort       : debugPort,
             debugBrkEnabled : debugBrkEnabled,
             pack            : pack
@@ -246,7 +293,7 @@ async function onExec() {
     } else {
 
         //Connect to framework.
-        var client = net.connect({port: port},
+        var client = net.connect({port: port, host: hostV4},
             function() {
                 //Forwarding cmd.
                 // retieving debug infos

package/bin/cmd

@@ -21,6 +21,10 @@ function Cmd(opt, runOffine) {
         local.ginaPath          = opt.ginaPath;
         local.homedir           = opt.homedir;
         local.frameworkPath     = opt.frameworkPath;
+        local.hostname          = opt.hostname;
+        local.hostV4            = opt.hostV4;
+        local.mqPort            = opt.mqPort;
+        local.port              = opt.port;
 
         lib = require(local.frameworkPath + "/lib");
 
@@ -68,8 +72,12 @@ function Cmd(opt, runOffine) {
                     argv : argv,
                     client : conn,
                     homedir : local.homedir,
+                    port : local.port,
                     debugPort : local.debugPort,
-                    debugBrkEnabled : local.debugBrkEnabled
+                    debugBrkEnabled : local.debugBrkEnabled,
+                    hostname : local.hostname,
+                    hostV4: local.hostV4,
+                    mqPort: local.mqPort
                 })
             })
         });
@@ -82,7 +90,7 @@ function Cmd(opt, runOffine) {
                     var port  = err.port || getEnvVar('GINA_PORT');// jshint ignore:line
                     var procsFile = _(getEnvVar('GINA_HOMEDIR') +'/procs.json', true);// jshint ignore:line
                     if ( new _(procsFile).existsSync() ) {
-                        var runningProcs = requireJSON(procsFile);
+                        var runningProcs = requireJSON(procsFile);// jshint ignore:line
                         for (let i in runningProcs) {
                             if (runningProcs[i].port == port) {
                                 pid = runningProcs[i].pid;
@@ -115,8 +123,12 @@ function Cmd(opt, runOffine) {
                 client : process.stdout,
                 isFromFramework : true,
                 homedir : local.homedir,
+                port : local.port,
                 debugPort : local.debugPort,
                 debugBrkEnabled : local.debugBrkEnabled,
+                hostname: local.hostname,
+                hostV4: local.hostV4,
+                mqPort: local.mqPort,
                 task : {
                     topic : "framework",
                     action : "start"
@@ -141,8 +153,12 @@ function Cmd(opt, runOffine) {
             client : process.stdout,
             isFromFramework : true,
             homedir : local.homedir,
+            port: local.port,
             debugPort : local.debugPort,
             debugBrkEnabled : local.debugBrkEnabled,
+            hostname: local.hostname,
+            hostV4: local.hostV4,
+            mqPort: local.mqPort,
             task : {
                 topic : topic,
                 action : action

package/framework/v0.1.1-alpha.118/VERSION

@@ -0,0 +1 @@
+0.1.1-alpha.118