Merge pull request #610 from crytic/foundry-detect-out

Auto-detect Foundry `out` directory

Author: elopez

crytic_compile/cryticparser/defaults.py

@@ -44,7 +44,7 @@
     "hardhat_cache_directory": None,
     "hardhat_artifacts_directory": None,
     "foundry_ignore_compile": False,
-    "foundry_out_directory": "out",
+    "foundry_out_directory": None,
     "foundry_compile_all": False,
     "export_dir": "crytic-export",
     "compile_libraries": None,

crytic_compile/platform/abstract_platform.py

@@ -42,6 +42,7 @@ class PlatformConfig:
     tests_path: str = "test"
     libs_path: List[str] = field(default_factory=lambda: ["lib"])
     scripts_path: str = "script"
+    out_path: str = "out"
 
 
 class AbstractPlatform(metaclass=abc.ABCMeta):

crytic_compile/platform/foundry.py

@@ -53,7 +53,7 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
             "ignore_compile", False
         )
 
-        out_directory = kwargs.get("foundry_out_directory", "out")
+        foundry_config = None
 
         if ignore_compile:
             LOGGER.info(
@@ -74,21 +74,25 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
 
             compile_all = kwargs.get("foundry_compile_all", False)
 
-            if not targeted_build and not compile_all:
-                foundry_config = self.config(self._project_root)
-                if foundry_config:
-                    compilation_command += [
-                        "--skip",
-                        f"./{foundry_config.tests_path}/**",
-                        f"./{foundry_config.scripts_path}/**",
-                        "--force",
-                    ]
+            foundry_config = self.config(self._project_root)
+
+            if not targeted_build and not compile_all and foundry_config:
+                compilation_command += [
+                    "--skip",
+                    f"./{foundry_config.tests_path}/**",
+                    f"./{foundry_config.scripts_path}/**",
+                    "--force",
+                ]
 
             run(
                 compilation_command,
                 cwd=self._project_root,
             )
 
+        out_directory_detected = foundry_config.out_path if foundry_config else "out"
+        out_directory_config = kwargs.get("foundry_out_directory", None)
+        out_directory = out_directory_config if out_directory_config else out_directory_detected
+
         build_directory = Path(
             self._project_root,
             out_directory,
@@ -195,6 +199,7 @@ def config(working_dir: Union[str, Path]) -> Optional[PlatformConfig]:
         result.tests_path = json_config.get("test")
         result.libs_path = json_config.get("libs")
         result.scripts_path = json_config.get("script")
+        result.out_path = json_config.get("out")
 
         return result
 

scripts/ci_test_foundry.sh

@@ -1,13 +1,14 @@
 #!/usr/bin/env bash
-
 ### Test foundry integration
+set -Eeuxo pipefail
 
 
-cd /tmp || exit 255
+## test 1 - same folder
 
+cd /tmp || exit 255
 mkdir forge_test
 cd forge_test || exit 255
-forge init --no-commit
+forge init
 
 crytic-compile .
 if [ $? -ne 0 ]
@@ -16,11 +17,35 @@ then
     exit 255
 fi
 
-mkdir /tmp/forge_test/test_2
-rsync -a --exclude='test_2' ./ /tmp/forge_test/test_2/
-crytic-compile ./test_2
+
+## test 2 - same folder, different out dir
+
+cd /tmp || exit 255
+mkdir forge_test2
+cd forge_test2 || exit 255
+forge init
+
+sed -i 's/^out\s*=.*$/out = "foobar"/' foundry.toml
+
+crytic-compile .
 if [ $? -ne 0 ]
 then
     echo "foundry test 2 failed"
     exit 255
-fi
+fi
+
+## test 3 - different folder
+
+cd /tmp || exit 255
+mkdir forge_test3
+cd forge_test3 || exit 255
+forge init
+
+cd /tmp || exit 255
+
+crytic-compile ./forge_test3
+if [ $? -ne 0 ]
+then
+    echo "foundry test 3 failed"
+    exit 255
+fi