openstack/kayobe
Code Issues Proposed changes

Allow utils.run_command to return command output

Browse Source
This commit is contained in:
Mark Goddard 2017-04-20 14:29:15 +01:00
parent 339c331855
commit cb7ed2f48c
2 changed files with 35 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
kayobe/tests/unit/test_utils.py
View File

@ -70,18 +70,29 @@ key2: value2
@mock.patch.object(subprocess, "check_call") @mock.patch.object(subprocess, "check_call")
def test_run_command(self, mock_call): def test_run_command(self, mock_call):
utils.run_command(["command", "to", "run"]) output = utils.run_command(["command", "to", "run"])
mock_call.assert_called_once_with(["command", "to", "run"]) mock_call.assert_called_once_with(["command", "to", "run"])
self.assertIsNone(output)
@mock.patch("kayobe.utils.open")
@mock.patch.object(subprocess, "check_call") @mock.patch.object(subprocess, "check_call")
def test_run_command_quiet(self, mock_call): def test_run_command_quiet(self, mock_call, mock_open):
utils.run_command(["command", "to", "run"], quiet=True) mock_devnull = mock_open.return_value.__enter__.return_value
output = utils.run_command(["command", "to", "run"], quiet=True)
mock_call.assert_called_once_with(["command", "to", "run"], mock_call.assert_called_once_with(["command", "to", "run"],
stdout=subprocess.PIPE, stdout=mock_devnull,
stderr=subprocess.PIPE) stderr=mock_devnull)
self.assertIsNone(output)
@mock.patch.object(subprocess, "check_call") @mock.patch.object(subprocess, "check_output")
def test_run_command_failure(self, mock_call): def test_run_command_check_output(self, mock_output):
mock_call.side_effect = subprocess.CalledProcessError(1, "command") mock_output.return_value = "command output"
output = utils.run_command(["command", "to", "run"], check_output=True)
mock_output.assert_called_once_with(["command", "to", "run"])
self.assertEqual(output, "command output")
@mock.patch.object(subprocess, "check_output")
def test_run_command_failure(self, mock_output):
mock_output.side_effect = subprocess.CalledProcessError(1, "command")
self.assertRaises(subprocess.CalledProcessError, utils.run_command, self.assertRaises(subprocess.CalledProcessError, utils.run_command,
["command", "to", "run"]) ["command", "to", "run"])

22
kayobe/utils.py
View File

@ -93,14 +93,24 @@ def is_readable_file(path):
return {"result": True} return {"result": True}
def run_command(cmd, quiet=False, **kwargs): def run_command(cmd, quiet=False, check_output=False, **kwargs):
"""Run a command, checking the output.""" """Run a command, checking the output.
if quiet:
kwargs["stdout"] = subprocess.PIPE :param quiet: Redirect output to /dev/null
kwargs["stderr"] = subprocess.PIPE :param check_output: Whether to return the output of the command
:returns: The output of the command if check_output is true
"""
if isinstance(cmd, six.string_types): if isinstance(cmd, six.string_types):
cmd_string = cmd cmd_string = cmd
else: else:
cmd_string = " ".join(cmd) cmd_string = " ".join(cmd)
LOG.debug("Running command: %s", cmd_string) LOG.debug("Running command: %s", cmd_string)
subprocess.check_call(cmd, **kwargs) if quiet:
with open("/dev/null", "w") as devnull:
kwargs["stdout"] = devnull
kwargs["stderr"] = devnull
subprocess.check_call(cmd, **kwargs)
elif check_output:
return subprocess.check_output(cmd, **kwargs)
else:
subprocess.check_call(cmd, **kwargs)