Fixed shell cmd quoting - resolves #39. Added unit tests for several more special characters in cmd and running multiple shell commands in one go

Author: Dan

pssh/ssh_client.py

@@ -218,17 +218,18 @@ def exec_command(self, command, sudo=False, user=None,
         stdout, stderr = self._read_output_buffer(_stdout,), \
                          self._read_output_buffer(_stderr,
                                                   prefix='\t[err]')
-
+        for _char in ['\\', '"', '$', '`']:
+            command = command.replace(_char, '\%s' % (_char,))
         shell = '$SHELL -c' if not shell else shell
         _command = ''
         if sudo and not user:
             _command = 'sudo -S '
         elif user:
             _command = 'sudo -u %s -S ' % (user,)
         if use_shell:
-            _command += '%s \'%s\'' % (shell, command,)
+            _command += '%s "%s"' % (shell, command,)
         else:
-            _command += '\'%s\'' % (command,)
+            _command += '"%s"' % (command,)
         logger.debug("Running parsed command %s on %s", _command, self.host)
         channel.exec_command(_command, **kwargs)
         logger.debug("Command started")

tests/test_pssh_client.py

@@ -513,7 +513,7 @@ def test_identical_host_output(self):
                          msg="Host list contains %s identical hosts, only got output for %s" % (
                              len(hosts), len(output.keys())))
         del _socket1, _socket2
-
+    
     def test_connection_error_exception(self):
         """Test that we get connection error exception in output with correct arguments"""
         self.server.kill()
@@ -541,7 +541,7 @@ def test_connection_error_exception(self):
         else:
             raise Exception("Expected ConnectionErrorException")
         del _socket
-
+    
     def test_authentication_exception(self):
         """Test that we get authentication exception in output with correct arguments"""
         self.server.kill()
@@ -601,16 +601,49 @@ def test_ssh_exception(self):
             raise Exception("Expected SSHException")
         server.kill()
         del _socket
-
+    
     def test_multiple_single_quotes_in_cmd(self):
+        """Test that we can run a command with multiple single quotes"""
         output = self.client.run_command("echo 'me' 'and me'")
-        self.client.join(output)
         stdout = list(output[self.host]['stdout'])
         expected = 'me and me'
+        self.assertTrue(len(stdout)==1,
+                        msg="Got incorrect number of lines in output - %s" % (stdout,))
         self.assertTrue(output[self.host]['exit_code'] == 0,
                         msg="Error executing cmd with multiple single quotes - %s" % (
                             stdout,))
-        self.assertEqual([expected], stdout,
+        self.assertEqual(expected, stdout[0],
+                         msg="Got unexpected output. Expected %s, got %s" % (
+                             expected, stdout[0],))
+    
+    def test_backtics_in_cmd(self):
+        """Test running command with backtics in it"""
+        output = self.client.run_command("out=`ls` && echo $out")
+        self.client.join(output)
+        self.assertTrue(output[self.host]['exit_code'] == 0,
+                        msg="Error executing cmd with backtics - error code %s" % (
+                            output[self.host]['exit_code'],))
+    
+    def test_multiple_shell_commands(self):
+        """Test running multiple shell commands in one go"""
+        output = self.client.run_command("echo me; echo and; echo me")
+        stdout = list(output[self.host]['stdout'])
+        expected = ["me", "and", "me"]
+        self.assertTrue(output[self.host]['exit_code'] == 0,
+                        msg="Error executing multiple shell cmds - error code %s" % (
+                            output[self.host]['exit_code'],))
+        self.assertEqual(expected, stdout,
+                         msg="Got unexpected output. Expected %s, got %s" % (
+                             expected, stdout,))
+    
+    def test_escaped_quotes(self):
+        """Test escaped quotes in shell variable are handled correctly"""
+        output = self.client.run_command('t="--flags=\\"this\\""; echo $t')
+        stdout = list(output[self.host]['stdout'])
+        expected = ['--flags="this"']
+        self.assertTrue(output[self.host]['exit_code'] == 0,
+                        msg="Error executing multiple shell cmds - error code %s" % (
+                            output[self.host]['exit_code'],))
+        self.assertEqual(expected, stdout,
                          msg="Got unexpected output. Expected %s, got %s" % (
                              expected, stdout,))
-