feat(ci): Scale integration tests (#82)

Resolves #72
- It is a bit more user focused approach (every test user should be
funded at nitro test node. Instantiation of the user in rust code
abstracts this process)
- Now user can deploy any contract using his private key (abstracts
`cargo stylus deploy`).
- And call methods of any other contract.
- Since user creation and contract deployment will be done per test. No
need to run tests serially anymore
- Possible to retrieve address of deployed contract + transaction with
status not succeeded will be returned as an error

#### PR Checklist
- [x] Tests
- [x] Documentation

---------

Co-authored-by: Alexander González <[email protected]>

.github/workflows/e2e-tests.yml

@@ -3,9 +3,8 @@ name: e2e-tests
 #
 # It roughly follows these steps:
 # - A local `nitro-testnode` gets spun up.
-# - Contracts get deployed to the local node.
-# - A few addresses get funded.
-# - The test suite runs.
+# - The test suite runs
+# Test contract deployments and test user funding happen per test.
 permissions:
   contents: read
 on:
@@ -53,20 +52,7 @@ jobs:
         run: RUSTFLAGS="-C link-args=-rdynamic" cargo install [email protected]
 
       - name: setup nitro node
-        run: |
-          # clone nitro test node repo
-          git clone -b stylus --recurse-submodules https://github.com/OffchainLabs/nitro-testnode.git && cd nitro-testnode
-          git checkout 1886f4b89f5c20fd5b0c2cf3d08a009ee73e45ca
-          
-          # setup nitro test node
-          ./test-node.bash --no-run --init --no-tokenbridge
-          ./test-node.bash --detach
-          
-          # TODO: remove hard coded wallets when user creation will be per test case
-          # fund Alice's wallet
-          ./test-node.bash script send-l2 --to address_0x01fA6bf4Ee48B6C95900BCcf9BEA172EF5DBd478 --ethamount 10000
-          # fund Bob's wallet
-          ./test-node.bash script send-l2 --to address_0xF4EaCDAbEf3c8f1EdE91b6f2A6840bc2E4DD3526 --ethamount 10000
+        run: ./e2e-tests/nitro-testnode.sh -d -i
 
       - name: run integration tests
         run: |

.gitignore

@@ -7,3 +7,5 @@
 docs/build/
 
 **/.DS_Store
+
+/e2e-tests/nitro-testnode

Cargo.toml

@@ -10,6 +10,8 @@ members = [
     "examples/ownable",
     "examples/access-control",
     "e2e-tests",
+    "lib/e2e",
+    "lib/e2e-proc",
 ]
 default-members = [
     "contracts",
@@ -21,6 +23,7 @@ default-members = [
     "examples/merkle-proofs",
     "examples/ownable",
     "examples/access-control",
+    "lib/e2e-proc",
 ]
 
 # Explicitly set the resolver to version 2, which is the default for packages

e2e-tests/Cargo.toml

@@ -11,7 +11,7 @@ repository.workspace = true
 tokio = { version = "1.12.0", features = ["full"] }
 ethers = "2.0"
 eyre = "0.6.8"
-async-trait = "0.1.80"
+e2e = { path = "../lib/e2e" }
 
 [lib]
 doctest = false

e2e-tests/README.md

@@ -2,49 +2,31 @@
 
 ## Run tests
 
-Deploy every contract from `./examples` directory and running integration tests.
+### Setup local nitro node
 
-### Against local nitro node
-
-Set up first a local nitro node according to
-this [guide](https://github.com/OffchainLabs/nitro-testnode/blob/release/README.md)
+Run in detached mode:
 
 ```terminal
-# setup nitro test node in detached mode
-# docker images should be shutdown manually later
-./test-node.bash --no-run --init --no-tokenbridge
-./test-node.bash --detach
-
-# fund Alice's wallet
-./test-node.bash script send-l2 --to address_0x01fA6bf4Ee48B6C95900BCcf9BEA172EF5DBd478 --ethamount 10000
-# fund Bob's wallet
-./test-node.bash script send-l2 --to address_0xF4EaCDAbEf3c8f1EdE91b6f2A6840bc2E4DD3526 --ethamount 10000
+./nitro-testnode -d
 ```
 
-Run integration testing command:
+Clean local nitro node to free system resources:
 
 ```terminal
-    ./e2e-tests/test.sh
+./nitro-testnode -down
 ```
 
-### Against stylus dev net
+### Run end-to-end tests
 
-`ALICE_PRIV_KEY` and `BOB_PRIV_KEY` should be valid funded wallets.
-`RPC_URL` should contain url of the stylus testnet.
-Run this command:
+Builds every contract with entrypoint and run tests against locally deployed nitro node:
 
 ```terminal
-    ALICE_PRIV_KEY=0x... \
-    BOB_PRIV_KEY=0x... \
-    RPC_URL=https://stylus-testnet.arbitrum.io/rpc \
-        ./e2e-tests//test.sh
+./test.sh
 ```
 
 ## Add test for the new contract
 
-Assuming that contract associated crate exists at `./examples` directory
-with the crate name `erc20-example`.
-Add ethereum contracts to `./e2e-tests/src/context` directory like:
+Add solidity abi:
 
 ```rust
 ethers::contract::abigen!(
@@ -58,15 +40,15 @@ ethers::contract::abigen!(
 );
 ```
 
-Then add wrapper type for the contract:
+Then add wrapper type for the contract and link to an example crate name:
 
 ```rust
 pub type Erc20 = Erc20Token<HttpMiddleware>;
 link_to_crate!(Erc20, "erc20-example");
 ```
 
-Tests should create new infrastructure instance like this:
+Tests should instantiate new contract like this:
 
 ```rust
-let context = E2EContext::<Erc20>::new().await?;
+let erc20 = &alice.deploys::<Erc20>().await?;
 ```

e2e-tests/build.rs

@@ -0,0 +1,30 @@
+use std::path::{Path, PathBuf};
+
+fn main() {
+    set_env("TARGET_DIR", &get_target_dir());
+    set_env("RPC_URL", "http://localhost:8547");
+    set_env(
+        "TEST_NITRO_NODE_PATH",
+        Path::new(&load_env_var("CARGO_MANIFEST_DIR"))
+            .join("nitro-testnode")
+            .to_str()
+            .expect("set env var TEST_NITRO_NODE_PATH"),
+    );
+}
+
+fn set_env(var_name: &str, value: &str) {
+    println!("cargo:rustc-env={}={}", var_name, value);
+}
+
+fn load_env_var(var_name: &str) -> String {
+    std::env::var(var_name)
+        .unwrap_or_else(|_| panic!("failed to load {} env var", var_name))
+}
+
+fn get_target_dir() -> String {
+    // should be smth like
+    // ./rust-contracts-stylus/target/debug/build/e2e-tests-b008947425bb8267/out
+    let out_dir = load_env_var("OUT_DIR");
+    let target_dir = Path::new(&out_dir).join("../../../../");
+    target_dir.to_str().expect("target dir").to_string()
+}

e2e-tests/nitro-testnode.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+MYDIR=$(realpath "$(dirname "$0")")
+cd "$MYDIR" || exit
+
+HAS_INIT=false
+HAS_DETACH=false
+
+while [[ $# -gt 0 ]]
+do
+  case "$1" in
+    -i|--init)
+      HAS_INIT=true
+      shift
+      ;;
+    -d|--detach)
+      HAS_DETACH=true
+      shift
+      ;;
+    -down|--shutdown)
+      docker container stop "$(docker container ls -q --filter name=nitro-testnode)"
+      exit 0
+      ;;
+    *)
+      echo "OPTIONS:"
+      echo "-i|--init:         clone repo and init nitro test node"
+      echo "-d|--detach:       setup nitro test node in detached mode"
+      echo "-down|--shutdown:  shutdown nitro test node docker containers"
+      exit 0
+      ;;
+  esac
+done
+
+TEST_NODE_DIR="$MYDIR/nitro-testnode"
+if [ ! -d "$TEST_NODE_DIR" ]; then
+  HAS_INIT=true
+fi
+
+if $HAS_INIT
+then
+  cd "$MYDIR" || exit
+  # clone nitro test node repo
+  git clone -b stylus --recurse-submodules https://github.com/OffchainLabs/nitro-testnode.git
+  cd ./nitro-testnode || exit
+  git checkout 1886f4b89f5c20fd5b0c2cf3d08a009ee73e45ca || exit
+
+  # setup nitro test node
+  ./test-node.bash --no-run --init --no-tokenbridge || exit
+fi
+
+
+cd "$TEST_NODE_DIR" || exit
+if $HAS_DETACH
+then
+  ./test-node.bash --detach
+else
+  ./test-node.bash
+fi

e2e-tests/src/context/erc20.rs → e2e-tests/src/abi/erc20.rs

@@ -1,6 +1,4 @@
-use ethers::prelude::*;
-
-use crate::context::*;
+use e2e::prelude::*;
 
 abigen!(
     Erc20Token,

e2e-tests/src/context/erc721.rs → e2e-tests/src/abi/erc721.rs

@@ -1,6 +1,4 @@
-use ethers::prelude::*;
-
-use crate::context::*;
+use e2e::prelude::*;
 
 abigen!(
     Erc721Token,

e2e-tests/src/abi/mod.rs

@@ -0,0 +1,2 @@
+pub mod erc20;
+pub mod erc721;