Merge pull request #324 from crytic/node-module-resolution

Node module resolution

Author: montyly

.gitignore

@@ -1,6 +1,12 @@
+*.nix
+*.pyc
 .idea/
-crytic_compile.egg-info/
 __pycache__/
-*.pyc
+artifacts
 build/
-dist/
+cache
+crytic_compile.egg-info/
+dist/
+node_modules
+package-lock.json
+result

crytic_compile/utils/naming.py

@@ -59,6 +59,48 @@ def combine_filename_name(filename: str, name: str) -> str:
     return filename + ":" + name
 
 
+def _verify_filename_existence(filename: Path, cwd: Path) -> Path:
+    """
+    Check if the filename exist. If it does not, try multiple heuristics to find the right filename:
+    - Look for contracts/FILENAME
+    - Look for node_modules/FILENAME
+    - Look for node_modules/FILENAME in all the parents directories
+
+
+    Args:
+        filename (Path): filename to check
+        cwd (Path): directory
+
+    Raises:
+        InvalidCompilation: if the filename is not found
+
+    Returns:
+        Path: the filename
+    """
+
+    if filename.exists():
+        return filename
+
+    if cwd.joinpath(Path("contracts"), filename).exists():
+        filename = cwd.joinpath("contracts", filename)
+    elif cwd.joinpath(filename).exists():
+        filename = cwd.joinpath(filename)
+    # how node.js loads dependencies from node_modules:
+    # https://nodejs.org/api/modules.html#loading-from-node_modules-folders
+    elif cwd.joinpath(Path("node_modules"), filename).exists():
+        filename = cwd.joinpath("node_modules", filename)
+    else:
+        for parent in cwd.parents:
+            if parent.joinpath(Path("node_modules"), filename).exists():
+                filename = parent.joinpath(Path("node_modules"), filename)
+                break
+
+    if not filename.exists():
+        raise InvalidCompilation(f"Unknown file: {filename}")
+
+    return filename
+
+
 # pylint: disable=too-many-branches
 def convert_filename(
     used_filename: Union[str, Path],
@@ -75,9 +117,6 @@ def convert_filename(
         crytic_compile (CryticCompile): Associated CryticCompile object
         working_dir (Optional[Union[str, Path]], optional): Working directory. Defaults to None.
 
-    Raises:
-        InvalidCompilation: [description]
-
     Returns:
         Filename: Filename converted
     """
@@ -91,9 +130,9 @@ def convert_filename(
     else:
         filename = Path(filename_txt)
 
+    # cwd points to the directory to be used
     if working_dir is None:
         cwd = Path.cwd()
-        working_dir = cwd
     else:
         working_dir = Path(working_dir)
         if working_dir.is_absolute():
@@ -106,27 +145,21 @@ def convert_filename(
             filename = filename.relative_to(Path(crytic_compile.package_name))
         except ValueError:
             pass
-    if not filename.exists():
-        if cwd.joinpath(Path("node_modules"), filename).exists():
-            filename = cwd.joinpath("node_modules", filename)
-        elif cwd.joinpath(Path("contracts"), filename).exists():
-            filename = cwd.joinpath("contracts", filename)
-        elif working_dir.joinpath(filename).exists():
-            filename = working_dir.joinpath(filename)
-        else:
-            raise InvalidCompilation(f"Unknown file: {filename}")
-    elif not filename.is_absolute():
+
+    filename = _verify_filename_existence(filename, cwd)
+
+    if not filename.is_absolute():
         filename = cwd.joinpath(filename)
 
     absolute = filename
     relative = Path(os.path.relpath(filename, Path.cwd()))
 
     # Build the short path
     try:
-        if working_dir.is_absolute():
-            short = absolute.relative_to(working_dir)
+        if cwd.is_absolute():
+            short = absolute.relative_to(cwd)
         else:
-            short = relative.relative_to(working_dir)
+            short = relative.relative_to(cwd)
     except ValueError:
         short = relative
     except RuntimeError:

scripts/ci_test_hardhat.sh

@@ -1,14 +1,12 @@
 #!/usr/bin/env bash
 
-### Test hardhat integration
+echo "Testing hardhat integration of $(realpath "$(which crytic-compile)")"
 
 cd tests/hardhat || exit 255
 
 npm install
 
-crytic-compile .
-if [ $? -ne 0 ]
-then
-    echo "hardhat test failed"
-    exit 255
+if ! crytic-compile .
+then echo "Monorepo test failed" && exit 255
+else echo "Monorepo test passed" && exit 0
 fi

scripts/ci_test_monorepo.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+echo "Testing monorepo integration of $(realpath "$(which crytic-compile)")"
+
+cd tests/monorepo || exit 255
+
+npm install
+
+echo "Testing from the root of a monorepo"
+if ! crytic-compile ./contracts
+then echo "Monorepo test failed" && exit 255
+fi
+
+cd contracts || exit 255
+
+echo "Testing from within a subdir of a monorepo"
+if ! crytic-compile .
+then echo "Monorepo test failed" && exit 255
+fi
+
+echo "Monorepo test passed" && exit 0

setup.py

@@ -11,7 +11,7 @@
     description="Util to facilitate smart contracts compilation.",
     url="https://github.com/crytic/crytic-compile",
     author="Trail of Bits",
-    version="0.2.4",
+    version="0.2.5",
     packages=find_packages(),
     python_requires=">=3.8",
     install_requires=["pycryptodome>=3.4.6"],

tests/monorepo/contracts/contracts/Greeter.sol

@@ -0,0 +1,23 @@
+//SPDX-License-Identifier: Unlicense
+pragma solidity ^0.7.0;
+
+import "hardhat/console.sol";
+
+
+contract Greeter {
+  string greeting;
+
+  constructor(string memory _greeting) {
+    console.log("Deploying a Greeter with greeting:", _greeting);
+    greeting = _greeting;
+  }
+
+  function greet() public view returns (string memory) {
+    return greeting;
+  }
+
+  function setGreeting(string memory _greeting) public {
+    console.log("Changing greeting from '%s' to '%s'", greeting, _greeting);
+    greeting = _greeting;
+  }
+}

tests/monorepo/contracts/hardhat.config.js

@@ -0,0 +1,22 @@
+require("@nomiclabs/hardhat-waffle");
+
+// This is a sample Hardhat task. To learn how to create your own go to
+// https://hardhat.org/guides/create-task.html
+task("accounts", "Prints the list of accounts", async () => {
+  const accounts = await ethers.getSigners();
+
+  for (const account of accounts) {
+    console.log(account.address);
+  }
+});
+
+// You need to export an object to set up your config
+// Go to https://hardhat.org/config/ to learn more
+
+/**
+ * @type import('hardhat/config').HardhatUserConfig
+ */
+module.exports = {
+  solidity: "0.7.3",
+};
+

tests/monorepo/contracts/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "hardhat-project",
+  "devDependencies": {
+    "@nomiclabs/hardhat-ethers": "^2.0.0",
+    "@nomiclabs/hardhat-waffle": "^2.0.0",
+    "chai": "^4.2.0",
+    "ethereum-waffle": "^3.2.0",
+    "ethers": "^5.0.19",
+    "hardhat": "^2.0.2"
+  }
+}

tests/monorepo/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "monorepo",
+  "workspaces": [
+    "contracts"
+  ],
+  "private": true
+}