summaryrefslogtreecommitdiff
path: root/cloudinit
diff options
context:
space:
mode:
authorScott Moser <smoser@ubuntu.com>2018-01-23 18:08:14 -0700
committerChad Smith <chad.smith@canonical.com>2018-01-23 18:08:14 -0700
commit183d5785954af3a1e7603798d4a91ab126eb7bb9 (patch)
treec9ef1b49b37f15bc140ab822884b2c901d9253bc /cloudinit
parentc02a4d4c88cc2c6ec9f03ddf86703f5b67e04348 (diff)
downloadvyos-cloud-init-183d5785954af3a1e7603798d4a91ab126eb7bb9.tar.gz
vyos-cloud-init-183d5785954af3a1e7603798d4a91ab126eb7bb9.zip
subp: make ProcessExecutionError have expected types in stderr, stdout.
When subp raised a ProcessExecutionError, that exception's stderr and stdout might end up being the string '-' rather than bytes. This mean that:    try:        subp(mycommand, decode=False)    except ProcessExecutionError as e:        pass Would have 'e.stdout' set to '-' while the caller would expect bytes. Also reduce the try/except block in subp to a specifically the two lines that may raise an OSError.
Diffstat (limited to 'cloudinit')
-rw-r--r--cloudinit/util.py94
1 files changed, 51 insertions, 43 deletions
diff --git a/cloudinit/util.py b/cloudinit/util.py
index e42498d9..df0aa5db 100644
--- a/cloudinit/util.py
+++ b/cloudinit/util.py
@@ -253,12 +253,18 @@ class ProcessExecutionError(IOError):
self.exit_code = exit_code
if not stderr:
- self.stderr = self.empty_attr
+ if stderr is None:
+ self.stderr = self.empty_attr
+ else:
+ self.stderr = stderr
else:
self.stderr = self._indent_text(stderr)
if not stdout:
- self.stdout = self.empty_attr
+ if stdout is None:
+ self.stdout = self.empty_attr
+ else:
+ self.stdout = stdout
else:
self.stdout = self._indent_text(stdout)
@@ -1829,58 +1835,60 @@ def subp(args, data=None, rcs=None, env=None, capture=True, shell=False,
env = env.copy()
env.update(update_env)
- try:
- if target_path(target) != "/":
- args = ['chroot', target] + list(args)
+ if target_path(target) != "/":
+ args = ['chroot', target] + list(args)
- if not logstring:
- LOG.debug(("Running command %s with allowed return codes %s"
- " (shell=%s, capture=%s)"), args, rcs, shell, capture)
- else:
- LOG.debug(("Running hidden command to protect sensitive "
- "input/output logstring: %s"), logstring)
-
- stdin = None
- stdout = None
- stderr = None
- if capture:
- stdout = subprocess.PIPE
- stderr = subprocess.PIPE
- if data is None:
- # using devnull assures any reads get null, rather
- # than possibly waiting on input.
- devnull_fp = open(os.devnull)
- stdin = devnull_fp
- else:
- stdin = subprocess.PIPE
- if not isinstance(data, bytes):
- data = data.encode()
+ if not logstring:
+ LOG.debug(("Running command %s with allowed return codes %s"
+ " (shell=%s, capture=%s)"), args, rcs, shell, capture)
+ else:
+ LOG.debug(("Running hidden command to protect sensitive "
+ "input/output logstring: %s"), logstring)
+
+ stdin = None
+ stdout = None
+ stderr = None
+ if capture:
+ stdout = subprocess.PIPE
+ stderr = subprocess.PIPE
+ if data is None:
+ # using devnull assures any reads get null, rather
+ # than possibly waiting on input.
+ devnull_fp = open(os.devnull)
+ stdin = devnull_fp
+ else:
+ stdin = subprocess.PIPE
+ if not isinstance(data, bytes):
+ data = data.encode()
+ try:
sp = subprocess.Popen(args, stdout=stdout,
stderr=stderr, stdin=stdin,
env=env, shell=shell)
(out, err) = sp.communicate(data)
-
- # Just ensure blank instead of none.
- if not out and capture:
- out = b''
- if not err and capture:
- err = b''
- if decode:
- def ldecode(data, m='utf-8'):
- if not isinstance(data, bytes):
- return data
- return data.decode(m, decode)
-
- out = ldecode(out)
- err = ldecode(err)
except OSError as e:
- raise ProcessExecutionError(cmd=args, reason=e,
- errno=e.errno)
+ raise ProcessExecutionError(
+ cmd=args, reason=e, errno=e.errno,
+ stdout="-" if decode else b"-",
+ stderr="-" if decode else b"-")
finally:
if devnull_fp:
devnull_fp.close()
+ # Just ensure blank instead of none.
+ if not out and capture:
+ out = b''
+ if not err and capture:
+ err = b''
+ if decode:
+ def ldecode(data, m='utf-8'):
+ if not isinstance(data, bytes):
+ return data
+ return data.decode(m, decode)
+
+ out = ldecode(out)
+ err = ldecode(err)
+
rc = sp.returncode
if rc not in rcs:
raise ProcessExecutionError(stdout=out, stderr=err,