Save output streams.
This commit is contained in:
Steven Armstrong
Darko Poljak
parent
13a13eee03
commit
00cd5fa91e
19 changed files with 450 additions and 110 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# 2011 Steven Armstrong (steven-cdist at armstrong.cc)
|
||||
# 2011-2017 Steven Armstrong (steven-cdist at armstrong.cc)
|
||||
# 2011-2015 Nico Schottelius (nico-cdist at schottelius.org)
|
||||
# 2016-2017 Darko Poljak (darko.poljak at gmail.com)
|
||||
#
|
||||
|
|
@ -120,9 +120,11 @@ class Local(object):
|
|||
"explorer")
|
||||
self.object_path = os.path.join(self.base_path, "object")
|
||||
self.messages_path = os.path.join(self.base_path, "messages")
|
||||
self.files_path = os.path.join(self.conf_path, "files")
|
||||
self.stdout_base_path = os.path.join(self.base_path, "stdout")
|
||||
self.stderr_base_path = os.path.join(self.base_path, "stderr")
|
||||
|
||||
# Depending on conf_path
|
||||
self.files_path = os.path.join(self.conf_path, "files")
|
||||
self.global_explorer_path = os.path.join(self.conf_path, "explorer")
|
||||
self.manifest_path = os.path.join(self.conf_path, "manifest")
|
||||
self.initial_manifest = (self.custom_initial_manifest or
|
||||
|
|
@ -165,6 +167,8 @@ class Local(object):
|
|||
self.mkdir(self.object_path)
|
||||
self.mkdir(self.bin_path)
|
||||
self.mkdir(self.cache_path)
|
||||
self.mkdir(self.stdout_base_path)
|
||||
self.mkdir(self.stderr_base_path)
|
||||
|
||||
def create_files_dirs(self):
|
||||
self._init_directories()
|
||||
|
|
@ -199,8 +203,24 @@ class Local(object):
|
|||
self.log.trace("Local mkdir: %s", path)
|
||||
os.makedirs(path, exist_ok=True)
|
||||
|
||||
def _get_std_fd(self, which):
|
||||
if which == 'stdout':
|
||||
base = self.stdout_base_path
|
||||
else:
|
||||
base = self.stderr_base_path
|
||||
|
||||
path = os.path.join(base, 'remote')
|
||||
stdfd = open(path, 'ba+')
|
||||
return stdfd
|
||||
|
||||
def _log_std_fd(self, stdfd, which, quiet, save_output):
|
||||
if not quiet and save_output and stdfd is not None:
|
||||
stdfd.seek(0, 0)
|
||||
self.log.trace("Local {}:\n{}\n".format(
|
||||
which, stdfd.read().decode()))
|
||||
|
||||
def run(self, command, env=None, return_output=False, message_prefix=None,
|
||||
save_output=True, quiet_mode=False):
|
||||
stdout=None, stderr=None, save_output=True, quiet_mode=False):
|
||||
"""Run the given command with the given environment.
|
||||
Return the output as a string.
|
||||
|
||||
|
|
@ -208,6 +228,17 @@ class Local(object):
|
|||
assert isinstance(command, (list, tuple)), (
|
||||
"list or tuple argument expected, got: %s" % command)
|
||||
|
||||
quiet = self.quiet_mode or quiet_mode
|
||||
|
||||
close_stdout = False
|
||||
close_stderr = False
|
||||
if not quiet and save_output and not return_output and stdout is None:
|
||||
stdout = self._get_std_fd('stdout')
|
||||
close_stdout = True
|
||||
if not quiet and save_output and stderr is None:
|
||||
stderr = self._get_std_fd('stderr')
|
||||
close_stderr = True
|
||||
|
||||
if env is None:
|
||||
env = os.environ.copy()
|
||||
# Export __target_host, __target_hostname, __target_fqdn
|
||||
|
|
@ -225,29 +256,20 @@ class Local(object):
|
|||
|
||||
self.log.trace("Local run: %s", command)
|
||||
try:
|
||||
if self.quiet_mode or quiet_mode:
|
||||
if quiet:
|
||||
stderr = subprocess.DEVNULL
|
||||
else:
|
||||
stderr = None
|
||||
if save_output:
|
||||
output, errout = exec_util.call_get_output(
|
||||
if return_output:
|
||||
output = subprocess.check_output(
|
||||
command, env=env, stderr=stderr)
|
||||
self.log.trace("Command: {}; local stdout: {}".format(
|
||||
command, output))
|
||||
# Currently, stderr is not captured.
|
||||
# self.log.trace("Local stderr: {}".format(errout))
|
||||
if return_output:
|
||||
return output.decode()
|
||||
self._log_std_fd(stderr, 'stderr', quiet, save_output)
|
||||
return output.decode()
|
||||
else:
|
||||
# In some cases no output is saved.
|
||||
# This is used for shell command, stdout and stderr
|
||||
# must not be catched.
|
||||
if self.quiet_mode or quiet_mode:
|
||||
if quiet:
|
||||
stdout = subprocess.DEVNULL
|
||||
else:
|
||||
stdout = None
|
||||
subprocess.check_call(command, env=env, stderr=stderr,
|
||||
stdout=stdout)
|
||||
self._log_std_fd(stderr, 'stderr', quiet, save_output)
|
||||
self._log_std_fd(stdout, 'stdout', quiet, save_output)
|
||||
except subprocess.CalledProcessError as e:
|
||||
exec_util.handle_called_process_error(e, command)
|
||||
except OSError as error:
|
||||
|
|
@ -255,9 +277,13 @@ class Local(object):
|
|||
finally:
|
||||
if message_prefix:
|
||||
message.merge_messages()
|
||||
if close_stdout:
|
||||
stdout.close()
|
||||
if close_stderr:
|
||||
stderr.close()
|
||||
|
||||
def run_script(self, script, env=None, return_output=False,
|
||||
message_prefix=None, save_output=True):
|
||||
message_prefix=None, stdout=None, stderr=None):
|
||||
"""Run the given script with the given environment.
|
||||
Return the output as a string.
|
||||
|
||||
|
|
@ -271,8 +297,9 @@ class Local(object):
|
|||
script, " ".join(command))
|
||||
command.append(script)
|
||||
|
||||
return self.run(command=command, env=env, return_output=return_output,
|
||||
message_prefix=message_prefix, save_output=save_output)
|
||||
return self.run(command, env=env, return_output=return_output,
|
||||
message_prefix=message_prefix, stdout=stdout,
|
||||
stderr=stderr)
|
||||
|
||||
def _cache_subpath_repl(self, matchobj):
|
||||
if matchobj.group(2) == '%P':
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# 2011 Steven Armstrong (steven-cdist at armstrong.cc)
|
||||
# 2011-2017 Steven Armstrong (steven-cdist at armstrong.cc)
|
||||
# 2011-2013 Nico Schottelius (nico-cdist at schottelius.org)
|
||||
#
|
||||
# This file is part of cdist.
|
||||
|
|
@ -63,7 +63,9 @@ class Remote(object):
|
|||
base_path=None,
|
||||
quiet_mode=None,
|
||||
archiving_mode=None,
|
||||
configuration=None):
|
||||
configuration=None,
|
||||
stdout_base_path=None,
|
||||
stderr_base_path=None):
|
||||
self.target_host = target_host
|
||||
self._exec = remote_exec
|
||||
self._copy = remote_copy
|
||||
|
|
@ -79,6 +81,9 @@ class Remote(object):
|
|||
else:
|
||||
self.configuration = {}
|
||||
|
||||
self.stdout_base_path = stdout_base_path
|
||||
self.stderr_base_path = stderr_base_path
|
||||
|
||||
self.conf_path = os.path.join(self.base_path, "conf")
|
||||
self.object_path = os.path.join(self.base_path, "object")
|
||||
|
||||
|
|
@ -105,7 +110,7 @@ class Remote(object):
|
|||
self._open_logger()
|
||||
|
||||
def _init_env(self):
|
||||
"""Setup environment for scripts - HERE????"""
|
||||
"""Setup environment for scripts."""
|
||||
# FIXME: better do so in exec functions that require it!
|
||||
os.environ['__remote_copy'] = self._copy
|
||||
os.environ['__remote_exec'] = self._exec
|
||||
|
|
@ -237,7 +242,8 @@ class Remote(object):
|
|||
self.log.trace(("Multiprocessing for parallel transfer "
|
||||
"finished"))
|
||||
|
||||
def run_script(self, script, env=None, return_output=False):
|
||||
def run_script(self, script, env=None, return_output=False, stdout=None,
|
||||
stderr=None):
|
||||
"""Run the given script with the given environment on the remote side.
|
||||
Return the output as a string.
|
||||
|
||||
|
|
@ -249,9 +255,11 @@ class Remote(object):
|
|||
]
|
||||
command.append(script)
|
||||
|
||||
return self.run(command, env, return_output)
|
||||
return self.run(command, env=env, return_output=return_output,
|
||||
stdout=stdout, stderr=stderr)
|
||||
|
||||
def run(self, command, env=None, return_output=False):
|
||||
def run(self, command, env=None, return_output=False, stdout=None,
|
||||
stderr=None):
|
||||
"""Run the given command with the given environment on the remote side.
|
||||
Return the output as a string.
|
||||
|
||||
|
|
@ -284,9 +292,27 @@ class Remote(object):
|
|||
cmd.append(string_cmd)
|
||||
else:
|
||||
cmd.extend(command)
|
||||
return self._run_command(cmd, env=env, return_output=return_output)
|
||||
return self._run_command(cmd, env=env, return_output=return_output,
|
||||
stdout=stdout, stderr=stderr)
|
||||
|
||||
def _run_command(self, command, env=None, return_output=False):
|
||||
def _get_std_fd(self, which):
|
||||
if which == 'stdout':
|
||||
base = self.stdout_base_path
|
||||
else:
|
||||
base = self.stderr_base_path
|
||||
|
||||
path = os.path.join(base, 'remote')
|
||||
stdfd = open(path, 'ba+')
|
||||
return stdfd
|
||||
|
||||
def _log_std_fd(self, stdfd, which):
|
||||
if stdfd is not None and stdfd != subprocess.DEVNULL:
|
||||
stdfd.seek(0, 0)
|
||||
self.log.trace("Remote {}: {}".format(
|
||||
which, stdfd.read().decode()))
|
||||
|
||||
def _run_command(self, command, env=None, return_output=False, stdout=None,
|
||||
stderr=None):
|
||||
"""Run the given command with the given environment.
|
||||
Return the output as a string.
|
||||
|
||||
|
|
@ -294,6 +320,18 @@ class Remote(object):
|
|||
assert isinstance(command, (list, tuple)), (
|
||||
"list or tuple argument expected, got: %s" % command)
|
||||
|
||||
if return_output and stdout is not subprocess.PIPE:
|
||||
self.log.debug("return_output is True, ignoring stdout")
|
||||
|
||||
close_stdout = False
|
||||
close_stderr = False
|
||||
if not return_output and stdout is None:
|
||||
stdout = self._get_std_fd('stdout')
|
||||
close_stdout = True
|
||||
if stderr is None:
|
||||
stderr = self._get_std_fd('stderr')
|
||||
close_stderr = True
|
||||
|
||||
# export target_host, target_hostname, target_fqdn
|
||||
# for use in __remote_{exec,copy} scripts
|
||||
os_environ = os.environ.copy()
|
||||
|
|
@ -305,19 +343,24 @@ class Remote(object):
|
|||
try:
|
||||
if self.quiet_mode:
|
||||
stderr = subprocess.DEVNULL
|
||||
else:
|
||||
stderr = None
|
||||
output, errout = exec_util.call_get_output(
|
||||
command, env=os_environ, stderr=stderr)
|
||||
self.log.trace("Command: {}; remote stdout: {}".format(
|
||||
command, output))
|
||||
# Currently, stderr is not captured.
|
||||
# self.log.trace("Remote stderr: {}".format(errout))
|
||||
if return_output:
|
||||
output = subprocess.check_output(command, env=os_environ,
|
||||
stderr=stderr)
|
||||
self._log_std_fd(stderr, 'stderr')
|
||||
return output.decode()
|
||||
else:
|
||||
subprocess.check_call(command, env=os_environ, stdout=stdout,
|
||||
stderr=stderr)
|
||||
self._log_std_fd(stderr, 'stderr')
|
||||
self._log_std_fd(stdout, 'stdout')
|
||||
except subprocess.CalledProcessError as e:
|
||||
exec_util.handle_called_process_error(e, command)
|
||||
except OSError as error:
|
||||
raise cdist.Error(" ".join(command) + ": " + error.args[1])
|
||||
except UnicodeDecodeError:
|
||||
raise DecodeError(command)
|
||||
finally:
|
||||
if close_stdout:
|
||||
stdout.close()
|
||||
if close_stderr:
|
||||
stderr.close()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue