Skip to content

Commit

Permalink
Using Given, When, Then keywords on the branching trees
Browse files Browse the repository at this point in the history
  • Loading branch information
smol-ninja committed Jul 30, 2023
1 parent fcbc567 commit d365705
Show file tree
Hide file tree
Showing 10 changed files with 51 additions and 51 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
protocolFees.t.sol
├── when the protocol fee has not been set
│ └── it should return zero
│ └── then should return zero
└── when the protocol fee has been set
└── it should return the correct protocol fee
└── then should return the correct protocol fee
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ contract SetProtocolFee_Integration_Concrete_Test is Integration_Test {
}

/// @dev The Admin is the default caller in the comptroller tests.
modifier whenCallerAdmin() {
modifier givenCallerAdmin() {
_;
}

function test_SetProtocolFee_SameFee() external whenCallerAdmin {
function test_SetProtocolFee_SameFee() external givenCallerAdmin {
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(comptroller) });
emit SetProtocolFee({ admin: users.admin, asset: dai, oldProtocolFee: ZERO, newProtocolFee: ZERO });
Expand All @@ -40,7 +40,7 @@ contract SetProtocolFee_Integration_Concrete_Test is Integration_Test {
_;
}

function test_SetProtocolFee() external whenCallerAdmin whenNewFee {
function test_SetProtocolFee() external givenCallerAdmin whenNewFee {
UD60x18 newProtocolFee = defaults.FLASH_FEE();

// Expect the relevant event to be emitted.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
setProtocolFee.t.sol
├── when the caller is not the admin
│ └── it should revert
└── when the caller is the admin
├── given the caller is not the admin
│ └── then should revert
└── given the caller is the admin
├── when the new protocol fee is the same as the current protocol fee
│ ├── it should re-set the protocol fee
│ └── it should emit a {SetProtocolFee} event
│ ├── then should re-set the protocol fee
│ └── and should emit a {SetProtocolFee} event
└── when the new protocol fee is not the same as the current protocol fee
├── it should set the new protocol fee
└── it should emit a {SetProtocolFee} event
├── then should set the new protocol fee
└── and should emit a {SetProtocolFee} event

Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ contract ToggleFlashAsset_Integration_Concrete_Test is Integration_Test {
}

/// @dev The admin is the default caller in the comptroller tests.
modifier whenCallerAdmin() {
modifier givenCallerAdmin() {
_;
}

function test_ToggleFlashAsset_FlagNotEnabled() external whenCallerAdmin {
function test_ToggleFlashAsset_FlagNotEnabled() external givenCallerAdmin {
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(comptroller) });
emit ToggleFlashAsset({ admin: users.admin, asset: dai, newFlag: true });
Expand All @@ -38,7 +38,7 @@ contract ToggleFlashAsset_Integration_Concrete_Test is Integration_Test {
_;
}

function test_ToggleFlashAsset() external whenCallerAdmin whenFlagEnabled {
function test_ToggleFlashAsset() external givenCallerAdmin whenFlagEnabled {
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(comptroller) });
emit ToggleFlashAsset({ admin: users.admin, asset: dai, newFlag: false });
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
toggleFlashAsset.t.sol
├── when the caller is not the admin
│ └── it should revert
└── when the caller is the admin
├── given the caller is not the admin
│ └── then should revert
└── given the caller is the admin
├── when the flag is not enabled
│ ├── it should toggle the flash asset
│ └── it should emit a {ToggleFlashAsset} event
│ ├── then should toggle the flash asset
│ └── and should emit a {ToggleFlashAsset} event
└── when the flag is enabled
├── it should toggle the flash asset
└── it should emit a {ToggleFlashAsset} event
├── then should toggle the flash asset
└── and should emit a {ToggleFlashAsset} event
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ contract TransferAdmin_Unit_Concrete_Test is Adminable_Unit_Shared_Test {
adminableMock.transferAdmin(users.eve);
}

modifier whenCallerAdmin() {
modifier givenCallerAdmin() {
_;
}

function test_TransferAdmin_SameAdmin() external whenCallerAdmin {
function test_TransferAdmin_SameAdmin() external givenCallerAdmin {
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(adminableMock) });
emit TransferAdmin({ oldAdmin: users.admin, newAdmin: users.admin });
Expand All @@ -33,7 +33,7 @@ contract TransferAdmin_Unit_Concrete_Test is Adminable_Unit_Shared_Test {
assertEq(actualAdmin, expectedAdmin, "admin");
}

function test_TransferAdmin_ZeroAddress() external whenCallerAdmin {
function test_TransferAdmin_ZeroAddress() external givenCallerAdmin {
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(adminableMock) });
emit TransferAdmin({ oldAdmin: users.admin, newAdmin: address(0) });
Expand All @@ -51,7 +51,7 @@ contract TransferAdmin_Unit_Concrete_Test is Adminable_Unit_Shared_Test {
_;
}

function test_TransferAdmin_NewAdmin() external whenCallerAdmin whenNotZeroAddress {
function test_TransferAdmin_NewAdmin() external givenCallerAdmin whenNotZeroAddress {
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(adminableMock) });
emit TransferAdmin({ oldAdmin: users.admin, newAdmin: users.alice });
Expand Down
26 changes: 13 additions & 13 deletions test/unit/concrete/adminable/transfer-admin/transferAdmin.tree
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
transferAdmin.t.sol
├── when the caller is not the admin
│ └── it should revert
└── when the caller is the admin
├── when the admin is the same as the current admin
│ ├── it should re-set the admin
│ └── it should emit a {TransferAdmin} event
└── when the admin is not the same as the current admin
├── when the admin is the zero address
│ ├── it should set the admin to the zero address
│ └── it should emit a {TransferAdmin}
└── when the admin is not the zero address
├── it should set the new admin
└── it should emit a {TransferAdmin} event and set the new admin
├── given the caller is not the admin
│ └── then should revert
└── given the caller is the admin
├── when new admin is same as current admin
│ ├── then should re-set the admin
│ └── and should emit a {TransferAdmin} event
└── when new admin is not same as current admin
├── when the new admin is the zero address
│ ├── then should set the admin to the zero address
│ └── and should emit a {TransferAdmin}
└── when the new admin is not the zero address
├── then should set the new admin
└── and should emit a {TransferAdmin} event and set the new admin
4 changes: 2 additions & 2 deletions test/unit/concrete/comptroller/flash-fee/flashFee.tree
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
flashFee.t.sol
├── when the flash fee has not been set
│ └── it should return zero
│ └── then should return zero
└── when the flash fee has been set
└── it should return the correct flash fee
└── then should return the correct flash fee
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ contract SetFlashFee_Unit_Concrete_Test is Comptroller_Unit_Concrete_Test {
}

/// @dev The admin is the default caller in the comptroller tests.
modifier whenCallerAdmin() {
modifier givenCallerAdmin() {
_;
}

function test_SetFlashFee_SameFee() external whenCallerAdmin {
function test_SetFlashFee_SameFee() external givenCallerAdmin {
// Expect the relevant event to be emitted.
vm.expectEmit({ emitter: address(comptroller) });
emit SetFlashFee({ admin: users.admin, oldFlashFee: ZERO, newFlashFee: ZERO });
Expand All @@ -47,7 +47,7 @@ contract SetFlashFee_Unit_Concrete_Test is Comptroller_Unit_Concrete_Test {
_;
}

function test_SetFlashFee() external whenCallerAdmin whenNewFee {
function test_SetFlashFee() external givenCallerAdmin whenNewFee {
UD60x18 newFlashFee = defaults.FLASH_FEE();

// Expect the relevant event to be emitted.
Expand Down
14 changes: 7 additions & 7 deletions test/unit/concrete/comptroller/set-flash-fee/setFlashFee.tree
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
setFlashFee.t.sol
├── when the caller is not the admin
│ └── it should revert
└── when the caller is the admin
├── given the caller is not the admin
│ └── then should revert
└── given the caller is the admin
├── when the new flash fee is the same as the current flash fee
│ ├── it should re-set the flash fee
│ └── it should emit a {SetFlashFee} event
│ ├── then should re-set the flash fee
│ └── and should emit a {SetFlashFee} event
└── when the new flash fee is not the same as the current flash fee
├── it should set the new flash fee
└── it should emit a {SetFlashFee} event
├── then should set the new flash fee
└── and should emit a {SetFlashFee} event

0 comments on commit d365705

Please sign in to comment.