Function run

lib/python/utils.py:171–199

Execute the given command. Raises error if command returns non-zero code. cmd: command to run. cmdArgs: arguments of the command. Can be a single string containing all args or multiple strings comma separated (one arg each). stdin: stdin to pass the command during runtime. Useful to

(cmd, *cmdArgs, stdin=None, cstdout=False, cstderr=False, cwd=None, env=None, ignoreFail=False, dryrun=False)

    print(msg)

def run(cmd, *cmdArgs, stdin=None, cstdout=False, cstderr=False, cwd=None, env=None, ignoreFail=False, dryrun=False):
    """
    Execute the given command. Raises error if command returns non-zero code.
    cmd: command to run.
    cmdArgs: arguments of the command. Can be a single string containing all args or multiple strings comma separated (one arg each).
    stdin: stdin to pass the command during runtime. Useful to pipe the output of one command to another.
    cstdout: set to True to capture stdout of the cmd. If set to False, stdout is printed to console.
    cstderr: set to True to capture stderr of the cmd. If set to False, stderr is printed to console.
    cwd: change working directory to this path during runtime.
    env: dictionary containing environment variables to pass during runtime.
    ignoreFail: if True, do not raise an exception if the cmd fails.
    return: success, stdout, stderr. stdout and stderr are only populated if cstdout and cstderr are True.
    dryrun: print the command without running it
    """
    runcmd = f'{cmd} {" ".join(cmdArgs)}'
    stde_pipe = subprocess.PIPE if cstderr else None
    stdo_pipe = subprocess.PIPE if cstdout else None
    log.debug(f'Running: "{runcmd}"' + (f' in CWD="{os.path.abspath(cwd)}"' if cwd else ''))
    if dryrun:
        print(runcmd)
    else:
        try:
            _r = subprocess.run(shlex.split(runcmd), stdout=stdo_pipe, stderr=stde_pipe,
                                check=True, input=stdin, cwd=cwd, env=env)
            return _r.returncode == 0, _r.stdout, _r.stderr
        except Exception as e:
            if ignoreFail:
                return False, None, None
            raise(e)

def run_condfail(cmd, *cmdArgs, stdin=None, cstdout=False, cstderr=False, cwd=None, env=None, ignoreFail=False):
    """Wrapper function for run() that ignores failures if selected."""