ssh2shell 2.0.3 → 2.0.6

package/test/Multiple primary hosts.js

@@ -1,66 +0,0 @@
-var dotenv = require('dotenv').config()
-
-var conParamsHost1 = {
-  host:         process.env.HOST,
-  port:         process.env.PORT,
-  userName:     process.env.USER_NAME,
-  password:     process.env.PASSWORD
- },
- conParamsHost2 = {
-  host:         process.env.SERVER2_HOST,
-  port:         process.env.PORT,
-  userName:     process.env.SERVER2_USER_NAME,
-  password:     process.env.SERVER2_PASSWORD
- },
- //set to fail
- conParamsHost3 = {
-  host:         process.env.SERVER3_HOST,
-  port:         process.env.PORT,
-  userName:     process.env.SERVER3_USER_NAME,
-  password:     process.env.SERVER3_PASSWORD
- },
- debug = true,
- verbose = false
-
-//Host objects:
-var host1 = {
-  server:       conParamsHost1,
-  commands:     ["echo Host_1"],
-  connectedMessage: "Connected to host1",
-  debug: debug,
-  verbose: verbose
-},
-
-host2 = {
-  server:       conParamsHost2,
-  commands:     ["echo Host_2"],
-  debug: debug,
-  verbose: verbose
-},
-
-host3 = {
-  server:       conParamsHost3,
-  commands:     ["echo Host_3"],
-  debug: debug,
-  verbose: verbose
-}
-
-
-//or the alternative nested tunnelling method outlined above:
-//host2.hosts = [ host3 ];ssh -q george@192.168.0.129 "echo 2>&1" && echo OK || echo NOK
-//host1.hosts = [ host2 ];
-
-//Create the new instance
-//or SSH2Shell = require ('ssh2shell')
-var SSH2Shell = require ('../lib/ssh2shell'),
-    SSH = new SSH2Shell([host1,host2,host3]),
-    callback = function( sessionText ){
-          console.log ( "-----Callback session text:\n" + sessionText);
-          console.log ( "-----Callback end" );
-    }
-
-
-//Start the process
-SSH.connect(callback);
-
-

package/test/devtest.js

@@ -1,51 +0,0 @@
-var dotenv = require('dotenv').config()
-
-var host = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD,
-    tryKeyboard:  true
-  },
-  commands:           [
-    "`Test session text message: passed`",
-    "msg:console test notification: passed",
-    "ls -la"
-  ],
-  msg: {
-    send: function( message ) {
-      console.log(message);
-    }
-  },  
-  verbose: true,
-  debug: true,
-  onKeyboardInteractive: function(name, instructions, instructionsLang, prompts, finish){
-     console.log("host Event");
-     console.log(name);
-     console.log(instructions);
-     console.log(prompts);
-     var str = JSON.stringify(prompts, null, 4);
-     console.log(str);
-     finish([process.env.PASSWORD] );
-  },
-  commands: [ "ls -l" ]
-  //standardPrompt:     "abc",//">$%#"
-  /*onCommandProcessing: function( command, response, sshObj, stream ){
-   if ( response.indexOf(“Connected”) != -1 ){
-      stream.write(“\n”);
-   }
-  }*/
-
-};
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(host);
-
-SSH.on('end', function( sessionText, sshObj ){
-      this.emit('msg', "Session Text " + sessionText);
-  })
-  
-SSH.connect();

package/test/issue69.js

@@ -1,57 +0,0 @@
-var dotenv = require('dotenv').config(),
-debug = true,
-verbose = true
-
-var host1 = {
-    server: {
-            host:         process.env.HOST,
-            port:         process.env.PORT,
-            userName:     process.env.USER_NAME,
-            password:     process.env.PASSWORD
-        },
-	connectedMessage:'connected to host1',
-  debug: debug,
-  verbose: verbose
-
-};
-
-var host2 = {
-    server: {
-          host:         process.env.SERVER2_HOST,
-          port:         process.env.PORT,
-          userName:     process.env.SERVER2_USER_NAME,
-          password:     process.env.SERVER2_PASSWORD
-         
-        },
-	connectedMessage: 'connected to host2',
-  debug: debug,
-  verbose: verbose
-};
-
-var host3 = {
-    server: {
-          host:         process.env.SERVER3_HOST,
-          port:         process.env.PORT,
-          userName:     process.env.SERVER3_USER_NAME,
-          password:     process.env.SERVER3_PASSWORD
-         
-        },
-	commands: ['echo server3'],
-	connectedMessage:'connected to host3',
-  debug: debug,
-  verbose: verbose
-};
-
-host2.hosts = [host3];
-host1.hosts = [host2];
-
-var SSH2Shell = require ('../lib/ssh2shell'),
-
-SSH = new SSH2Shell(host1);
-
-var callback = function( sessionText ){
-          console.log ( "-----Callback session text:\n" + sessionText);
-          console.log ( "-----Callback end" );
-      }
-
-SSH.connect(callback);

package/test/keyboard-interactivetest.js

@@ -1,26 +0,0 @@
-var dotenv = require('dotenv').config()
-
-var host = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD,
-    tryKeyboard:  true
-  },
-  commands:           [
-    "ls -la"
-  ],
-  verbose: false,
-  debug: false,
-  onEnd: function( sessionText, sshObj ){
-    this.emit("msg", sessionText);
-  }
-};
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(host);
-
-SSH.connect();

package/test/lots of commands.js

@@ -1,87 +0,0 @@
-var dotenv = require('dotenv').config(),
-    fs = require('fs')
-
-var host = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD
-  },
-  commands:           [
-    "msg: first",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "msg: 11",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "msg: 21",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update",
-    "sudo apt-get -y update"
-  ]
-};
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(host),
-locLog = fs.createWriteStream('Lots of commands.log')
-
-SSH.pipe( locLog );
-SSH.connect();

package/test/notificationstest.js

@@ -1,36 +0,0 @@
-var dotenv = require('dotenv').config()
-
-var host = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD
-  },
-  commands: [
-    //hubot throwback
-    "msg: using msg.send",
-    "`All done!`",
-  ],
-  msg: {
-    send: function( message ) {
-      console.log(message);
-    }
-  },
-  verbose: false,
-  debug: false
-};
-  
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(host);
-
-var callback = function( sessionText ){
-  //show the full session output. This could be emailed or saved to a log file.
-  console.log("\nThis is the full session response: \n\n" + sessionText);
-}
-
-SSH.connect(callback);
-

package/test/pipe.js

@@ -1,30 +0,0 @@
-var dotenv = require('dotenv').config(),
-    fs = require('fs')
-
-var host = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD,
-  },
-  commands:           [
-    "echo host pipe"
-  ],
-   debug: false
-}
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell')
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(host),
-    callback = function( sessionText ){
-          console.log ( "-----Callback session text:\n" + sessionText);
-          console.log ( "-----Callback end" );
-      },
-    firstLog = fs.createWriteStream('first.log'),
-    secondLog = fs.createWriteStream('second.log')
-
-SSH.pipe(firstLog)  
-SSH.pipe(secondLog)
-SSH.connect(callback)

package/test/simple.js

@@ -1,26 +0,0 @@
-var dotenv = require('dotenv').config(),
-	debug = false,
-    verbose = false
-
-var host = {
-  server: {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD
-  },
-  commands: 	  ["echo basic test success"],
-  debug: debug,
-  verbose: verbose
-};
-
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(host),
-    callback = function( sessionText ){
-          console.log ( "-----Callback session text:\n" + sessionText);
-          console.log ( "-----Callback end" );
-      }
-
-SSH.connect(callback)

package/test/sshUserCommandsPosition.js

@@ -1,26 +0,0 @@
-var dotenv = require('dotenv').config()
-
-var sshObj = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD,
-  },
-  commands:           [
-    "echo ssh",
-    "ssh -V",
-    "echo ssh middle"
-  ],  
-  verbose: false,
-  debug: false
-};
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(sshObj);
-SSH.on('end', function( sessionText, sshObj ){
-      this.emit('msg', sessionText);
-  })
-SSH.connect();

package/test/sudo no pass test.js

@@ -1,40 +0,0 @@
-var dotenv = require('dotenv').config();
-
-/*
-* Used `sudo visudo` to add `[username] ALL=(ALL) NOPASSWD: ALL` on the first test
-* server to test no password required detecting normal prompt correctly to run the 
-* next command
-*/
-var sshObj = {
-  server:             {     
-    host:         process.env.SERVER2_HOST,
-    port:         process.env.PORT,
-    userName:     process.env.SERVER2_USER_NAME,
-    password:     process.env.SERVER2_PASSWORD
-  },
-  commands:           ["sudo apt-get update","sudo apt-get upgrade", "sudo apt autoremove"],
-  userPromptSent:     false,
-  debug:              true,
-  verbose:            true,
-  onCommandProcessing: function( command, response, sshObj, stream ) {
-   //Check the command and prompt exits and respond with a 'y' but only does it once
-   if (response.indexOf("[Y/n]") != -1 && !sshObj.userPromptSent) {
-     sshObj.userPromptSent = true
-     stream.write("n\n")
-   }
-  },
-  onCommandComplete:   function( command, response, sshObj ) {
-    if(sshObj.userPromptSent){
-      sshObj.userPromptSent = false;
-    }
-  }
-}
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(sshObj);
-var callback = function(sessionText, sshObj) {
-		console.log(`Session End: ` + sessionText);
-	}
-SSH.connect(callback);

package/test/sudosutest.js

@@ -1,77 +0,0 @@
-var dotenv = require('dotenv').config();
-
-/*
-* Used `sudo visudo` to add `[username] ALL=(ALL) NOPASSWD: ALL` on the first test
-* server to test no password required detecting normal prompt correctly to run the 
-* next command
-*/
-var sshObj = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD
-  },
-  commands:           [
-    "msg:Showing current directory",
-    "echo \$(pwd)",
-    "ls -al",
-    "sudo -i",
-    "msg:Showing root home directory",
-    "cd \~",
-    "echo \$(pwd)",
-    "ls -al",
-    "msg:exiting root",
-    "exit",
-    "msg:Changing to " + process.env.secondaryUser + " via su [username]",
-    "su " + process.env.secondaryUser,
-    "msg:Showing user home directory",
-    "cd \~",
-    "echo \$(pwd)",
-    "ls -al",
-    "msg:exiting user ",
-    "exit",
-    "msg:Changing user via sudo -u [username] -i",
-    "sudo -u " + process.env.USER_NAME + " -i",
-    "msg:Showing user directory",
-    "cd \~",
-    "echo \$(pwd)",
-    "ls -la"
-  ],
-  msg: {
-    send: function( message ) {
-      console.log(message);
-    }
-  },
-  debug:              false,
-  verbose:            false,
-  suPassSent:         false, //used by commandProcessing to only send password once
-  rootPassSent:       false,
-  onCommandProcessing: function( command, response, sshObj, stream ) {
-    //console.log("command processing:\ncommand: " + command + ", response: " + response + ", password sent: " + sshObj.rootPassSent + ", password: " + process.env.rootPassword);
-
-    if (command === "su " + process.env.secondaryUser && response.indexOf("Password: ") != -1 && sshObj.suPassSent != true) {
-      sshObj.commands.unshift("msg:Using secondary user password");
-      //this is required to stop "bounce" without this the password would be sent multiple times
-      sshObj.suPassSent = true;
-      stream.write(process.env.secondUserPassword + "\n");
-    }/* else if (command == "sudo -i" && response.match(/:\s$/i) && sshObj.rootPassSent != true) {
-      sshObj.commands.unshift("msg:Using root user password");
-      //this is required to stop "bounce" without this the password would be sent multiple times
-      sshObj.rootPassSent = true;
-      stream.write(process.env.PASSWORD + "\n");
-    }*/
-  },
-  onEnd: function ( sessionText, sshObj ) {
-    if(this.sshObj.debug){this.emit("msg", sshObj.server.host + ": host.onEnd")};
-    //show the full session output. This could be emailed or saved to a log file.
-    this.emit("msg", "\nThis is the full session responses:\n" + sessionText);
-  }
-};
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell');
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(sshObj);
-  
-SSH.connect();

package/test/timeouttest.js

@@ -1,97 +0,0 @@
-//Every data response from the server resets the command timeout timer
-//So if you use stream.write() to send something to the server from within the timeout function
-//and the server responds then the timer is reset and the normal process starts again
-//If you are using the host.onCommandTimeout to send something to the host and it doesn't
-//respond then the script will hang. there is no way to reset the timeout timer.
-//If you set the host onCommandTimeout to do nothing an attach commandTimeout to the instance
-//you will be able to tigger a new timeout timer by using 
-/*
-self.sshObj.idleTimer = setTimeout(function(){
-         self.emit('commandTimeout', command, response, stream, connection )
-     }, self._idleTime)
-*/
-//commandTimeout is actually a `didn't detect a defined prompt` timeout
-
-var dotenv = require('dotenv').config(),
-debug=false,
-verbose=false
-
-var conParamsHost2 = {
-  host:         process.env.SERVER2_HOST,
-  port:         process.env.PORT,
-  userName:     process.env.SERVER2_USER_NAME,
-  password:     process.env.SERVER2_PASSWORD
- }
-
-//Host objects:
-var host1 = {
-  server:       conParamsHost2,
-  commands:     [ "echo host" ],
-  connectedMessage: "Connected to host",
-  debug: true,
-  verbose: verbose
-},
-host = {
-  server:             {     
-    host:         process.env.HOST,
-    port:         process.env.PORT,
-    userName:     process.env.USER_NAME,
-    password:     process.env.PASSWORD
-  },
-  commands:           [
-    "msg:Testing idle time out",
-	"read -n 1 -p \"First prompt to put valid input (Y,n): \" test",
-    "read -n 1 -p \"Final unhandled time out: \" test",
-  ],
-  //can't use # and > because prompt detection triggers in the wrong place
-  standardPrompt:     "$",
-  verbose:            verbose,
-  debug:              debug,
-  idleTimeOut:        1000,
-  FirstPass:		  false,
-  SecondPass:         false,
-  onCommandTimeout: function( command, response, stream, connection ){
-   //this.emit("msg", "response: [[" + response + " ]]")
-   if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": host.onCommandTimeout")}
-
-   var errorMessage, errorSource
-   //this.emit("msg", this.sshObj.server.host +  ": fp:" +this.sshObj.FirstPass)
-   
-   if (response.indexOf("(Y,n)") != -1 && this.sshObj.FirstPass != true){
-         if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": First prompt using correct input: Sending 'y' to the `(y,n):` prompt")}
-         this.sshObj.sessionText += response + this.sshObj.enter
-         this._buffer = ""
-         this.sshObj.FirstPass = true
-         
-         stream.write("y" + this.sshObj.enter)
-         return
-         
-   }
-
-   if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + "Final timeout: All attempts completed")}
-   if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": Timeout details:" + this.sshObj.enter + "Command: " + command + " " + this.sshObj.enter + "Response: " + response)}
-   
-   //everything failed so update sessionText and raise an error event that closes the connection   
-   if(!errorMessage){errorMessage = "Command"}
-   if(!errorSource){errorSource = "Command Timeout"}   
-   //this.emit("msg", this.sshObj.server.host + ": " + errorMessage + " timed out after " + (this.idleTime / 1000) + " seconds", errorSource, true) 
-   //this.emit("end", response, this.sshObj)
-   this.sshObj.sessionText += response + this.sshObj.enter
-   this.close()
-  },
-  
-  onEnd: function( sessionText, sshObj ) {
-    if(this.sshObj.debug){this.emit("msg", sshObj.server.host + ": host.onEnd")}
-    //show the full session output. self could be emailed or saved to a log file.
-    this.emit("msg", "\nThis is the full session response:\n\n" + this.sshObj.sessionText + "\n")
-    //this.close()
-  }
-}
-//host1.hosts=[host]
-//until npm published use the cloned dir path.
-var SSH2Shell = require ('../lib/ssh2shell')
-
-//run the commands in the shell session
-var SSH = new SSH2Shell(host)
-  
-SSH.connect()