Add shell option to run method

Author: Olivier Roques

README.md

@@ -44,9 +44,13 @@ ssh_controller.connect()
 return_code, output = ssh_controller.run(
     command="echo 'Hello world!' > /tmp/hello.txt",
     display=True,          # display output, false by default
-    capture_output=True,   # return output, false by default
-    combine_stderr=False,  # combine stderr and stdout, false by default
-    timeout=10,            # command timeout in seconds, 600s by default
+    capture_output=True,   # save output, false by default
+    # request a shell to run the command, true by default
+    shell=True,
+    # combine stderr into stdout when shell=False, false by default
+    combine_stderr=False,
+    # command timeout in seconds, None (wait indefinitely) by default
+    timeout=10,
 )
 print(f"return code: {return_code}, output: {output}")
 ```

examples/demo.py

@@ -27,9 +27,13 @@ def demo_key():
     return_code, output = ssh_controller.run(
         command="echo 'Hello world!' > /tmp/hello.txt",
         display=True,          # display output, false by default
-        capture_output=True,   # return output, false by default
-        combine_stderr=False,  # combine stderr and stdout, false by default
-        timeout=10,            # command timeout in seconds, 600s by default
+        capture_output=True,   # save output, false by default
+        # request a shell to run the command, true by default
+        shell=True,
+        # combine stderr into stdout when shell=False, false by default
+        combine_stderr=False,
+        # command timeout in seconds, None (wait indefinitely) by default
+        timeout=10,
     )
     logging.info(f"return code: {return_code}, output: {output}")
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="sshcontroller",
-    version="1.1",
+    version="1.2",
     author="Olivier Roques",
     author_email="[email protected]",
     description="A package to easily run SSH commands",

sshcontroller/sshcontroller.py

@@ -122,16 +122,19 @@ def __run_until_event(
         command,
         stop_event,
         display=True,
-        combine_stderr=False,
         capture_output=False,
+        shell=True,
+        combine_stderr=False,
     ):
         channel = self.transport.open_session()
         output = ""
-        timeout = 2
 
-        channel.settimeout(timeout)
+        channel.settimeout(2)
         channel.set_combine_stderr(combine_stderr)
-        channel.get_pty()
+
+        if shell:
+            channel.get_pty()
+
         channel.exec_command(command)
 
         if not display and not capture_output:
@@ -171,15 +174,19 @@ def __run_until_exit(
         command,
         timeout,
         display=True,
-        combine_stderr=False,
         capture_output=False,
+        shell=True,
+        combine_stderr=False,
     ):
         channel = self.transport.open_session()
         output = ""
 
         channel.settimeout(timeout)
         channel.set_combine_stderr(combine_stderr)
-        channel.get_pty()
+
+        if shell:
+            channel.get_pty()
+
         channel.exec_command(command)
 
         try:
@@ -214,16 +221,18 @@ def run(
         self,
         command,
         display=False,
-        combine_stderr=False,
         capture_output=False,
+        shell=True,
+        combine_stderr=False,
+        timeout=None,
         stop_event=None,
-        timeout=600,
     ):
         if stop_event:
             return self.__run_until_event(
                 command,
                 stop_event,
                 display=display,
+                shell=shell,
                 combine_stderr=combine_stderr,
                 capture_output=capture_output,
             )
@@ -232,6 +241,7 @@ def run(
                 command,
                 timeout,
                 display=display,
+                shell=shell,
                 combine_stderr=combine_stderr,
                 capture_output=capture_output,
             )
@@ -245,8 +255,11 @@ def wrapper(*args, **kwargs):
             if not self.transport.is_authenticated():
                 logging.error("SSH session is not ready")
                 return 1
+
             sftp_channel = SFTPController.from_transport(self.transport)
             r = getattr(sftp_channel, target)(*args, **kwargs)
             sftp_channel.close()
+
             return r
+
         return wrapper