auto-clean: clean up dapp and hardhat implementations with a helper

Author: elopez

crytic_compile/platform/dapp.py

@@ -19,6 +19,7 @@
 from crytic_compile.platform.abstract_platform import AbstractPlatform
 from crytic_compile.platform.types import Type
 from crytic_compile.utils.naming import convert_filename, extract_name
+from crytic_compile.utils.subprocess import run
 
 # Handle cycle
 from crytic_compile.utils.natspec import Natspec
@@ -129,16 +130,7 @@ def clean(self, **kwargs: str) -> None:
         if dapp_ignore_compile:
             return
 
-        cmd = ["dapp", "clean"]
-        LOGGER.info(
-            "'%s' running",
-            " ".join(cmd),
-        )
-        subprocess.run(
-            cmd,
-            cwd=self._target,
-            executable=shutil.which(cmd[0]),
-        )
+        run(["dapp", "clean"], cwd=self._target)
 
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:

crytic_compile/platform/hardhat.py

@@ -14,6 +14,7 @@
 from crytic_compile.platform.types import Type
 from crytic_compile.utils.naming import convert_filename, extract_name
 from crytic_compile.utils.natspec import Natspec
+from crytic_compile.utils.subprocess import run
 from .abstract_platform import AbstractPlatform
 
 # Handle cycle
@@ -35,6 +36,17 @@ class Hardhat(AbstractPlatform):
     PROJECT_URL = "https://github.com/nomiclabs/hardhat"
     TYPE = Type.HARDHAT
 
+    def _settings(self, args):
+        hardhat_ignore_compile = args.get("hardhat_ignore_compile", False) or args.get(
+            "ignore_compile", False
+        )
+
+        base_cmd = ["hardhat"]
+        if not args.get("npx_disable", False):
+            base_cmd = ["npx"] + base_cmd
+
+        return hardhat_ignore_compile, base_cmd
+
     # pylint: disable=too-many-locals,too-many-statements
     def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
         """Run the compilation
@@ -48,13 +60,7 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
             InvalidCompilation: If hardhat failed to run
         """
 
-        hardhat_ignore_compile = kwargs.get("hardhat_ignore_compile", False) or kwargs.get(
-            "ignore_compile", False
-        )
-
-        base_cmd = ["hardhat"]
-        if not kwargs.get("npx_disable", False):
-            base_cmd = ["npx"] + base_cmd
+        hardhat_ignore_compile, base_cmd = self._settings(kwargs)
 
         detected_paths = self._get_hardhat_paths(base_cmd, kwargs)
 
@@ -187,20 +193,13 @@ def clean(self, **kwargs: str) -> None:
             **kwargs: optional arguments.
         """
 
-        if self._ignore_compile:
+        hardhat_ignore_compile, base_cmd = self._settings(kwargs)
+
+        if hardhat_ignore_compile:
             return
 
         for clean_cmd in [["clean"], ["clean", "--global"]]:
-            cmd = self._base_cmd + clean_cmd
-            LOGGER.info(
-                "'%s' running",
-                " ".join(cmd),
-            )
-            subprocess.run(
-                cmd,
-                cwd=self._target,
-                executable=shutil.which(cmd[0]),
-            )
+            run(base_cmd + clean_cmd, cwd=self._target)
 
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:

crytic_compile/utils/subprocess.py

@@ -0,0 +1,53 @@
+import logging
+import os
+from pathlib import Path
+import shutil
+import subprocess
+from typing import Dict, List
+
+LOGGER = logging.getLogger("CryticCompile")
+
+
+def run(
+    cmd: List[str],
+    cwd: os.PathLike | None = None,
+    extra_env: Dict[str, str] | None = None,
+    **kwargs,
+) -> subprocess.CompletedProcess | None:
+    """
+    Execute a command in a cross-platform compatible way.
+
+    Args:
+        cmd (List[str]): Command to run
+        cwd (PathLike): Working directory to run the command in
+        extra_env (Dict[str, str]): extra environment variables to define for the execution
+        **kwargs: optional arguments passed to `subprocess.run`
+
+    Returns:
+        CompletedProcess: If the execution succeeded
+        None: if there was a problem executing
+    """
+    subprocess_cwd = Path(os.getcwd() if cwd is None else cwd).resolve()
+    subprocess_env = None if extra_env is None else dict(os.environ, extra_env)
+    subprocess_exe = shutil.which(cmd[0])
+
+    if subprocess_exe is None:
+        LOGGER.error("Cannot execute `%s`, is it installed and in PATH?", cmd[0])
+        return None
+
+    LOGGER.info(
+        "'%s' running (wd: %s)",
+        " ".join(cmd),
+        subprocess_cwd,
+    )
+
+    try:
+        return subprocess.run(
+            cmd, cwd=subprocess_cwd, executable=subprocess_exe, env=subprocess_env, **kwargs
+        )
+    except FileNotFoundError:
+        LOGGER.error("Could not execute `%s`, is it installed and in PATH?", cmd[0])
+    except OSError:
+        LOGGER.error("OS error executing:", exc_info=1)
+
+    return None