def run_command(cmd, check=False, timeout=None, shell=False, log=True):
'''Run command synchronously.
This function will block until the command executes or the timeout is
reached. It essentially calls :func:`run_command_async` and waits for the
command's completion.
:arg cmd: The command to execute as a string or a sequence. See
:func:`run_command_async` for more details.
:arg check: Raise an error if the command exits with a non-zero exit code.
:arg timeout: Timeout in seconds.
:arg shell: Spawn a new shell to execute the command.
:arg log: Log the execution of the command through ReFrame's logging
facility.
:returns: A :py:class:`subprocess.CompletedProcess` object with
information about the command's outcome.
:raises reframe.core.exceptions.SpawnedProcessError: If ``check``
is :class:`True` and the command fails.
:raises reframe.core.exceptions.SpawnedProcessTimeout: If the command
times out.
'''
try:
proc = run_command_async(cmd,
shell=shell,
start_new_session=True,
log=log)
proc_stdout, proc_stderr = proc.communicate(timeout=timeout)
except subprocess.TimeoutExpired as e:
os.killpg(proc.pid, signal.SIGKILL)
raise SpawnedProcessTimeout(e.cmd, proc.stdout.read(),
proc.stderr.read(), timeout) from None
completed = subprocess.CompletedProcess(cmd,
returncode=proc.returncode,
stdout=proc_stdout,
stderr=proc_stderr)
if check and proc.returncode != 0:
raise SpawnedProcessError(completed.args, completed.stdout,
completed.stderr, completed.returncode)
return completed
def run_command(cmd, check=False, timeout=None, shell=False):
try:
proc = run_command_async(cmd, shell=shell, start_new_session=True)
proc_stdout, proc_stderr = proc.communicate(timeout=timeout)
except subprocess.TimeoutExpired as e:
os.killpg(proc.pid, signal.SIGKILL)
raise SpawnedProcessTimeout(e.cmd, proc.stdout.read(),
proc.stderr.read(), timeout) from None
completed = subprocess.CompletedProcess(args=shlex.split(cmd),
returncode=proc.returncode,
stdout=proc_stdout,
stderr=proc_stderr)
if check and proc.returncode != 0:
raise SpawnedProcessError(completed.args, completed.stdout,
completed.stderr, completed.returncode)
return completed
