crytic_compile.utils.subprocess

 1"""
 2Process execution helpers.
 3"""
 4import logging
 5import os
 6from pathlib import Path
 7import shutil
 8import subprocess
 9from typing import Any, Dict, List, Optional, Union
10
11LOGGER = logging.getLogger("CryticCompile")
12
13
14def run(
15    cmd: List[str],
16    cwd: Optional[Union[str, os.PathLike]] = None,
17    extra_env: Optional[Dict[str, str]] = None,
18    **kwargs: Any,
19) -> Optional[subprocess.CompletedProcess]:
20    """
21    Execute a command in a cross-platform compatible way.
22
23    Args:
24        cmd (List[str]): Command to run
25        cwd (PathLike): Working directory to run the command in
26        extra_env (Dict[str, str]): extra environment variables to define for the execution
27        **kwargs: optional arguments passed to `subprocess.run`
28
29    Returns:
30        CompletedProcess: If the execution succeeded
31        None: if there was a problem executing
32    """
33    subprocess_cwd = Path(os.getcwd() if cwd is None else cwd).resolve()
34    subprocess_env = None if extra_env is None else dict(os.environ, **extra_env)
35    subprocess_exe = shutil.which(cmd[0])
36
37    if subprocess_exe is None:
38        LOGGER.error("Cannot execute `%s`, is it installed and in PATH?", cmd[0])
39        return None
40
41    LOGGER.info(
42        "'%s' running (wd: %s)",
43        " ".join(cmd),
44        subprocess_cwd,
45    )
46
47    try:
48        return subprocess.run(
49            cmd,
50            executable=subprocess_exe,
51            cwd=subprocess_cwd,
52            env=subprocess_env,
53            check=True,
54            capture_output=True,
55            **kwargs,
56        )
57    except FileNotFoundError:
58        LOGGER.error("Could not execute `%s`, is it installed and in PATH?", cmd[0])
59    except subprocess.CalledProcessError as e:
60        LOGGER.error("'%s' returned non-zero exit code %d", cmd[0], e.returncode)
61        stdout, stderr = (
62            e.stdout.decode(errors="backslashreplace").strip(),
63            e.stderr.decode(errors="backslashreplace").strip(),
64        )
65        if stdout:
66            LOGGER.error("\nstdout: ".join(stdout.split("\n")))
67        if stderr:
68            LOGGER.error("\nstderr: ".join(stderr.split("\n")))
69    except OSError:
70        LOGGER.error("OS error executing:", exc_info=True)
71
72    return None