Speed up test suites with OZ and fix intermittent issues on CI (#255)

Truffle tests are taking about 30-40 minutes to complete on CI, this PR introduces the OZ test-environment lib to enhance the test suites and speed up the testing process. The tests are now taking about 3-4 minutes to complete on Github CI. Signed-off-by: Felipe Forbeck <[email protected]> Co-authored-by: David Roon <[email protected]>
openlawteam · Apr 19, 2021 · d70f4d4 · d70f4d4
1 parent 3d59e9e
commit d70f4d4
Show file tree

Hide file tree

Showing 38 changed files with 32,989 additions and 39,046 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -1,4 +1,4 @@
-name: Codecov
+name: Coverage
 
 on:
   push:
@@ -9,7 +9,7 @@ on:
       - "*"
 jobs:
   coverage:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -32,12 +32,12 @@ jobs:
         with:
           ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
 
-      - name: Install dependencies
-        if: steps.cache-node-modules.outputs.cache-hit != 'true'
-        run: npm ci
+      # - name: Install dependencies
+      #   if: steps.cache-node-modules.outputs.cache-hit != 'true'
+      #   run: npm ci
 
-      - name: Run Sol Coverage
-        run: npm run coverage
+      # - name: Run Sol Coverage
+      #   run: npm run coverage
 
-      - name: Publish to Codecov.io
-        run: bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}
+      # - name: Publish to Codecov.io
+      #   run: bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/lint.yml → .github/workflows/subgraph.yml b/.github/workflows/lint.yml → .github/workflows/subgraph.yml
@@ -1,4 +1,4 @@
-name: CI
+name: Subgraph
 
 on:
   push:
@@ -11,7 +11,7 @@ on:
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -38,9 +38,6 @@ jobs:
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
         run: npm ci
 
-      - name: Run .sol and .md linter
-        run: npm run lint
-
       - name: Run Truffle Compile
         run: npm run compile-abi
 
@@ -69,4 +66,4 @@ jobs:
 
       - name: Build subgraph
         run: npm run build
-        working-directory: subgraph
+        working-directory: subgraph
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,4 +1,4 @@
-name: CI
+name: Test
 
 on:
   push:
@@ -11,15 +11,15 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
 
       - name: Setup node
         uses: actions/setup-node@v2
         with:
-          node-version: 12.x
+          node-version: '12.22.x'
 
       - name: Cache node modules
         id: cache-node-modules
@@ -38,5 +38,11 @@ jobs:
         if: steps.cache-node-modules.outputs.cache-hit != 'true'
         run: npm ci
 
-      - name: Run tests
-        run: npm test
+      - name: Run Linter
+        run: npm run lint
+
+      - name: Compile Solidity Contracts
+        run: npm run compile
+
+      - name: Run Tests
+        run: npm test
diff --git a/.solcover.js b/.solcover.js
@@ -1,31 +1,12 @@
 module.exports = {
-  norpc: false,
-  compileCommand: "truffle compile",
-  testCommand:
-    "export ETHEREUM_RPC_PORT=8555 && truffle test --network coverage --timeout 10000",
-  skipFiles: [
-    // Skip config contracts
-    "Migration",
-    // Skip Test Contracts
-    "test/OLToken",
-    "test/PixelNFT",
-    "test/TestFairShareCalc",
-    "test/TestToken1",
-    "test/TestToken2",
-    // Skip openzeppelin contracts
-    "utils/ERC20",
-    "utils/IERC20",
-    "ERC721",
-    "IERC721",
-    "IERC721Receiver",
-    "IERC721Enumerable",
-    "IERC721Metadata",
-    "Address",
-    "Context",
-    "Counters",
-    "Strings",
-    "ERC165",
-    "IERC165",
-    "EnumerableSet",
-  ],
+  norpc: true,
+  testCommand: "npm test",
+  compileCommand: "npm run compile",
+  providerOptions: {
+    default_balance_ether: "10000000000000000000000000",
+  },
+  mocha: {
+    fgrep: "[skip-on-coverage]", // tag to skip tests
+    invert: true,
+  },
 };
diff --git a/.solhintignore b/.solhintignore
@@ -1,3 +1,3 @@
 node_modules/
-contracts/test
+contracts/test/
 contracts/Migrations.sol
diff --git a/contracts/adapters/TributeNFT.sol b/contracts/adapters/TributeNFT.sol
@@ -68,18 +68,6 @@ contract TributeNFTContract is
         revert("fallback revert");
     }
 
-    function provideTribute(
-        DaoRegistry,
-        bytes32,
-        address,
-        address,
-        uint256,
-        address,
-        uint256
-    ) external pure override {
-        revert("not supported operation");
-    }
-
     /**
      * @notice Configures the adapter for a particular DAO.
      * @notice Registers the DAO internal token SHARES with the DAO Bank.
@@ -92,6 +80,18 @@ contract TributeNFTContract is
         bank.registerPotentialNewInternalToken(SHARES);
     }
 
+    function provideTribute(
+        DaoRegistry,
+        bytes32,
+        address,
+        address,
+        uint256,
+        address,
+        uint256
+    ) external pure override {
+        revert("not supported operation");
+    }
+
     /**
      * @notice Creates a tribute proposal and escrows received token into the adapter.
      * @dev Applicant address must not be reserved.

diff --git a/contracts/guards/AdapterGuard.sol b/contracts/guards/AdapterGuard.sol
@@ -42,7 +42,7 @@ abstract contract AdapterGuard {
     }
 
     modifier reentrancyGuard(DaoRegistry dao) {
-        require(dao.lockedAt() < block.number, "reentrancy guard");
+        require(dao.lockedAt() != block.number, "reentrancy guard");
         dao.lockSession();
         _;
         dao.unlockSession();

diff --git a/docs/adapters/TributeNFT.md b/docs/adapters/TributeNFT.md
@@ -79,6 +79,21 @@ Bank Extension Access Flags: `ADD_TO_BALANCE`.
     receive() external payable
 ```
 
+### function configureDao
+
+```solidity
+    /**
+     * @notice Configures the adapter for a particular DAO.
+     * @notice Registers the DAO internal token SHARES with the DAO Bank.
+     * @dev Only adapters registered to the DAO can execute the function call (or if the DAO is in creation mode).
+     * @dev A DAO Bank extension must exist and be configured with proper access for this adapter.
+     * @param dao The DAO address.
+     */
+    function configureDao(DaoRegistry dao)
+        external
+        onlyAdapter(dao)
+```
+
 ### function provideTribute
 
 Not implemented because the adapter does not handle ERC20 tokens.
@@ -95,21 +110,6 @@ function provideTribute(
 ) external pure override
 ```
 
-### function configureDao
-
-```solidity
-    /**
-     * @notice Configures the adapter for a particular DAO.
-     * @notice Registers the DAO internal token SHARES with the DAO Bank.
-     * @dev Only adapters registered to the DAO can execute the function call (or if the DAO is in creation mode).
-     * @dev A DAO Bank extension must exist and be configured with proper access for this adapter.
-     * @param dao The DAO address.
-     */
-    function configureDao(DaoRegistry dao)
-        external
-        onlyAdapter(dao)
-```
-
 ### function provideTributeNFT
 
 ```solidity