test(coverage): add 9 test modules for contract test coverage push#54
Open
Josue19-08 wants to merge 2 commits into
Open
test(coverage): add 9 test modules for contract test coverage push#54Josue19-08 wants to merge 2 commits into
Josue19-08 wants to merge 2 commits into
Conversation
…coverage push Implements the full test coverage matrix from issue boundlessfi#25: events: - token_whitelist: register/deregister token support + create_event gate - cancel_refund: paged cancel flow (OwnerOnly, FullPartnerThenResidual, ProRata, pagination, all error variants) - escrow_fee_math: fee override, waiver, add_funds rate snapshot, MAX_FEE_BPS guard, single/split payout math - grant_pillar: Multi release required, fixed-split milestone math, last-milestone dust sweep, credit/rep side-effects, all errors - bounty_pillar: Single release required, apply/withdraw/submit gate, credit charge and 50% refund, select_winners pay+profile, all errors - hackathon_pillar: Single+deadline required, open submit model, multi-recipient distribution, cancel refund, all errors profile: - credits: bootstrap, spend/earn/refund/admin_grant, all error variants - reputation: bump/slash/admin_slash, saturation, all error variants - earnings: register, zero/negative guard, multi-user/token tracking, i128::MAX saturation, op replay guard 203 tests passing (146 events + 57 profile). Snapshots regenerated. Closes boundlessfi#25
|
Warning Review limit reached
More reviews will be available in 38 minutes and 44 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughThe PR rewrites and adds test modules for events and profile contract coverage. It adds new event tests for token whitelist, cancel refunds, fee math, and grant behavior, and streamlines bounty and hackathon test coverage. It also adds profile earnings and reputation tests and trims credits coverage. ChangesEvents contract tests
Profile contract tests
Estimated review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Nitpick comments (1)
contracts/events/src/tests/cancel_refund.rs (1)
207-277: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winMisleading name/header and dead scratch comments in this test.
This test actually exercises the ProRataPartners branch, not a boundary case:
- The section header (Lines 207-209) says
boundary: remaining == non_owner_total, but the realized state isremaining = 800 < non_owner_total = 1000, i.e. strict pro-rata.- The name
cancel_at_boundary_pays_partners_full_no_owner_residualis inaccurate — partners receive the pro-rated 400 each (Lines 274-275), not their full 500 contribution.- Lines 213-214 and 240-255 are a large block of contradictory, self-correcting scratch reasoning that doesn't describe the final test and should be removed.
Rename to reflect the ProRata path and replace the scratch block with a single accurate comment of the realized math.
♻️ Suggested cleanup
-// ============================================================ -// ProRataPartners branch (boundary: remaining == non_owner_total) -// ============================================================ - -#[test] -fn cancel_at_boundary_pays_partners_full_no_owner_residual() { - // 60/40 split; pay position 1 (60%); remaining = 40% of escrow. - // With partner pool == remaining, no owner residual. +// ============================================================ +// ProRataPartners branch (remaining < non_owner_total) +// ============================================================ + +#[test] +fn cancel_prorata_splits_remaining_across_partners_no_owner_residual() { + // escrow = 2000 (owner 1000 + p1 500 + p2 500); select_winners pays + // pos1 60% (1200) leaving remaining = 800. non_owner_total = 1000. + // 800 < 1000 -> ProRata: each partner gets 500 * 800 / 1000 = 400; owner = 0.Also drop the stale reasoning block at Lines 240-255.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@contracts/events/src/tests/cancel_refund.rs` around lines 207 - 277, This test is mislabeled and contains stale scratch reasoning: the scenario in cancel_at_boundary_pays_partners_full_no_owner_residual actually exercises the ProRataPartners path, not the boundary/full-partner case. Rename the test and header to reflect the realized math in drive_cancel and ctx.events.select_winners, and replace the contradictory comment block with one short accurate explanation of the final state (remaining < non_owner_total, so each partner gets a pro-rated share and owner gets nothing). Remove the dead self-correcting comments so the test only documents the final intended behavior.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@contracts/events/src/tests/bounty_pillar.rs`:
- Around line 244-267: The single-recipient payout test in
select_winners_pays_recipient_and_updates_profile only checks the applicant’s
balance change and misses the required fee-account balance delta assertion.
Update this test to also verify the fee_account balance change after
ctx.events.select_winners, using the existing Ctx.fee_account and the token
client, so the payout split path covers both recipient and fee balances as
required.
In `@contracts/events/src/tests/cancel_refund.rs`:
- Around line 132-153: The refund/sweep payout tests currently assert only
recipient and owner balance deltas, but they do not verify that the fee account
remains unchanged, so a fee-skimming regression would be missed. Update the
payout-affecting tests in cancel_refund.rs, especially
full_partner_then_residual_pays_partners_and_owner,
paged_cancel_processes_in_batches, and the cancel_at_boundary_* cases, to
capture the fee account balance from Ctx before and after drive_cancel and
assert its delta is zero alongside the existing balance checks.
In `@contracts/events/src/tests/escrow_fee_math.rs`:
- Around line 199-217: Update the payout-path tests in escrow_fee_math.rs to
assert fee-account balance deltas alongside recipient balances. In
select_winners_single_100_percent_drains_escrow and the other payout split tests
referenced by the review, capture the fee account balance before and after
calling Events::select_winners and verify it does not change for these hackathon
winner-release paths, while still checking the recipient payout and
remaining_escrow/status outcomes. Use the existing setup(), token::Client, and
ctx.events.select_winners flows so the assertions cover both the
single-position, multi-position, and sweep cases consistently.
In `@contracts/events/src/tests/grant_pillar.rs`:
- Around line 154-169: The payout-split tests are missing assertions for the
fee-account balance delta even though they already verify recipient deltas.
Update the grant_pillar tests in the
claim_milestone_pays_fixed_per_milestone_amount,
claim_milestone_last_sweeps_rounding_residue, and
two_winner_grant_each_claims_their_share paths to also read ctx.fee_account via
token::Client and assert the fee balance change for each split case. Keep the
existing recipient and escrow assertions, and make sure every single-position,
multi-position, and sweep payout test covers both recipient and fee-account
balance changes.
In `@contracts/events/src/tests/hackathon_pillar.rs`:
- Around line 199-220: Add fee-account balance assertions to the payout tests
that currently only verify recipient balances. In the test function
select_winners_single_pays_full_budget_and_updates_profile, and in the
multi-recipient test mentioned in the review, check the fee_account balance
delta alongside the recipient delta after select_winners so the deposit fee
collection is covered. Use the existing setup helpers and identifiers like
ctx.events.select_winners, ctx.fee_account, and token::Client::new to locate the
payout assertions, and make the same coverage consistent with the sweep-path
test.
In `@contracts/events/src/tests/token_whitelist.rs`:
- Around line 117-136: The unsupported-token test only checks that create_event
fails, which is too weak. Update the assertions in
create_event_with_unsupported_token_reverts and the other try_create_event test
to match the specific Error::TokenNotSupported result instead of using is_err().
Use the existing try_create_event call and assert against the exact rejection
reason so the token whitelist behavior is enforced precisely.
- Around line 24-27: Add negative auth tests for the admin-gated whitelist
mutation paths in token_whitelist.rs, because setup() uses env.mock_all_auths()
and only verifies auth requests. Update the existing register/deregister test
cases and add explicit unauthorized-call checks around the whitelist mutation
entry points so non-admin callers are asserted to fail, using the relevant test
helpers and mutation methods in this module. Focus on proving rejection behavior
for both registration and deregistration rather than only successful admin
flows.
In `@contracts/profile/src/tests/earnings.rs`:
- Around line 139-152: The test register_earnings_requires_events_contract_auth
currently only verifies the success path under mock_all_auths and does not
assert the unauthorized failure it claims to cover. Update the earnings test in
register_earnings_requires_events_contract_auth to include a
try_register_earnings call that is rejected when the caller is not the
configured events contract, and assert that the auth check fails before the
state update; if you intend to keep only the success case, rename the test to
match its actual behavior.
---
Nitpick comments:
In `@contracts/events/src/tests/cancel_refund.rs`:
- Around line 207-277: This test is mislabeled and contains stale scratch
reasoning: the scenario in
cancel_at_boundary_pays_partners_full_no_owner_residual actually exercises the
ProRataPartners path, not the boundary/full-partner case. Rename the test and
header to reflect the realized math in drive_cancel and
ctx.events.select_winners, and replace the contradictory comment block with one
short accurate explanation of the final state (remaining < non_owner_total, so
each partner gets a pro-rated share and owner gets nothing). Remove the dead
self-correcting comments so the test only documents the final intended behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7e26aeca-6dbd-4fd3-904a-54286b7092f6
📒 Files selected for processing (11)
contracts/events/src/tests/bounty_pillar.rscontracts/events/src/tests/cancel_refund.rscontracts/events/src/tests/escrow_fee_math.rscontracts/events/src/tests/grant_pillar.rscontracts/events/src/tests/hackathon_pillar.rscontracts/events/src/tests/mod.rscontracts/events/src/tests/token_whitelist.rscontracts/profile/src/tests/credits.rscontracts/profile/src/tests/earnings.rscontracts/profile/src/tests/mod.rscontracts/profile/src/tests/reputation.rs
- Add fee-account balance delta assertions to all payout split paths (bounty, hackathon, escrow_fee_math, grant single/sweep/multi-winner) - Add fee-account delta=0 assertions to cancel refund payout tests (full_partner_then_residual, paged_cancel, prorata) - Rename cancel_at_boundary test to cancel_prorata_splits_remaining; remove stale scratch comments, fix section header - Change is_err() to assert_eq!(err, Error::TokenNotSupported) in token whitelist create_event rejection tests - Add register_without_admin_auth_reverts and deregister_without_admin_auth_reverts negative auth tests - Rename register_earnings_requires_events_contract_auth and add register_earnings_without_events_contract_auth_reverts with a real impostor-auth rejection check
Author
|
All CodeRabbit findings addressed in the latest commit (eb378fc):
209 tests passing (147 events + 62 profile), zero warnings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Implements the full test coverage matrix described in #25. Adds 6 new test modules for
boundless-eventsand 2 forboundless-profile(bounty_pillar and hackathon_pillar were already merged via #46 and #47; credits via #48).Changes
boundless-events:
token_whitelist—register_supported_token,deregister_supported_token,create_eventrejection of unsupported/deregistered tokenscancel_refund— paged cancel flow:OwnerOnly,FullPartnerThenResidual,ProRata, pagination across batches, all error variantsescrow_fee_math— default fee, per-event override,add_fundsrate snapshot, waiver (0 bps),MAX_FEE_BPSguard, single/60-40 payout math, admin fee updategrant_pillar—Multirelease required, fixed-split milestone math, last-milestone dust sweep, credit/rep side-effects, all error variantsboundless-profile:
earnings—register_earnings, zero/negative guard, multi-user/token tracking,i128::MAXsaturation, op replay guardreputation—bump/slash/admin_slash, saturation, all error variants + op replay + authResult: 206 tests passing (145 events + 61 profile), zero warnings.
Closes
Closes #25
Notes
soroban_sdk::Vecshadowsstd::vec::Vecin test scope — array literals are used instead of.collect()to avoid the name collision.Summary by CodeRabbit
New Features
Bug Fixes