Add initial happy path integration tests #56

alexkeating · 2024-02-09T14:22:45Z

Description

I added the below integration tests. These are meant to be the initial integration tests and not a comprehensive suite. More tests will be added in follow up prs.

Correctly Enable Fee Amount After Proposal Is Executed
Revert If Enable Fee Amount Fee Is Too High After Proposal Is Executed
Revert If Enable Fee Amount Tick Spacing Is Too High After Proposal Is Executed
Revert If Enable Fee Amount Tick Spacing Is Too Low After Proposal Is Executed
Correctly Swap Weth And Notify Reward After Proposal Is Executed
Correctly Swap Dai And Notify Reward After Proposal Is Executed
Correctly Swap Dai And WETH Then Notify Reward After Proposal Is Executed
Correctly Stake and Earn Rewards After Full Duration
Correctly Stake And Claim Rewards After Full Duration
Correctly Stake And Earn Rewards After Partial Duration
Correctly Stake More And Earn Rewards After Full Duration

alexkeating · 2024-02-12T21:55:51Z

test/helpers/IntegrationTest.sol

+    vm.warp(block.timestamp + _seconds);
+  }
+
+  function _jumpAheadByPercentOfRewardDuration(uint256 _percent) public {


I added a couple of methods that exist in the UniStakerRewardsTest contract. I figured we can duplicate for now and abstract them away in a followup pr.

alexkeating · 2024-02-12T21:56:32Z

test/helpers/PercentAssertions.sol

+
+import {Test} from "forge-std/Test.sol";
+
+contract PercentAssertions is Test {


Copied from the UniStaker.t.sol

test/helpers/IntegrationTest.sol

apbendi

Did a big fuzz run locally and got two test failures. Stack was so long it exceeded my terminal context window, but here's the two failure cases and a bit of one stack:

Failing tests:
Encountered 2 failing tests in test/UniStaker.integration.t.sol:Stake
[FAIL. Reason: revert: Uni::_moveVotes: vote amount underflows; counterexample: calldata=0x5260afce00000000000000000000000076f54eeb0d33a2a2c5ccb72fe12542a56f35d67c08c379a0000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000c3c00000000000000000000000000000000ffffffffffffffffffffffffffffffff args=[0x76f54Eeb0D33a2A2c5CCb72FE12542A56f35d67C, 3963877391197344453575983046348115674221700746820753546331534351508065746945 [3.963e75], 0x0000000000000000000000000000000000000c3c, 340282366920938463463374607431768211455 [3.402e38]]] testForkFuzz_CorrectlyStakeAndClaimRewardsAfterFullDuration(address,uint256,address,uint128) (runs: 1548, μ: 4977153, ~: 5003766)
[FAIL. Reason: revert: Uni::_moveVotes: vote amount underflows; counterexample: calldata=0xae6a158600000000000000000000000076f54eeb0d33a2a2c5ccb72fe12542a56f35d67c000000000000000000000044656c61793a2044656c6179206d757374206578630000000000000000000000000000000000000000000000000000000000005fcb0000000000000000000000000000000000000000000000000000000000000594000000000000000000000000000000000000000000000000000000000000022000000000000000000000000000000000000000000000000000000000000033a0 args=[0x76f54Eeb0D33a2A2c5CCb72FE12542A56f35d67C, 99961136377979212079769318731761422811699695941731 [9.996e49], 24523 [2.452e4], 0x0000000000000000000000000000000000000594, 544, 13216 [1.321e4]]] testForkFuzz_CorrectlyStakeMoreAndEarnRewardsAfterFullDuration(address,uint256,uint256,address,uint128,uint256) (runs: 4355, μ: 4987272, ~: 5016334)

    ├─ [25230] 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984::approve(UniStaker: [0x1B0Fd9Df9c444A4CeEC9863B88e1D7Cb3db621c0], 9318731761422811699695941731 [9.318e27])
    │   ├─ emit Approval(owner: 0x76f54Eeb0D33a2A2c5CCb72FE12542A56f35d67C, spender: UniStaker: [0x1B0Fd9Df9c444A4CeEC9863B88e1D7Cb3db621c0], value: 9318731761422811699695941731 [9.318e27])
    │   └─ ← true
    ├─ [0] console::log("Bound Result", 86) [staticcall]
    │   └─ ← ()
    ├─ [0] VM::prank(0x76f54Eeb0D33a2A2c5CCb72FE12542A56f35d67C)
    │   └─ ← ()
    ├─ [336583] UniStaker::stake(9318731761422811699695941731 [9.318e27], 0x0000000000000000000000000000000000000594)
    │   ├─ [65878] → new DelegationSurrogate@0xa1fCA0e92c8460DCB1e13670194d89CeD91C639B
    │   │   ├─ [26990] 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984::delegate(0x0000000000000000000000000000000000000594)
    │   │   │   ├─ emit DelegateChanged(delegator: DelegationSurrogate: [0xa1fCA0e92c8460DCB1e13670194d89CeD91C639B], fromDelegate: 0x0000000000000000000000000000000000000000, toDelegate: 0x0000000000000000000000000000000000000594)
    │   │   │   └─ ← ()
    │   │   ├─ [25103] 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984::approve(UniStaker: [0x1B0Fd9Df9c444A4CeEC9863B88e1D7Cb3db621c0], 115792089237316195423570985008687907853269984665640564039457584007913129639935 [1.157e77])
    │   │   │   ├─ emit Approval(owner: DelegationSurrogate: [0xa1fCA0e92c8460DCB1e13670194d89CeD91C639B], spender: UniStaker: [0x1B0Fd9Df9c444A4CeEC9863B88e1D7Cb3db621c0], value: 79228162514264337593543950335 [7.922e28])
    │   │   │   └─ ← true
    │   │   └─ ← 524 bytes of code
    │   ├─ emit SurrogateDeployed(delegatee: 0x0000000000000000000000000000000000000594, surrogate: DelegationSurrogate: [0xa1fCA0e92c8460DCB1e13670194d89CeD91C639B])
    │   ├─ [30823] 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984::transferFrom(0x76f54Eeb0D33a2A2c5CCb72FE12542A56f35d67C, DelegationSurrogate: [0xa1fCA0e92c8460DCB1e13670194d89CeD91C639B], 9318731761422811699695941731 [9.318e27])
    │   │   ├─ emit Approval(owner: 0x76f54Eeb0D33a2A2c5CCb72FE12542A56f35d67C, spender: UniStaker: [0x1B0Fd9Df9c444A4CeEC9863B88e1D7Cb3db621c0], value: 0)
    │   │   ├─ emit Transfer(from: 0x76f54Eeb0D33a2A2c5CCb72FE12542A56f35d67C, to: DelegationSurrogate: [0xa1fCA0e92c8460DCB1e13670194d89CeD91C639B], value: 9318731761422811699695941731 [9.318e27])
    │   │   └─ ← revert: Uni::_moveVotes: vote amount underflows
    │   └─ ← revert: Uni::_moveVotes: vote amount underflows
    └─ ← revert: Uni::_moveVotes: vote amount underflows

test/helpers/IntegrationTest.sol

test/UniStaker.integration.t.sol

wildmolasses

lgtm, 2 comments

.github/workflows/ci.yml

wildmolasses · 2024-02-21T19:04:10Z

foundry.toml

@@ -1,8 +1,13 @@
 [profile.default]
  evm_version = "paris"
+  fuzz = { seed = "1" }


this implies a static fuzz seed will be used in local dev, right? I don't think that's what we want, or do i have the wrong idea?

Yes exactly, typically we add this locally as well when adding it to the CI. It all depends on what we want the default to be when running tests locally. I am happy to remove if we would rather not have it.

prefer no default seed

wildmolasses · 2024-02-22T16:11:16Z

.github/workflows/ci.yml

+      - name: Generate fuzz seed with 1 week TTL
+        run: >
+          echo "FOUNDRY_FUZZ_SEED=$(
+            echo $(($EPOCHSECONDS - $EPOCHSECONDS % 604800))


i lean towards a 1 day TTL instead, so that different fuzz runs can get us feedback quicker. but here, it's a big nit, since we're soon to be code complete

github-actions · 2024-02-22T17:39:45Z

Coverage after merging chore/more-integration-tests into main will be

100.00%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
src
UniStaker.sol	99.49%	95.83%	100%	100%	611
V3FactoryOwner.sol	100%	100%	100%	100%

alexkeating commented Feb 12, 2024

View reviewed changes

alexkeating changed the title ~~Add more integration tests~~ Add initial happy path integration tests Feb 12, 2024

alexkeating force-pushed the feature/proposal-script branch from 258c2e4 to 39f7f0f Compare February 14, 2024 17:24

alexkeating force-pushed the chore/more-integration-tests branch 3 times, most recently from 64b5dd9 to 3f5518b Compare February 15, 2024 16:24

alexkeating changed the base branch from feature/proposal-script to main February 15, 2024 16:59

alexkeating force-pushed the chore/more-integration-tests branch 3 times, most recently from 7b0692b to fbb0a82 Compare February 15, 2024 17:09

alexkeating requested review from apbendi and wildmolasses February 15, 2024 18:10

alexkeating marked this pull request as ready for review February 15, 2024 18:10

alexkeating added 4 commits February 16, 2024 13:15

Happy path integration tests

99a6547

Change lines

ae8b4ec

Remove unnecessary utils

0e234c7

Fix tests

aee6bae

alexkeating force-pushed the chore/more-integration-tests branch from 562e4eb to aee6bae Compare February 16, 2024 18:15

alexkeating added 2 commits February 19, 2024 16:32

Mint for real

904b37a

Add fuzz seed

33abd22

alexkeating commented Feb 19, 2024

View reviewed changes

test/helpers/IntegrationTest.sol Show resolved Hide resolved

apbendi reviewed Feb 19, 2024

View reviewed changes

alexkeating added 7 commits February 20, 2024 09:45

Fix test?

d44fabb

Lower the minting allowed after cap

3fa7bf2

Rename _setupPayouttoken

76d5f21

Rename setupSwapToken

0aa3c8d

Rename _generateFees

1082a96

Rename _notifyRewards helper

0870912

Reorder jumps

9c16b86

alexkeating requested a review from apbendi February 20, 2024 20:23

Rename ci step

535081e

wildmolasses approved these changes Feb 21, 2024

View reviewed changes

wildmolasses reviewed Feb 22, 2024

View reviewed changes

Make changes based on feedback

ba83d8e

wildmolasses self-requested a review February 22, 2024 16:31

wildmolasses approved these changes Feb 22, 2024

View reviewed changes

Rename step

e75e451

apbendi merged commit 1d13ba3 into main Feb 22, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial happy path integration tests #56

Add initial happy path integration tests #56

alexkeating commented Feb 9, 2024 •

edited

Loading

alexkeating Feb 12, 2024 •

edited

Loading

alexkeating Feb 12, 2024

apbendi left a comment

wildmolasses left a comment

wildmolasses Feb 21, 2024

alexkeating Feb 21, 2024

wildmolasses Feb 22, 2024

wildmolasses Feb 22, 2024

github-actions bot commented Feb 22, 2024


		import {Test} from "forge-std/Test.sol";

		contract PercentAssertions is Test {

Add initial happy path integration tests #56

Add initial happy path integration tests #56

Conversation

alexkeating commented Feb 9, 2024 • edited Loading

Description

alexkeating Feb 12, 2024 • edited Loading

Choose a reason for hiding this comment

alexkeating Feb 12, 2024

Choose a reason for hiding this comment

apbendi left a comment

Choose a reason for hiding this comment

wildmolasses left a comment

Choose a reason for hiding this comment

wildmolasses Feb 21, 2024

Choose a reason for hiding this comment

alexkeating Feb 21, 2024

Choose a reason for hiding this comment

wildmolasses Feb 22, 2024

Choose a reason for hiding this comment

wildmolasses Feb 22, 2024

Choose a reason for hiding this comment

github-actions bot commented Feb 22, 2024

alexkeating commented Feb 9, 2024 •

edited

Loading

alexkeating Feb 12, 2024 •

edited

Loading