Function execute

triage/utils/new_process.py:69–116

Execute |command| and return the returncode and the output

(  # pylint: disable=too-many-locals,too-many-branches
        command: List[str],
        *args,
        expect_zero: bool = True,
        timeout: int = None,
        write_to_stdout=False,
        # If not set, will default to PIPE.
        output_file=None,
        # Not True by default because we can't always set group on processes.
        kill_children: bool = False,
        **kwargs)

def execute(  # pylint: disable=too-many-locals,too-many-branches
        command: List[str],
        *args,
        expect_zero: bool = True,
        timeout: int = None,
        write_to_stdout=False,
        # If not set, will default to PIPE.
        output_file=None,
        # Not True by default because we can't always set group on processes.
        kill_children: bool = False,
        **kwargs) -> ProcessResult:
    """Execute |command| and return the returncode and the output"""
    if write_to_stdout:
        # Don't set stdout, it's default value None, causes it to be set to
        # stdout.
        assert output_file is None
    elif not output_file:
        output_file = subprocess.PIPE

    kwargs['stdout'] = subprocess.PIPE
    kwargs['stderr'] = subprocess.PIPE
    if kill_children:
        kwargs['preexec_fn'] = os.setsid

    process = subprocess.Popen(command, shell=False, *args, **kwargs)
    process_group_id = os.getpgid(process.pid)

    wrapped_process = WrappedPopen(process)
    if timeout is not None:
        kill_thread = _start_kill_thread(wrapped_process, kill_children,
                                         timeout)
    _, err = process.communicate()

    if timeout is not None:
        kill_thread.cancel()
    elif kill_children:
        # elif because the kill_thread will kill children if needed.
        _kill_process_group(process_group_id)

    retcode = process.returncode

    if err is not None:
      err = err.decode('utf-8', errors='ignore')

    if expect_zero and retcode != 0 and not wrapped_process.timed_out:
        raise subprocess.CalledProcessError(retcode, command)

    return ProcessResult(retcode, err, wrapped_process.timed_out)