Merge pull request #58 from allo-protocol/test/summary-md

chore: test doc + echidna retrocompat

package.json

@@ -11,6 +11,8 @@
     "compile": "forge compile",
     "build": "forge build",
     "test": "forge test",
+    "test:unit": "forge test --no-match-contract 'Integration'",
+    "test:integration": "forge test --match-contract 'Integration'",
     "fmt": "forge fmt contracts/**/*.sol && forge fmt test/**/*.sol",
     "lint:sol": "solhint -c .solhint.json 'contracts/**/*.sol'",
     "lint:natspec": "npx @defi-wonderland/natspec-smells --config natspec-smells.config.js",

test/SUMMARY.md

@@ -1,8 +1,18 @@
+# Tests summary.
 
+## Unit Tests
+Written using [Forge Foundry](https://getfoundry.sh/), [Smock](https://github.com/defi-wonderland/smock-foundry) and [Bulloak](https://www.bulloak.dev/),
+they cover every contracts of this repository.
 
+To run them, after installing all dependencies, generate the mocks using `[your package manager] smock` (eg `yarn mock`)
+then run the tests using `[your package manager] test:unit` (eg `yarn test`).
 
-Medusa:
-- No agent, substitued by profile owner or member
+## Integration Tests
+We cover every user story of the strategies.
+To run them, after installing depedencies, define both Optimism and Mainnet RPC URL (eg `export MAINNET_RPC_URL=https://etc`), then use `[your package manager] test:integration` (eg `yarn test:integration`).
 
-
-TODO: use trusted forwarder
+## Invariant Tests
+We assess how 8 invariants are holding against Medusa and Echidna fuzzer (see the PROPERTIES.md file
+for the complete list). To run both campaigns, use the following commands:
+- `medusa fuzz .` (this is our default tool, configuration is included in this repo)
+- `echidna --contract FuzzTest --test-mode assertion test/invariant/fuzz/FuzzTest.t.sol`

test/invariant/fuzz/Setup.t.sol

@@ -41,21 +41,29 @@ contract Setup is HandlerActors, Pools {
 
     constructor() {
         // Deploy Allo
-        vm.prank(protocolDeployer);
         address implementation = address(new Allo());
 
         // Deploy the registry
-        vm.prank(protocolDeployer);
         registry = new Registry();
 
         // Deploy the proxy, pointing to the implementation
-        TransparentUpgradeableProxy proxy = new TransparentUpgradeableProxy(implementation, proxyOwner, "");
+        TransparentUpgradeableProxy proxy = new TransparentUpgradeableProxy(
+            implementation,
+            proxyOwner,
+            ""
+        );
 
         allo = Allo(payable(address(proxy)));
 
         // Initialize
-        vm.prank(protocolDeployer);
-        allo.initialize(protocolDeployer, address(registry), payable(treasury), percentFee, baseFee, forwarder);
+        allo.initialize(
+            protocolDeployer,
+            address(registry),
+            payable(treasury),
+            percentFee,
+            baseFee,
+            forwarder
+        );
 
         // Deploy strategies implementations
         _initImplementations(address(allo));

test/invariant/fuzz/helpers/Actors.t.sol

@@ -25,9 +25,9 @@ contract Actors is Utils {
         uint256 msgValue,
         bytes memory payload
     ) public returns (bool, bytes memory) {
-        emit ActorsLog(
-            string.concat("call using anchor of ", vm.toString(address(this)))
-        );
+        //emit ActorsLog(
+        //    string.concat("call using anchor of ", vm.toString(address(this)))
+        //);
 
         vm.deal(payable(address(this)), msgValue);
 
@@ -36,7 +36,7 @@ contract Actors is Utils {
         );
 
         if (!succ) {
-            emit ActorsLog(vm.toString(ret));
+            //emit ActorsLog(vm.toString(ret));
             return (succ, ret);
         }
 
@@ -52,9 +52,9 @@ contract Actors is Utils {
         uint256 msgValue,
         bytes memory payload
     ) public returns (bool success, bytes memory returnData) {
-        emit ActorsLog(
-            string.concat("call using actor ", vm.toString(address(this)))
-        );
+        // emit ActorsLog(
+        //     string.concat("call using actor ", vm.toString(address(this)))
+        // );
 
         vm.deal(payable(address(this)), msgValue);