Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: blacklist e2e tests for fiattokenfactory #370

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

boojamya
Copy link
Member

Includes:

  • TestFiatTFUpdateBlacklister
  • TestFiatTFBlacklist
  • TestFiatTFUnblacklist

Copy link

coderabbitai bot commented May 27, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@johnletey johnletey mentioned this pull request May 30, 2024
7 tasks
},
}
require.Equal(t, expectedGetBlacklisterResponse.Blacklister, showBlacklisterRes.Blacklister)
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a happy path test?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in: 06a3995 (#370)


pauseFiatTF(t, ctx, val, nw.fiatTfRoles.Pauser)

blacklistAccount(t, ctx, val, nw.fiatTfRoles.Blacklister, toBlacklist1)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing verification that toBlacklist1 has been successfully blacklisted

Copy link
Member Author

@boojamya boojamya Jul 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @xngln , we do this check in the blacklistAccount function:

noble/e2e/utils.go

Lines 392 to 402 in 149a7f6

var showBlacklistedResponse fiattokenfactorytypes.QueryGetBlacklistedResponse
err = json.Unmarshal(res, &showBlacklistedResponse)
require.NoError(t, err, "failed to unmarshal show-blacklisted response")
expectedBlacklistResponse := fiattokenfactorytypes.QueryGetBlacklistedResponse{
Blacklisted: fiattokenfactorytypes.Blacklisted{
AddressBz: toBlacklist.Address(),
},
}
require.Equal(t, expectedBlacklistResponse.Blacklisted, showBlacklistedResponse.Blacklisted)

require.NoError(t, err, "failed to query list-blacklisted")

var preFailedBlacklist, postFailedBlacklist fiattokenfactorytypes.QueryAllBlacklistedResponse
_ = json.Unmarshal(res, &preFailedBlacklist)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to be extra thorough, could we also verify that preFailedBlacklist does not contain toBlacklist2?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add in: b634d34 (#370)


blacklistAccount(t, ctx, val, nw.fiatTfRoles.Blacklister, nw.fiatTfRoles.Blacklister)

blacklistAccount(t, ctx, val, nw.fiatTfRoles.Blacklister, toBlacklist2)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing verification that toBlacklist2 is successfully blacklisted

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

},
}
require.Equal(t, expectedBlacklistResponse.Blacklisted, showBlacklistedRes.Blacklisted)
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a happy path test here too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in: 06a3995 (#370)


pauseFiatTF(t, ctx, val, nw.fiatTfRoles.Pauser)

unblacklistAccount(t, ctx, val, nw.fiatTfRoles.Blacklister, blacklistedUser1)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing verification that blacklistedUser1 is unblacklisted

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do this check inside of the unblacklistAccount function:

noble/e2e/utils.go

Lines 411 to 412 in 149a7f6

_, _, err = val.ExecQuery(ctx, "fiat-tokenfactory", "show-blacklisted", unBlacklist.FormattedAddress())
require.Error(t, err, "query succeeded, blacklisted account should not exist")


blacklistAccount(t, ctx, val, nw.fiatTfRoles.Blacklister, nw.fiatTfRoles.Blacklister)

unblacklistAccount(t, ctx, val, nw.fiatTfRoles.Blacklister, blacklistedUser1)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing verification that blacklistedUser is unblacklisted

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


_, err = showBlacklisted(ctx, val, blacklistedUser1)
require.Error(t, err, "query succeeded, blacklisted account should not exist")
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add the happy path test?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in: 06a3995 (#370)

@johnletey johnletey changed the base branch from feat/sdk-eden to main October 17, 2024 09:15
@johnletey johnletey requested a review from a team as a code owner October 17, 2024 09:15
Co-authored-by: Dan Kanefsky <dan@noble.xyz>
@johnletey johnletey force-pushed the dan/fiat-tf-blacklist branch from 06a3995 to 834fd2e Compare October 17, 2024 09:16
Copy link
Member

@johnletey johnletey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Passing on Cosmos SDK v0.50 ⚡

  • ✅ Green CI for TestFiatTFUpdateBlacklister (link)
  • ✅ Green CI for TestFiatTFBlacklist (link)
  • ✅ Green CI for TestFiatTFUnblacklist (link)

@johnletey johnletey changed the title chore: blacklist E2E tests for fiat token factory feat: blacklist e2e tests for fiattokenfactory Oct 17, 2024
@johnletey johnletey merged commit 8664bcf into main Oct 17, 2024
26 checks passed
@johnletey johnletey deleted the dan/fiat-tf-blacklist branch October 17, 2024 09:24
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants