Merge pull request #312 from crytic/dev-auto-clean

Auto-clean projects before compiling

Author: montyly

crytic_compile/crytic_compile.py

@@ -525,6 +525,8 @@ def _compile(self, **kwargs: str) -> None:
             self._run_custom_build(custom_build)
 
         else:
+            if not kwargs.get("skip_clean", False) and not kwargs.get("ignore_compile", False):
+                self._platform.clean(**kwargs)
             self._platform.compile(self, **kwargs)
 
         remove_metadata = kwargs.get("compile_remove_metadata", False)

crytic_compile/cryticparser/cryticparser.py

@@ -50,6 +50,14 @@ def init(parser: ArgumentParser) -> None:
         default=DEFAULTS_FLAG_IN_CONFIG["ignore_compile"],
     )
 
+    group_compile.add_argument(
+        "--skip-clean",
+        help="Do not attempt to clean before compiling with a platform",
+        action="store_true",
+        dest="skip_clean",
+        default=DEFAULTS_FLAG_IN_CONFIG["skip_clean"],
+    )
+
     _init_solc(parser)
     _init_truffle(parser)
     _init_embark(parser)

crytic_compile/cryticparser/defaults.py

@@ -36,6 +36,7 @@
     "waffle_config_file": None,
     "npx_disable": False,
     "ignore_compile": False,
+    "skip_clean": False,
     "buidler_ignore_compile": False,
     "buidler_cache_directory": "cache",
     "buidler_skip_directory_name_fix": False,

crytic_compile/platform/abstract_platform.py

@@ -119,6 +119,15 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
         """
         return
 
+    @abc.abstractmethod
+    def clean(self, **kwargs: str) -> None:
+        """Clean compilation artifacts
+
+        Args:
+            **kwargs: optional arguments.
+        """
+        return
+
     @staticmethod
     @abc.abstractmethod
     def is_supported(target: str, **kwargs: str) -> bool:

crytic_compile/platform/archive.py

@@ -71,7 +71,7 @@ def compile(self, crytic_compile: "CryticCompile", **_kwargs: str) -> None:
         """Run the compilation
 
         Args:
-            crytic_compile (CryticCompile): asscoiated CryticCompile object
+            crytic_compile (CryticCompile): associated CryticCompile object
             **_kwargs: unused
         """
         # pylint: disable=import-outside-toplevel
@@ -97,6 +97,9 @@ def compile(self, crytic_compile: "CryticCompile", **_kwargs: str) -> None:
 
         crytic_compile.src_content = loaded_json["source_content"]
 
+    def clean(self, **_kwargs: str) -> None:
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is an archive

crytic_compile/platform/brownie.py

@@ -82,6 +82,10 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
 
         _iterate_over_files(crytic_compile, Path(self._target), filenames)
 
+    def clean(self, **_kwargs: str) -> None:
+        # brownie does not offer a way to clean a project
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a brownie project

crytic_compile/platform/buidler.py

@@ -171,6 +171,10 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
                     source_unit = compilation_unit.create_source_unit(path)
                     source_unit.ast = info["ast"]
 
+    def clean(self, **kwargs: str) -> None:
+        # TODO: call "buldler clean"?
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a buidler project

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
@@ -118,6 +119,21 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
             compiler="solc", version=version, optimized=optimized
         )
 
+    def clean(self, **kwargs: str) -> None:
+        """Clean compilation artifacts
+
+        Args:
+            **kwargs: optional arguments.
+        """
+
+        dapp_ignore_compile = kwargs.get("dapp_ignore_compile", False) or kwargs.get(
+            "ignore_compile", False
+        )
+        if dapp_ignore_compile:
+            return
+
+        run(["dapp", "clean"], cwd=self._target)
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a dapp project

crytic_compile/platform/embark.py

@@ -167,6 +167,14 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
                 natspec = Natspec(userdoc, devdoc)
                 source_unit.natspec[contract_name] = natspec
 
+    def clean(self, **_kwargs: str) -> None:
+        """Clean compilation artifacts
+
+        Args:
+            **_kwargs: unused.
+        """
+        return
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is an embark project

crytic_compile/platform/etherlime.py

@@ -159,6 +159,10 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: Any) -> None:
             compiler=compiler, version=version, optimized=_is_optimized(compile_arguments)
         )
 
+    def clean(self, **_kwargs: str) -> None:
+        # TODO: research if there's a way to clean artifacts
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is an etherlime project