test: dry-ify the merkle tests (#1009)

test: polish shared tests

test/periphery/Periphery.t.sol

@@ -10,6 +10,10 @@ import { SablierMerkleLT } from "src/periphery/SablierMerkleLT.sol";
 import { Base_Test } from "../Base.t.sol";
 
 contract Periphery_Test is Base_Test {
+ function setUp() public virtual override {
+ Base_Test.setUp();
+ }
+
  /*//////////////////////////////////////////////////////////////////////////
  MERKLE-BASE
  //////////////////////////////////////////////////////////////////////////*/

test/periphery/fork/Fork.t.sol

@@ -35,7 +35,7 @@ abstract contract Fork_Test is Periphery_Test, Merkle {
  vm.createSelectFork({ blockNumber: 20_339_512, urlOrAlias: "mainnet" });
 
  // Set up the parent test contract.
- super.setUp();
+ Periphery_Test.setUp();
 
  // Load the external dependencies.
  loadDependencies();

test/periphery/integration/batch-lockup/create-with-durations-ld/createWithDurationsLD.t.sol

@@ -8,7 +8,7 @@ import { Periphery_Test } from "../../../Periphery.t.sol";
 
 contract CreateWithDurationsLD_Integration_Test is Periphery_Test {
  function setUp() public virtual override {
- super.setUp();
+ Periphery_Test.setUp();
  resetPrank({ msgSender: users.sender });
  }
 

test/periphery/integration/batch-lockup/create-with-durations-ll/createWithDurationsLL.t.sol

@@ -8,7 +8,7 @@ import { Periphery_Test } from "../../../Periphery.t.sol";
 
 contract CreateWithDurationsLL_Integration_Test is Periphery_Test {
  function setUp() public virtual override {
- super.setUp();
+ Periphery_Test.setUp();
  resetPrank({ msgSender: users.sender });
  }
 

test/periphery/integration/batch-lockup/create-with-durations-lt/createWithDurationsLT.t.sol

@@ -8,7 +8,7 @@ import { Periphery_Test } from "../../../Periphery.t.sol";
 
 contract CreateWithDurationsLT_Integration_Test is Periphery_Test {
  function setUp() public virtual override {
- super.setUp();
+ Periphery_Test.setUp();
  resetPrank({ msgSender: users.sender });
  }
 

test/periphery/integration/batch-lockup/create-with-timestamps-ld/createWithTimestampsLD.t.sol

@@ -8,7 +8,7 @@ import { Periphery_Test } from "../../../Periphery.t.sol";
 
 contract CreateWithTimestampsLD_Integration_Test is Periphery_Test {
  function setUp() public virtual override {
- super.setUp();
+ Periphery_Test.setUp();
  resetPrank({ msgSender: users.sender });
  }
 

test/periphery/integration/batch-lockup/create-with-timestamps-ll/createWithTimestamps.t.sol

@@ -8,7 +8,7 @@ import { Periphery_Test } from "../../../Periphery.t.sol";
 
 contract CreateWithTimestampsLL_Integration_Test is Periphery_Test {
  function setUp() public virtual override {
- super.setUp();
+ Periphery_Test.setUp();
  resetPrank({ msgSender: users.sender });
  }
 

test/periphery/integration/batch-lockup/create-with-timestamps-lt/createWithTimestampsLT.t.sol

@@ -8,7 +8,7 @@ import { Periphery_Test } from "../../../Periphery.t.sol";
 
 contract CreateWithTimestampsLT_Integration_Test is Periphery_Test {
  function setUp() public virtual override {
- super.setUp();
+ Periphery_Test.setUp();
  resetPrank({ msgSender: users.sender });
  }
 

test/periphery/integration/merkle-campaign/MerkleCampaign.t.sol

@@ -8,8 +8,12 @@ import { ISablierMerkleLT } from "src/periphery/interfaces/ISablierMerkleLT.sol"
 import { Periphery_Test } from "../../Periphery.t.sol";
 
 abstract contract MerkleCampaign_Integration_Test is Periphery_Test {
+ /*//////////////////////////////////////////////////////////////////////////
+ SET-UP FUNCTION
+ //////////////////////////////////////////////////////////////////////////*/
+
  function setUp() public virtual override {
- super.setUp();
+ Periphery_Test.setUp();
 
  // Make Alice the caller.
  resetPrank(users.alice);

test/periphery/integration/merkle-campaign/instant/MerkleInstant.t.sol

@@ -0,0 +1,90 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.22 <0.9.0;
+
+import { ISablierMerkleBase } from "src/periphery/interfaces/ISablierMerkleBase.sol";
+
+import { Clawback_Integration_Test } from "../shared/clawback/clawback.t.sol";
+import { GetFirstClaimTime_Integration_Test } from "../shared/get-first-claim-time/getFirstClaimTime.t.sol";
+import { HasClaimed_Integration_Test } from "../shared/has-claimed/hasClaimed.t.sol";
+import { HasExpired_Integration_Test } from "../shared/has-expired/hasExpired.t.sol";
+import { MerkleCampaign_Integration_Shared_Test } from "../shared/MerkleCampaign.t.sol";
+
+/*//////////////////////////////////////////////////////////////////////////
+ NON-SHARED TESTS
+//////////////////////////////////////////////////////////////////////////*/
+
+abstract contract MerkleInstant_Integration_Shared_Test is MerkleCampaign_Integration_Shared_Test {
+ function setUp() public virtual override {
+ MerkleCampaign_Integration_Shared_Test.setUp();
+
+ // Cast the {merkleInstant} contract as {ISablierMerkleBase}
+ merkleBase = ISablierMerkleBase(merkleInstant);
+ }
+}
+
+/*//////////////////////////////////////////////////////////////////////////
+ SHARED TESTS
+//////////////////////////////////////////////////////////////////////////*/
+
+contract Clawback_MerkleLInstant_Integration_Test is
+ Clawback_Integration_Test,
+ MerkleInstant_Integration_Shared_Test
+{
+ modifier afterFirstClaim() override {
+ // Make the first claim to set `_firstClaimTime`.
+ claimInstant();
+ _;
+ }
+
+ function setUp() public override(Clawback_Integration_Test, MerkleInstant_Integration_Shared_Test) {
+ Clawback_Integration_Test.setUp();
+ MerkleInstant_Integration_Shared_Test.setUp();
+ }
+}
+
+contract GetFirstClaimTime_MerkleLInstant_Integration_Test is
+ GetFirstClaimTime_Integration_Test,
+ MerkleInstant_Integration_Shared_Test
+{
+ modifier afterFirstClaim() override {
+ // Make the first claim to set `_firstClaimTime`.
+ claimInstant();
+ _;
+ }
+
+ function setUp() public override(GetFirstClaimTime_Integration_Test, MerkleInstant_Integration_Shared_Test) {
+ GetFirstClaimTime_Integration_Test.setUp();
+ MerkleInstant_Integration_Shared_Test.setUp();
+ }
+}
+
+contract HasClaimed_MerkleLInstant_Integration_Test is
+ HasClaimed_Integration_Test,
+ MerkleInstant_Integration_Shared_Test
+{
+ modifier givenRecipientHasClaimed() override {
+ // Make the first claim to set `_firstClaimTime`.
+ claimInstant();
+ _;
+ }
+
+ function setUp() public override(HasClaimed_Integration_Test, MerkleInstant_Integration_Shared_Test) {
+ HasClaimed_Integration_Test.setUp();
+ MerkleInstant_Integration_Shared_Test.setUp();
+ }
+}
+
+contract HasExpired_MerkleLInstant_Integration_Test is
+ HasExpired_Integration_Test,
+ MerkleInstant_Integration_Shared_Test
+{
+ modifier createMerkleCampaignWithZeroExpiry() override {
+ campaignWithZeroExpiry = ISablierMerkleBase(createMerkleInstant({ expiration: 0 }));
+ _;
+ }
+
+ function setUp() public override(HasExpired_Integration_Test, MerkleInstant_Integration_Shared_Test) {
+ HasExpired_Integration_Test.setUp();
+ MerkleInstant_Integration_Shared_Test.setUp();
+ }
+}

test/periphery/integration/merkle-campaign/instant/claim/claim.t.sol

@@ -5,7 +5,7 @@ import { Errors } from "src/periphery/libraries/Errors.sol";
 
 import { MerkleCampaign_Integration_Test } from "../../MerkleCampaign.t.sol";
 
-contract Claim_Integration_Test is MerkleCampaign_Integration_Test {
+contract Claim_MerkleInstant_Integration_Test is MerkleCampaign_Integration_Test {
  function test_RevertGiven_CampaignExpired() external {
  uint40 expiration = defaults.EXPIRATION();
  uint256 warpTime = expiration + 1 seconds;

test/periphery/integration/merkle-campaign/instant/constructor/constructor.t.sol → test/periphery/integration/merkle-campaign/instant/constructor.t.sol

@@ -3,7 +3,7 @@ pragma solidity >=0.8.22 <0.9.0;
 
 import { SablierMerkleInstant } from "src/periphery/SablierMerkleInstant.sol";
 
-import { MerkleCampaign_Integration_Test } from "../../MerkleCampaign.t.sol";
+import { MerkleCampaign_Integration_Test } from "../MerkleCampaign.t.sol";
 
 contract Constructor_MerkleInstant_Integration_Test is MerkleCampaign_Integration_Test {
  /// @dev Needed to prevent "Stack too deep" error