Merge pull request #6 from morpho-labs/refactor/mocks

QGarchery · web-flow · commit 0a78bb4a41be · 2023-01-06T12:41:47.000+01:00
Refactor: Concrete into mocks
diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -21,7 +21,7 @@ module.exports = {
     },
   },
   paths: {
-    sources: './src',
+    sources: './test-ts',
     tests: './test-ts',
   },
   etherscan: {
diff --git a/test-ts/mocks/RedBlackBinaryTreeMock.sol b/test-ts/mocks/RedBlackBinaryTreeMock.sol
@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 pragma solidity ^0.8.0;
 
-import "../RedBlackBinaryTree.sol";
+import "src/RedBlackBinaryTree.sol";
 
-contract TestRedBlackBinaryTree {
+contract RedBlackBinaryTreeMock {
     using RedBlackBinaryTree for RedBlackBinaryTree.Tree;
 
     RedBlackBinaryTree.Tree public tree;
diff --git a/test-ts/mocks/RedBlackBinaryTreeOptimizedMock.sol b/test-ts/mocks/RedBlackBinaryTreeOptimizedMock.sol
@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 pragma solidity ^0.8.0;
 
-import "../RedBlackBinaryTreeOptimized.sol";
+import "src/RedBlackBinaryTreeOptimized.sol";
 
-contract TestRedBlackBinaryTreeOptimized {
+contract RedBlackBinaryTreeOptimizedMock {
     using RedBlackBinaryTreeOptimized for RedBlackBinaryTreeOptimized.Tree;
 
     RedBlackBinaryTreeOptimized.Tree public tree;
diff --git a/test-ts/test-print-tree.ts b/test-ts/test-print-tree.ts
@@ -11,12 +11,12 @@ describe('Test RedBlackBinaryTree Library', () => {
     redBlackBinaryTree = await RedBlackBinaryTree.deploy();
     await redBlackBinaryTree.deployed();
 
-    const TestRedBlackBinaryTree = await ethers.getContractFactory('TestRedBlackBinaryTree', {
+    const RedBlackBinaryTreeMock = await ethers.getContractFactory('RedBlackBinaryTreeMock', {
       libraries: {
         RedBlackBinaryTree: redBlackBinaryTree.address,
       },
     });
-    testRedBlackBinaryTree = await TestRedBlackBinaryTree.deploy();
+    testRedBlackBinaryTree = await RedBlackBinaryTreeMock.deploy();
     await testRedBlackBinaryTree.deployed();
   });
 
diff --git a/test-ts/test-red-black-binary-tree.ts b/test-ts/test-red-black-binary-tree.ts
@@ -19,12 +19,12 @@ describe('Test RedBlackBinaryTreeOptimized Library', () => {
     const redBlackBinaryTreeOptimized = await RedBlackBinaryTreeOptimized.deploy();
     await redBlackBinaryTreeOptimized.deployed();
 
-    const TestRedBlackBinaryTreeOptimized = await ethers.getContractFactory('TestRedBlackBinaryTreeOptimized', {
+    const RedBlackBinaryTreeOptimizedMock = await ethers.getContractFactory('RedBlackBinaryTreeOptimizedMock', {
       libraries: {
         RedBlackBinaryTreeOptimized: redBlackBinaryTreeOptimized.address,
       },
     });
-    testRedBlackBinaryTreeOptimized = await TestRedBlackBinaryTreeOptimized.deploy();
+    testRedBlackBinaryTreeOptimized = await RedBlackBinaryTreeOptimizedMock.deploy();
     await testRedBlackBinaryTreeOptimized.deployed();
   });
 
diff --git a/test/TestCommonHeapOrdering.t.sol b/test/TestCommonHeapOrdering.t.sol
@@ -1,15 +1,10 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 pragma solidity ^0.8.0;
 
-import "forge-std/Test.sol";
-import "forge-std/console.sol";
-
 import "src/HeapOrdering.sol";
-import "./helpers/IConcreteHeapOrdering.sol";
-
-abstract contract TestCommonHeapOrdering is Test {
-    IConcreteHeapOrdering internal heap;
+import "./helpers/RandomHeap.sol";
 
+abstract contract TestCommonHeapOrdering is RandomHeap {
     address[] public accounts;
     uint256 public NB_ACCOUNTS = 50;
     uint256 public MAX_SORTED_USERS = 50;
@@ -31,6 +26,28 @@ abstract contract TestCommonHeapOrdering is Test {
         }
     }
 
+    // Should give elements in decreasing order if maxSortedUsers is +infinity.
+    function testFullHeapSort() public {
+        maxSortedUsers = n;
+        for (uint256 i; i < n; i++) {
+            if (ids.length == 0) insert();
+            else {
+                uint256 r = randomUint256(5);
+                if (r < 2) insert();
+                else if (r == 2) remove();
+                else if (r == 3) increase();
+                else decrease();
+            }
+        }
+
+        uint256 lastValue = type(uint256).max;
+        uint256 newValue;
+        while ((newValue = removeHead()) != 0) {
+            require(newValue <= lastValue, "Elements are not given back in a decreasing order.");
+            lastValue = newValue;
+        }
+    }
+
     function testEmpty() public {
         assertEq(heap.size(), 0);
         assertEq(heap.length(), 0);
diff --git a/test/TestHeapOrdering.t.sol b/test/TestHeapOrdering.t.sol
@@ -2,11 +2,11 @@
 pragma solidity ^0.8.0;
 
 import "./TestCommonHeapOrdering.t.sol";
-import "./helpers/ConcreteHeapOrdering.sol";
+import "./mocks/HeapOrderingMock.sol";
 
 contract TestHeapOrdering is TestCommonHeapOrdering {
     constructor() {
-        heap = new ConcreteHeapOrdering();
+        heap = new HeapOrderingMock();
     }
 
     function testComputeSizeSmall() public {
diff --git a/test/TestHeapOrderingInvariant.t.sol b/test/TestHeapOrderingInvariant.t.sol
@@ -4,9 +4,9 @@ pragma solidity ^0.8.0;
 import "forge-std/Test.sol";
 import "forge-std/console.sol";
 
-import "./helpers/ConcreteHeapOrdering.sol";
+import "./mocks/HeapOrderingMock.sol";
 
-contract Heap is ConcreteHeapOrdering {
+contract Heap is HeapOrderingMock {
     using HeapOrdering for HeapOrdering.HeapArray;
 
     uint256 public MAX_SORTED_USERS = 16;
diff --git a/test/TestThreeHeapOrdering.t.sol b/test/TestThreeHeapOrdering.t.sol
@@ -2,11 +2,11 @@
 pragma solidity ^0.8.0;
 
 import "./TestCommonHeapOrdering.t.sol";
-import "./helpers/ConcreteThreeHeapOrdering.sol";
+import "./mocks/ThreeHeapOrderingMock.sol";
 
 contract TestThreeHeapOrdering is TestCommonHeapOrdering {
     constructor() {
-        heap = new ConcreteThreeHeapOrdering();
+        heap = new ThreeHeapOrderingMock();
     }
 
     function testComputeSizeSmall() public {
diff --git a/test/TestThreeHeapOrderingInvariant.t.sol b/test/TestThreeHeapOrderingInvariant.t.sol
@@ -4,9 +4,9 @@ pragma solidity ^0.8.0;
 import "forge-std/Test.sol";
 import "forge-std/console.sol";
 
-import "./helpers/ConcreteThreeHeapOrdering.sol";
+import "./mocks/ThreeHeapOrderingMock.sol";
 
-contract Heap is ConcreteThreeHeapOrdering {
+contract Heap is ThreeHeapOrderingMock {
     using ThreeHeapOrdering for ThreeHeapOrdering.HeapArray;
 
     uint256 public MAX_SORTED_USERS = 16;
diff --git a/test/helpers/RandomHeap.sol b/test/helpers/RandomHeap.sol
@@ -2,11 +2,11 @@
 pragma solidity ^0.8.13;
 
 import "./Random.sol";
-import "./IConcreteHeapOrdering.sol";
+import "../mocks/IHeapOrderingMock.sol";
 import "forge-std/Test.sol";
 
-abstract contract TestRandomHeap is Test, Random {
-    IConcreteHeapOrdering public heap;
+abstract contract RandomHeap is Test, Random {
+    IHeapOrderingMock public heap;
 
     address[] public ids;
 
@@ -62,26 +62,4 @@ abstract contract TestRandomHeap is Test, Random {
             heap.update(head, value, 0, maxSortedUsers);
         }
     }
-
-    // Should give elements in decreasing order if maxSortedUsers is +infinity.
-    function testFullHeapSort() public {
-        maxSortedUsers = n;
-        for (uint256 i; i < n; i++) {
-            if (ids.length == 0) insert();
-            else {
-                uint256 r = randomUint256(5);
-                if (r < 2) insert();
-                else if (r == 2) remove();
-                else if (r == 3) increase();
-                else decrease();
-            }
-        }
-
-        uint256 lastValue = type(uint256).max;
-        uint256 newValue;
-        while ((newValue = removeHead()) != 0) {
-            require(newValue <= lastValue, "Elements are not given back in a decreasing order.");
-            lastValue = newValue;
-        }
-    }
 }
diff --git a/test/mocks/HeapOrderingMock.sol b/test/mocks/HeapOrderingMock.sol
@@ -2,9 +2,9 @@
 pragma solidity ^0.8.0;
 
 import "src/HeapOrdering.sol";
-import "./IConcreteHeapOrdering.sol";
+import "./IHeapOrderingMock.sol";
 
-contract ConcreteHeapOrdering is IConcreteHeapOrdering {
+contract HeapOrderingMock is IHeapOrderingMock {
     using HeapOrdering for HeapOrdering.HeapArray;
 
     HeapOrdering.HeapArray internal heap;
diff --git a/test/mocks/IHeapOrderingMock.sol b/test/mocks/IHeapOrderingMock.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 pragma solidity ^0.8.0;
 
-interface IConcreteHeapOrdering {
+interface IHeapOrderingMock {
     function update(
         address _id,
         uint256 _formerValue,
diff --git a/test/mocks/ThreeHeapOrderingMock.sol b/test/mocks/ThreeHeapOrderingMock.sol
@@ -2,9 +2,9 @@
 pragma solidity ^0.8.0;
 
 import "src/ThreeHeapOrdering.sol";
-import "./IConcreteHeapOrdering.sol";
+import "./IHeapOrderingMock.sol";
 
-contract ConcreteThreeHeapOrdering is IConcreteHeapOrdering {
+contract ThreeHeapOrderingMock is IHeapOrderingMock {
     using ThreeHeapOrdering for ThreeHeapOrdering.HeapArray;
 
     ThreeHeapOrdering.HeapArray internal heap;
