#6691 final refinements to timed_subprocess, add wait to run, shell, run_chroot, script and initial add of run_bg()

salt/modules/cmdmod.py

@@ -666,6 +666,7 @@ def run(cmd,
         ignore_retcode=False,
         saltenv='base',
         use_vt=False,
+        wait=True,
         **kwargs):
     r'''
     Execute the passed command and return the output as a string
@@ -833,7 +834,8 @@ def run(cmd,
                pillarenv=kwargs.get('pillarenv'),
                pillar_override=kwargs.get('pillar'),
                use_vt=use_vt,
-               password=kwargs.get('password', None))
+               password=kwargs.get('password', None),
+               wait=wait)
 
     log_callback = _check_cb(log_callback)
 
@@ -892,6 +894,7 @@ def shell(cmd,
         ignore_retcode=False,
         saltenv='base',
         use_vt=False,
+        wait=False,
         **kwargs):
     '''
     Execute the passed command and return the output as a string.
@@ -1052,6 +1055,7 @@ def shell(cmd,
                saltenv=saltenv,
                use_vt=use_vt,
                python_shell=python_shell,
+               wait=wait,
                **kwargs)
 
 
@@ -1845,6 +1849,7 @@ def script(source,
            __env__=None,
            saltenv='base',
            use_vt=False,
+           wait=True,
            **kwargs):
     '''
     Download a script from a remote location and execute the script locally.
@@ -2030,7 +2035,8 @@ def script(source,
                pillarenv=kwargs.get('pillarenv'),
                pillar_override=kwargs.get('pillar'),
                use_vt=use_vt,
-               password=kwargs.get('password', None))
+               password=kwargs.get('password', None),
+               wait=wait)
     _cleanup_tempfile(path)
     return ret
 
@@ -2320,6 +2326,7 @@ def run_chroot(root,
                ignore_retcode=False,
                saltenv='base',
                use_vt=False,
+               wait=True,
                **kwargs):
     '''
     .. versionadded:: 2014.7.0
@@ -2468,7 +2475,8 @@ def run_chroot(root,
                    saltenv=saltenv,
                    pillarenv=kwargs.get('pillarenv'),
                    pillar=kwargs.get('pillar'),
-                   use_vt=use_vt)
+                   use_vt=use_vt,
+                   wait=wait)
 
     # Kill processes running in the chroot
     for i in range(6):
@@ -2712,3 +2720,66 @@ def powershell(cmd,
     except Exception:
         log.error("Error converting PowerShell JSON return", exc_info=True)
         return {}
+
+
+def run_bg(cmd,
+        cwd=None,
+        runas=None,
+        shell=DEFAULT_SHELL,
+        python_shell=None,
+        env=None,
+        clean_env=False,
+        template=None,
+        rstrip=True,
+        umask=None,
+        output_loglevel='debug',
+        log_callback=None,
+        timeout=None,
+        reset_system_locale=True,
+        saltenv='base',
+        wait=True,
+        **kwargs):
+    '''
+    Dodadoc
+    :param cmd:
+    :param cwd:
+    :param runas:
+    :param shell:
+    :param env:
+    :param clean_env:
+    :param template:
+    :param rstrip:
+    :param umask:
+    :param log_callback:
+    :param quiet:
+    :param timeout:
+    :param reset_system_locale:
+    :param ignore_retcode:
+    :param saltenv:
+    :param kwargs:
+    :return:
+    '''
+
+    return run(cmd,
+               cwd=cwd,
+               stdin=None,
+               stdout=None,
+               output_loglevel=None,
+               use_vt=None,
+               wait=True,
+
+               runas=runas,
+               shell=shell,
+               env=env,
+               clean_env=clean_env,
+               template=template,
+               rstrip=rstrip,
+               umask=umask,
+               log_callback=log_callback,
+               quiet=True,
+               timeout=timeout,
+               reset_system_locale=reset_system_locale,
+               ignore_retcode=True,
+               saltenv=saltenv,
+               python_shell=python_shell,
+               **kwargs)

salt/utils/timed_subprocess.py

@@ -15,30 +15,27 @@ class TimedProc(object):
     def __init__(self, args, **kwargs):
 
         self.wait = kwargs.pop('wait', True)
+        self.stdin = kwargs.pop('stdin', None)
+        self.with_communicate = kwargs.pop('with_communicate', self.wait)
+        self.timeout = kwargs.pop('timeout', None)
 
         # If you're not willing to wait for the process
         # you can't define any stdin, stdout or stderr
         if not self.wait:
             self.stdin = kwargs['stdin'] = None
-        else:
-            self.stdin = kwargs.pop('stdin', None)
-            if self.stdin is not None:
-                # Translate a newline submitted as '\n' on the CLI to an actual
-                # newline character.
-                self.stdin = self.stdin.replace('\\n', '\n')
-                kwargs['stdin'] = subprocess.PIPE
+            self.with_communicate = False
+        elif self.stdin is not None:
+            # Translate a newline submitted as '\n' on the CLI to an actual
+            # newline character.
+            self.stdin = self.stdin.replace('\\n', '\n')
+            kwargs['stdin'] = subprocess.PIPE
 
-        self.with_communicate = kwargs.pop('with_communicate', self.wait)
         if not self.with_communicate:
             self.stdout = kwargs['stdout'] = None
             self.stderr = kwargs['stderr'] = None
 
-        if not self.wait or 'timeout' not in kwargs:
-            self.timeout = None
-        else:
-            self.timeout = kwargs.pop('timeout')
-            if self.timeout is not None and not isinstance(self.timeout, (int, float)):
-                raise salt.exceptions.TimedProcTimeoutError('Error: timeout {0} must be a number'.format(timeout))
+        if self.timeout and not isinstance(self.timeout, (int, float)):
+            raise salt.exceptions.TimedProcTimeoutError('Error: timeout {0} must be a number'.format(self.timeout))
 
         try:
             self.process = subprocess.Popen(args, **kwargs)
@@ -64,7 +61,7 @@ class TimedProc(object):
             elif self.wait:
                 self.process.wait()
 
-        if not self.wait or not self.timeout:
+        if not self.timeout:
             receive()
         else:
             rt = threading.Thread(target=receive)