test(refactor): periphery tests to use Bulloak (#1025)

* test(refactor): periphery tests to use Bulloak test(tree): dont use is in tree * test(tree): remove "does" word * test(tree): use shorter form in create factory --------- Co-authored-by: andreivladbrg <andreivladbrg@gmail.com>
sablier-labs · Sep 11, 2024 · 0da540c · 0da540c
1 parent 8b974d4
commit 0da540c
Show file tree

Hide file tree

Showing 52 changed files with 259 additions and 323 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -22,7 +22,7 @@ jobs:
     uses: "sablier-labs/reusable-workflows/.github/workflows/bulloak-check.yml@main"
     with:
       skip-modifiers: true
-      tree-path: "test/core"
+      tree-path: "test"
 
   build:
     uses: "sablier-labs/reusable-workflows/.github/workflows/forge-build.yml@main"

diff --git a/test/core/integration/concrete/lockup-dynamic/token-uri/tokenURI.t.sol b/test/core/integration/concrete/lockup-dynamic/token-uri/tokenURI.t.sol
@@ -29,7 +29,7 @@ contract TokenURI_LockupDynamic_Integration_Concrete_Test is LockupDynamic_Integ
         }
     }
 
-    function test_RevertGiven_NFTDoesNotExist() external {
+    function test_RevertGiven_NFTNotExist() external {
         uint256 nullStreamId = 1729;
         vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, nullStreamId));
         lockupDynamic.tokenURI({ tokenId: nullStreamId });

diff --git a/test/core/integration/concrete/lockup-dynamic/token-uri/tokenURI.tree b/test/core/integration/concrete/lockup-dynamic/token-uri/tokenURI.tree
@@ -1,5 +1,5 @@
 TokenURI_LockupDynamic_Integration_Concrete_Test
-├── given NFT does not exist
+├── given NFT not exist
 │  └── it should revert
 └── given NFT exists
    ├── when token URI decoded

diff --git a/test/core/integration/concrete/lockup-linear/token-uri/tokenURI.t.sol b/test/core/integration/concrete/lockup-linear/token-uri/tokenURI.t.sol
@@ -29,7 +29,7 @@ contract TokenURI_LockupLinear_Integration_Concrete_Test is LockupLinear_Integra
         }
     }
 
-    function test_RevertGiven_NFTDoesNotExist() external {
+    function test_RevertGiven_NFTNotExist() external {
         uint256 nullStreamId = 1729;
         vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, nullStreamId));
         lockupLinear.tokenURI({ tokenId: nullStreamId });

diff --git a/test/core/integration/concrete/lockup-linear/token-uri/tokenURI.tree b/test/core/integration/concrete/lockup-linear/token-uri/tokenURI.tree
@@ -1,5 +1,5 @@
 TokenURI_LockupLinear_Integration_Concrete_Test
-├── given NFT does not exist
+├── given NFT not exist
 │  └── it should revert
 └── given NFT exists
    ├── when token URI decoded

diff --git a/...ore/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.tree b/...ore/integration/concrete/lockup-tranched/create-with-timestamps/createWithTimestamps.tree
@@ -33,7 +33,7 @@ CreateWithTimestamps_LockupTranched_Integration_Concrete_Test
                            └── when timestamps strictly increasing
                               ├── when deposit amount not equal tranche amounts sum
                               │  └── it should revert
-                              └── when the deposit amount equals tranche amounts sum
+                              └── when deposit amount equals tranche amounts sum
                                  ├── when broker fee exceeds max value
                                  │  └── it should revert
                                  └── when broker fee not exceed max value

diff --git a/test/core/integration/concrete/lockup-tranched/token-uri/tokenURI.t.sol b/test/core/integration/concrete/lockup-tranched/token-uri/tokenURI.t.sol
@@ -29,7 +29,7 @@ contract TokenURI_LockupTranched_Integration_Concrete_Test is LockupTranched_Int
         }
     }
 
-    function test_RevertGiven_NFTDoesNotExist() external {
+    function test_RevertGiven_NFTNotExist() external {
         uint256 nullStreamId = 1729;
         vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, nullStreamId));
         lockupTranched.tokenURI({ tokenId: nullStreamId });

diff --git a/test/core/integration/concrete/lockup-tranched/token-uri/tokenURI.tree b/test/core/integration/concrete/lockup-tranched/token-uri/tokenURI.tree
@@ -1,5 +1,5 @@
 TokenURI_LockupTranched_Integration_Concrete_Test
-├── given NFT does not exist
+├── given NFT not exist
 │  └── it should revert
 └── given NFT exists
    ├── when token URI decoded

diff --git a/test/core/integration/concrete/lockup/burn/burn.t.sol b/test/core/integration/concrete/lockup/burn/burn.t.sol
@@ -93,7 +93,7 @@ abstract contract Burn_Integration_Concrete_Test is Integration_Test, Lockup_Int
         _;
     }
 
-    function test_RevertGiven_NFTDoesNotExist()
+    function test_RevertGiven_NFTNotExist()
         external
         whenNoDelegateCall
         givenNotNull

diff --git a/test/core/integration/concrete/lockup/burn/burn.tree b/test/core/integration/concrete/lockup/burn/burn.tree
@@ -18,7 +18,7 @@ Burn_Integration_Concrete_Test
          ├── when unauthorized caller
          │  └── it should revert
          └── when authorized caller
-            ├── given NFT does not exist
+            ├── given NFT not exist
             │  └── it should revert
             └── given NFT exists
                ├── given non transferable NFT

diff --git a/test/core/integration/concrete/lockup/withdraw/withdraw.t.sol b/test/core/integration/concrete/lockup/withdraw/withdraw.t.sol
@@ -111,7 +111,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressNotRecipient(false)
     {
         // Simulate the passage of time.
@@ -136,7 +136,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressNotRecipient(true)
     {
         // Simulate the passage of time.
@@ -169,7 +169,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
     {
         // Make the unknown address the caller in this test.
@@ -194,7 +194,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
     {
         // Simulate the passage of time.
@@ -216,7 +216,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
         whenCallerSender
     {
@@ -248,7 +248,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
         whenCallerSender
         givenEndTimeInFuture
@@ -296,7 +296,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
         whenCallerSender
         givenEndTimeInFuture
@@ -332,7 +332,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
         whenCallerSender
         givenEndTimeInFuture
@@ -362,7 +362,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
         whenCallerSender
         givenEndTimeInFuture
@@ -395,7 +395,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
         whenCallerSender
         givenEndTimeInFuture
@@ -445,7 +445,7 @@ abstract contract Withdraw_Integration_Concrete_Test is Integration_Test, Withdr
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenWithdrawalAddressRecipient
         whenCallerSender
         givenEndTimeInFuture

diff --git a/test/core/integration/concrete/lockup/withdraw/withdraw.tree b/test/core/integration/concrete/lockup/withdraw/withdraw.tree
@@ -16,7 +16,7 @@ Withdraw_Integration_Concrete_Test
             └── when non zero withdraw amount
                ├── when withdraw amount overdraws
                │  └── it should revert
-               └── when withdraw amount does not overdraw
+               └── when withdraw amount not overdraw
                   ├── when withdrawal address not recipient
                   │  ├── when caller not approved third party or recipient
                   │  │  └── it should revert

diff --git a/test/core/integration/fuzz/lockup-dynamic/withdraw.t.sol b/test/core/integration/fuzz/lockup-dynamic/withdraw.t.sol
@@ -48,7 +48,7 @@ contract Withdraw_LockupDynamic_Integration_Fuzz_Test is
         givenNotNull
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
     {
         vm.assume(params.segments.length != 0);
         vm.assume(params.to != address(0));

diff --git a/test/core/integration/fuzz/lockup-tranched/withdraw.t.sol b/test/core/integration/fuzz/lockup-tranched/withdraw.t.sol
@@ -48,7 +48,7 @@ contract Withdraw_LockupTranched_Integration_Fuzz_Test is
         givenNotNull
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
     {
         vm.assume(params.tranches.length != 0);
         vm.assume(params.to != address(0));

diff --git a/test/core/integration/fuzz/lockup/withdraw.t.sol b/test/core/integration/fuzz/lockup/withdraw.t.sol
@@ -22,7 +22,7 @@ abstract contract Withdraw_Integration_Fuzz_Test is Integration_Test, Withdraw_I
         givenNotNull
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
     {
         vm.assume(caller != users.sender && caller != users.recipient);
 
@@ -58,7 +58,7 @@ abstract contract Withdraw_Integration_Fuzz_Test is Integration_Test, Withdraw_I
         givenNotDEPLETEDStatus
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
     {
         vm.assume(to != address(0));
 
@@ -100,7 +100,7 @@ abstract contract Withdraw_Integration_Fuzz_Test is Integration_Test, Withdraw_I
         givenNotNull
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         whenCallerRecipient
     {
         timeJump = _bound(timeJump, defaults.CLIFF_DURATION(), defaults.TOTAL_DURATION() - 1 seconds);
@@ -167,7 +167,7 @@ abstract contract Withdraw_Integration_Fuzz_Test is Integration_Test, Withdraw_I
         givenNotNull
         whenWithdrawalAddressNotZero
         whenNonZeroWithdrawAmount
-        whenWithdrawAmountDoesNotOverdraw
+        whenWithdrawAmountNotOverdraw
         givenNotCanceledStream
     {
         timeJump = _bound(timeJump, defaults.CLIFF_DURATION(), defaults.TOTAL_DURATION() * 2);

diff --git a/test/core/integration/shared/lockup/withdraw.t.sol b/test/core/integration/shared/lockup/withdraw.t.sol
@@ -68,7 +68,7 @@ abstract contract Withdraw_Integration_Shared_Test is Lockup_Integration_Shared_
         _;
     }
 
-    modifier whenWithdrawAmountDoesNotOverdraw() {
+    modifier whenWithdrawAmountNotOverdraw() {
         _;
     }
 }
diff --git a/test/periphery/integration/batch-lockup/create-with-durations-ld/createWithDurationsLD.t.sol b/test/periphery/integration/batch-lockup/create-with-durations-ld/createWithDurationsLD.t.sol
@@ -18,11 +18,7 @@ contract CreateWithDurationsLD_Integration_Test is Periphery_Test {
         batchLockup.createWithDurationsLD(lockupDynamic, dai, batchParams);
     }
 
-    modifier whenBatchSizeNotZero() {
-        _;
-    }
-
-    function test_BatchCreateWithDurations() external whenBatchSizeNotZero {
+    function test_WhenBatchSizeNotZero() external {
         // Asset flow: Sender → batchLockup → SablierLockup
         // Expect transfers from Alice to the batchLockup, and then from the batchLockup to the Lockup contract.
         expectCallToTransferFrom({

diff --git a/test/periphery/integration/batch-lockup/create-with-durations-ld/createWithDurationsLD.tree b/test/periphery/integration/batch-lockup/create-with-durations-ld/createWithDurationsLD.tree
@@ -1,6 +1,6 @@
-createWithDurationsLD.t.sol
-├── when the batch size is zero
+CreateWithDurationsLD_Integration_Test
+├── when batch size zero
 │  └── it should revert
-└── when the batch size is not zero
+└── when batch size not zero
    ├── it should create a batch of streams with durations
    └── it should perform the ERC-20 transfers
diff --git a/test/periphery/integration/batch-lockup/create-with-durations-ll/createWithDurationsLL.t.sol b/test/periphery/integration/batch-lockup/create-with-durations-ll/createWithDurationsLL.t.sol
@@ -18,11 +18,7 @@ contract CreateWithDurationsLL_Integration_Test is Periphery_Test {
         batchLockup.createWithDurationsLL(lockupLinear, dai, batchParams);
     }
 
-    modifier whenBatchSizeNotZero() {
-        _;
-    }
-
-    function test_BatchCreateWithDurations() external whenBatchSizeNotZero {
+    function test_WhenBatchSizeNotZero() external {
         // Asset flow: Sender → batchLockup → SablierLockup
         // Expect transfers from Alice to the batchLockup, and then from the batchLockup to the Lockup contract.
         expectCallToTransferFrom({

diff --git a/test/periphery/integration/batch-lockup/create-with-durations-ll/createWithDurationsLL.tree b/test/periphery/integration/batch-lockup/create-with-durations-ll/createWithDurationsLL.tree
@@ -1,6 +1,6 @@
-createWithDurationsLL.t.sol
-├── when the batch size is zero
+CreateWithDurationsLL_Integration_Test
+├── when batch size zero
 │  └── it should revert
-└── when the batch size is not zero
+└── when batch size not zero
    ├── it should create a batch of streams with durations
    └── it should perform the ERC-20 transfers
diff --git a/test/periphery/integration/batch-lockup/create-with-durations-lt/createWithDurationsLT.t.sol b/test/periphery/integration/batch-lockup/create-with-durations-lt/createWithDurationsLT.t.sol
@@ -18,11 +18,7 @@ contract CreateWithDurationsLT_Integration_Test is Periphery_Test {
         batchLockup.createWithDurationsLT(lockupTranched, dai, batchParams);
     }
 
-    modifier whenBatchSizeNotZero() {
-        _;
-    }
-
-    function test_BatchCreateWithDurations() external whenBatchSizeNotZero {
+    function test_WhenBatchSizeNotZero() external {
         // Asset flow: Sender → batchLockup → SablierLockup
         // Expect transfers from Alice to the batchLockup, and then from the batchLockup to the Lockup contract.
         expectCallToTransferFrom({

diff --git a/test/periphery/integration/batch-lockup/create-with-durations-lt/createWithDurationsLT.tree b/test/periphery/integration/batch-lockup/create-with-durations-lt/createWithDurationsLT.tree
@@ -1,6 +1,6 @@
-createWithDurationsLT.t.sol
-├── when the batch size is zero
+CreateWithDurationsLT_Integration_Test
+├── when batch size zero
 │  └── it should revert
-└── when the batch size is not zero
+└── when batch size not zero
    ├── it should create a batch of streams with durations
    └── it should perform the ERC-20 transfers
diff --git a/...periphery/integration/batch-lockup/create-with-timestamps-ld/createWithTimestampsLD.t.sol b/...periphery/integration/batch-lockup/create-with-timestamps-ld/createWithTimestampsLD.t.sol
@@ -18,11 +18,7 @@ contract CreateWithTimestampsLD_Integration_Test is Periphery_Test {
         batchLockup.createWithTimestampsLD(lockupDynamic, dai, batchParams);
     }
 
-    modifier whenBatchSizeNotZero() {
-        _;
-    }
-
-    function test_BatchCreateWithTimestamps() external whenBatchSizeNotZero {
+    function test_WhenBatchSizeNotZero() external {
         // Asset flow: Sender → batchLockup → SablierLockup
         // Expect transfers from Alice to the batchLockup, and then from the batchLockup to the Lockup contract.
         expectCallToTransferFrom({

diff --git a/.../periphery/integration/batch-lockup/create-with-timestamps-ld/createWithTimestampsLD.tree b/.../periphery/integration/batch-lockup/create-with-timestamps-ld/createWithTimestampsLD.tree
@@ -1,6 +1,6 @@
-createWithTimestampsLD.t.sol
-├── when the batch size is zero
+CreateWithTimestampsLD_Integration_Test
+├── when batch size zero
 │  └── it should revert
-└── when the batch size is not zero
+└── when batch size not zero
    ├── it should create a batch of streams with timestamps
    └── it should perform the ERC-20 transfers
diff --git a/test/periphery/integration/batch-lockup/create-with-timestamps-ll/createWithTimestamps.t.sol b/test/periphery/integration/batch-lockup/create-with-timestamps-ll/createWithTimestamps.t.sol
@@ -18,11 +18,7 @@ contract CreateWithTimestampsLL_Integration_Test is Periphery_Test {
         batchLockup.createWithTimestampsLL(lockupLinear, dai, batchParams);
     }
 
-    modifier whenBatchSizeNotZero() {
-        _;
-    }
-
-    function test_BatchCreateWithTimestamps() external whenBatchSizeNotZero {
+    function test_WhenBatchSizeNotZero() external {
         // Asset flow: Sender → batchLockup → SablierLockup
         // Expect transfers from Alice to the batchLockup, and then from the batchLockup to the Lockup contract.
         expectCallToTransferFrom({

diff --git a/test/periphery/integration/batch-lockup/create-with-timestamps-ll/createWithTimestamps.tree b/test/periphery/integration/batch-lockup/create-with-timestamps-ll/createWithTimestamps.tree
@@ -1,6 +1,6 @@
-createWithTimestampsLL.t.sol
-├── when the batch size is zero
+CreateWithTimestampsLL_Integration_Test
+├── when batch size zero
 │  └── it should revert
-└── when the batch size is not zero
+└── when batch size not zero
    ├── it should create a batch of streams with timestamps
    └── it should perform the ERC-20 transfers
diff --git a/...periphery/integration/batch-lockup/create-with-timestamps-lt/createWithTimestampsLT.t.sol b/...periphery/integration/batch-lockup/create-with-timestamps-lt/createWithTimestampsLT.t.sol
@@ -18,11 +18,7 @@ contract CreateWithTimestampsLT_Integration_Test is Periphery_Test {
         batchLockup.createWithTimestampsLT(lockupTranched, dai, batchParams);
     }
 
-    modifier whenBatchSizeNotZero() {
-        _;
-    }
-
-    function test_BatchCreateWithTimestamps() external whenBatchSizeNotZero {
+    function test_WhenBatchSizeNotZero() external {
         // Asset flow: Sender → batchLockup → SablierLockup
         // Expect transfers from Alice to the batchLockup, and then from the batchLockup to the Lockup contract.
         expectCallToTransferFrom({

diff --git a/.../periphery/integration/batch-lockup/create-with-timestamps-lt/createWithTimestampsLT.tree b/.../periphery/integration/batch-lockup/create-with-timestamps-lt/createWithTimestampsLT.tree
@@ -1,6 +1,6 @@
-createWithTimestampsLT.t.sol
-├── when the batch size is zero
+CreateWithTimestampsLT_Integration_Test
+├── when batch size zero
 │  └── it should revert
-└── when the batch size is not zero
+└── when batch size not zero
    ├── it should create a batch of streams with timestamps
    └── it should perform the ERC-20 transfers