[OTE-730] add test to check register affiliate auth #2235

affanv14 · 2024-09-11T19:25:35Z

Changelist

Add e2e tests to verify auth

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

Documentation
- Enhanced comments in the RegisterAffiliate function to clarify the role of the referee in the message signing process, improving understanding of security requirements.
Tests
- Introduced a new test case, TestMsgServer_RegisterAffiliateInvalidSigner, to validate the behavior of the affiliate registration process with various signer addresses, ensuring only authorized signers can register affiliates.
- Added a comprehensive test suite for the RegisterAffiliate functionality, assessing valid and invalid signer scenarios to enhance reliability.

linear · 2024-09-11T19:25:37Z

OTE-730 Add E2E tests for affiliates

coderabbitai · 2024-09-11T19:25:44Z

Walkthrough

This pull request clarifies comments in the RegisterAffiliate function within the msgServer type, highlighting the referee's role in the message signing process. It introduces a new test function to validate the behavior of the MsgRegisterAffiliate message with various signer addresses, improving test coverage for affiliate registration functionality. Additionally, a new test suite is created to thoroughly assess the RegisterAffiliate functionality under different signer conditions.

Changes

File	Change Summary
`protocol/x/affiliates/keeper/msg_server.go`	Clarified comments in the `RegisterAffiliate` function regarding the referee's role in signing.
`protocol/x/affiliates/keeper/msg_server_test.go`	Added `TestMsgServer_RegisterAffiliateInvalidSigner` to test the behavior of the registration with various signers.
`protocol/x/affiliates/e2e/register_affiliate_test.go`	Introduced a comprehensive test suite for `RegisterAffiliate`, validating signer conditions through multiple test cases.

Possibly related PRs

[OTE-692] Implement message server for affiliates #2216: Modifications to the RegisterAffiliate function which relate to the clarifications made in this PR regarding the referee's signing role.

Poem

🐇 In the code where the affiliates play,
A referee's role leads the way.
With comments clear, the path is bright,
Testing signers brings new delight.
So hop along, let’s code and cheer,
For every change, we hold so dear! 🎉

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c8305cd and 808872d.

Files selected for processing (1)

protocol/x/affiliates/e2e/register_affiliate_test.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

protocol/x/affiliates/e2e/register_affiliate_test.go

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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

teddyding · 2024-09-11T19:51:08Z

protocol/x/affiliates/keeper/msg_server_test.go

@@ -132,3 +132,66 @@ func TestMsgServer_UpdateAffiliateTiers(t *testing.T) {
 		})
 	}
 }
+
+func TestMsgServer_RegisterAffiliateInvalidSigner(t *testing.T) {


Nit: let's move this to protocol/x/affiliates/e2e (similar to protocol/x/clob/e2e), since this is an e2e test, not just the message server.

protocol/x/affiliates/e2e/register_affiliate_test.go

Co-authored-by: Teddy Ding <[email protected]>

add test to check register affiliate auth

95e5734

affanv14 requested a review from a team as a code owner September 11, 2024 19:25

github-actions bot added the protocol label Sep 11, 2024

teddyding reviewed Sep 11, 2024

View reviewed changes

move to e2e folder

c8305cd

teddyding reviewed Sep 11, 2024

View reviewed changes

protocol/x/affiliates/e2e/register_affiliate_test.go Outdated Show resolved Hide resolved

Update protocol/x/affiliates/e2e/register_affiliate_test.go

808872d

Co-authored-by: Teddy Ding <[email protected]>

teddyding approved these changes Sep 11, 2024

View reviewed changes

affanv14 merged commit 6db737c into main Sep 11, 2024
22 checks passed

affanv14 deleted the affan/affiliate-e2e-msg branch September 11, 2024 21:06

adamfraser pushed a commit that referenced this pull request Sep 12, 2024

[OTE-730] add test to check register affiliate auth (#2235)

ca6708f

Co-authored-by: Teddy Ding <[email protected]>

affanv14 added a commit that referenced this pull request Sep 12, 2024

[OTE-730] add test to check register affiliate auth (#2235)

bf1b73f

Co-authored-by: Teddy Ding <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OTE-730] add test to check register affiliate auth #2235

[OTE-730] add test to check register affiliate auth #2235

affanv14 commented Sep 11, 2024 •

edited by coderabbitai bot

Loading

linear bot commented Sep 11, 2024

coderabbitai bot commented Sep 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

teddyding Sep 11, 2024

[OTE-730] add test to check register affiliate auth #2235

[OTE-730] add test to check register affiliate auth #2235

Conversation

affanv14 commented Sep 11, 2024 • edited by coderabbitai bot Loading

Changelist

Test Plan

Author/Reviewer Checklist

Summary by CodeRabbit

linear bot commented Sep 11, 2024

coderabbitai bot commented Sep 11, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

teddyding Sep 11, 2024

Choose a reason for hiding this comment

affanv14 commented Sep 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)