[ISSUE #1328]🧪Add test for ConsumerData #1329
Merged
Conversation
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
WalkthroughThe changes introduce a new test module for the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
|
🔊@mxsm 🚀Thanks for your contribution 🎉. CodeRabbit(AI) will review your code first 🔥 |
rocketmq-rust-bot
added
AI review first
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1329 +/- ##
==========================================
+ Coverage 19.88% 19.99% +0.11%
==========================================
Files 434 434
Lines 54561 54638 +77
==========================================
+ Hits 10848 10925 +77
Misses 43713 43713 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
rocketmq-remoting/src/protocol/heartbeat/consumer_data.rs (4)
65-77: Consider enhancing default value assertionsWhile the test covers all fields, consider adding more specific assertions:
- Verify the specific variants of default enums (ConsumeType, MessageModel, ConsumeFromWhere)
- Test the initial capacity of subscription_data_set
#[test] fn consumer_data_default_values() { let consumer_data = ConsumerData::default(); assert_eq!(consumer_data.group_name, CheetahString::new()); - assert_eq!(consumer_data.consume_type, ConsumeType::default()); - assert_eq!(consumer_data.message_model, MessageModel::default()); - assert_eq!( - consumer_data.consume_from_where, - ConsumeFromWhere::default() - ); + assert_eq!(consumer_data.consume_type, ConsumeType::ACTIVELY); // Verify specific variant + assert_eq!(consumer_data.message_model, MessageModel::CLUSTERING); // Verify specific variant + assert_eq!(consumer_data.consume_from_where, ConsumeFromWhere::LAST_OFFSET); // Verify specific variant assert!(consumer_data.subscription_data_set.is_empty()); + assert_eq!(consumer_data.subscription_data_set.capacity(), 0); // Verify initial capacity assert!(!consumer_data.unit_mode); }
79-103: Consider testing more equality scenariosThe current test verifies basic equality, but consider adding tests for:
- Multiple subscription data entries in different orders
- Empty vs non-empty subscription sets
#[test] fn consumer_data_equality() { + // Test with multiple subscription data in different orders let mut subscription_data_set1 = HashSet::new(); - subscription_data_set.insert(SubscriptionData::default()); + let mut sub1 = SubscriptionData::default(); + sub1.topic = CheetahString::from("topic1"); + let mut sub2 = SubscriptionData::default(); + sub2.topic = CheetahString::from("topic2"); + subscription_data_set1.insert(sub1.clone()); + subscription_data_set1.insert(sub2.clone()); + + let mut subscription_data_set2 = HashSet::new(); + subscription_data_set2.insert(sub2); + subscription_data_set2.insert(sub1); let consumer_data1 = ConsumerData { group_name: CheetahString::from("group1"), consume_type: ConsumeType::default(), message_model: MessageModel::default(), consume_from_where: ConsumeFromWhere::default(), - subscription_data_set: subscription_data_set.clone(), + subscription_data_set: subscription_data_set1, unit_mode: false, }; let consumer_data2 = ConsumerData { group_name: CheetahString::from("group1"), consume_type: ConsumeType::default(), message_model: MessageModel::default(), consume_from_where: ConsumeFromWhere::default(), - subscription_data_set, + subscription_data_set: subscription_data_set2, unit_mode: false, }; assert_eq!(consumer_data1, consumer_data2); + + // Test equality with empty subscription sets + let consumer_data3 = ConsumerData { + group_name: CheetahString::from("group1"), + subscription_data_set: HashSet::new(), + ..Default::default() + }; + + let consumer_data4 = ConsumerData { + group_name: CheetahString::from("group1"), + subscription_data_set: HashSet::new(), + ..Default::default() + }; + + assert_eq!(consumer_data3, consumer_data4); }
128-152: Enhance hash consistency testingWhile the test verifies basic hash consistency, consider adding:
- Hash equality test for two equivalent instances
- Hash inequality test for different instances
#[test] fn consumer_data_hash() { use std::collections::hash_map::DefaultHasher; use std::hash::Hash; use std::hash::Hasher; - let consumer_data = ConsumerData { + let consumer_data1 = ConsumerData { group_name: CheetahString::from("group1"), consume_type: ConsumeType::default(), message_model: MessageModel::default(), consume_from_where: ConsumeFromWhere::default(), subscription_data_set: HashSet::new(), unit_mode: false, }; + // Test hash consistency for same instance let mut hasher = DefaultHasher::new(); - consumer_data.hash(&mut hasher); + consumer_data1.hash(&mut hasher); let hash1 = hasher.finish(); let mut hasher = DefaultHasher::new(); - consumer_data.hash(&mut hasher); + consumer_data1.hash(&mut hasher); let hash2 = hasher.finish(); assert_eq!(hash1, hash2); + + // Test hash equality for equivalent instances + let consumer_data2 = ConsumerData { + group_name: CheetahString::from("group1"), + consume_type: ConsumeType::default(), + message_model: MessageModel::default(), + consume_from_where: ConsumeFromWhere::default(), + subscription_data_set: HashSet::new(), + unit_mode: false, + }; + + let mut hasher = DefaultHasher::new(); + consumer_data2.hash(&mut hasher); + let hash3 = hasher.finish(); + assert_eq!(hash1, hash3); + + // Test hash inequality for different instances + let consumer_data3 = ConsumerData { + group_name: CheetahString::from("group2"), + ..consumer_data1 + }; + + let mut hasher = DefaultHasher::new(); + consumer_data3.hash(&mut hasher); + let hash4 = hasher.finish(); + assert_ne!(hash1, hash4); }
53-153: Overall implementation looks good with room for enhancementThe test implementation successfully covers the basic functionality of ConsumerData, satisfying the PR objectives. The tests are well-structured and follow Rust testing practices. Consider implementing the suggested enhancements in future iterations to achieve more comprehensive test coverage.
For future improvements, consider:
- Adding property-based tests using frameworks like proptest
- Testing edge cases with large subscription sets
- Adding integration tests with other components that use ConsumerData
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
rocketmq-remoting/src/protocol/heartbeat/consumer_data.rs(1 hunks)
🔇 Additional comments (1)
rocketmq-remoting/src/protocol/heartbeat/consumer_data.rs (1)
53-64: LGTM! Well-structured test module setup
The test module is properly configured with the correct test attribute and includes all necessary imports.
Comment on lines
+105
to
+126
| #[test] | ||
| fn consumer_data_inequality() { | ||
| let consumer_data1 = ConsumerData { | ||
| group_name: CheetahString::from("group1"), | ||
| consume_type: ConsumeType::default(), | ||
| message_model: MessageModel::default(), | ||
| consume_from_where: ConsumeFromWhere::default(), | ||
| subscription_data_set: HashSet::new(), | ||
| unit_mode: false, | ||
| }; | ||
|
|
||
| let consumer_data2 = ConsumerData { | ||
| group_name: CheetahString::from("group2"), | ||
| consume_type: ConsumeType::default(), | ||
| message_model: MessageModel::default(), | ||
| consume_from_where: ConsumeFromWhere::default(), | ||
| subscription_data_set: HashSet::new(), | ||
| unit_mode: false, | ||
| }; | ||
|
|
||
| assert_ne!(consumer_data1, consumer_data2); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Expand inequality test coverage
The test only verifies inequality for different group names. Consider testing inequality for:
- Different consume_type values
- Different message_model values
- Different consume_from_where values
- Different subscription_data_set contents
- Different unit_mode values
#[test]
fn consumer_data_inequality() {
+ let base_consumer = ConsumerData {
+ group_name: CheetahString::from("group1"),
+ consume_type: ConsumeType::default(),
+ message_model: MessageModel::default(),
+ consume_from_where: ConsumeFromWhere::default(),
+ subscription_data_set: HashSet::new(),
+ unit_mode: false,
+ };
+
+ // Test inequality for each field
let consumer_data1 = ConsumerData {
- group_name: CheetahString::from("group1"),
- consume_type: ConsumeType::default(),
- message_model: MessageModel::default(),
- consume_from_where: ConsumeFromWhere::default(),
- subscription_data_set: HashSet::new(),
- unit_mode: false,
+ group_name: CheetahString::from("group2"),
+ ..base_consumer.clone()
};
+ assert_ne!(base_consumer, consumer_data1);
let consumer_data2 = ConsumerData {
- group_name: CheetahString::from("group2"),
- consume_type: ConsumeType::default(),
- message_model: MessageModel::default(),
- consume_from_where: ConsumeFromWhere::default(),
- subscription_data_set: HashSet::new(),
- unit_mode: false,
+ consume_type: ConsumeType::PASSIVELY,
+ ..base_consumer.clone()
};
+ assert_ne!(base_consumer, consumer_data2);
- assert_ne!(consumer_data1, consumer_data2);
+ let consumer_data3 = ConsumerData {
+ message_model: MessageModel::BROADCASTING,
+ ..base_consumer.clone()
+ };
+ assert_ne!(base_consumer, consumer_data3);
+
+ let mut subscription_set = HashSet::new();
+ let mut sub = SubscriptionData::default();
+ sub.topic = CheetahString::from("topic1");
+ subscription_set.insert(sub);
+ let consumer_data4 = ConsumerData {
+ subscription_data_set: subscription_set,
+ ..base_consumer.clone()
+ };
+ assert_ne!(base_consumer, consumer_data4);
+
+ let consumer_data5 = ConsumerData {
+ unit_mode: true,
+ ..base_consumer
+ };
+ assert_ne!(base_consumer, consumer_data5);
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| #[test] | |
| fn consumer_data_inequality() { | |
| let consumer_data1 = ConsumerData { | |
| group_name: CheetahString::from("group1"), | |
| consume_type: ConsumeType::default(), | |
| message_model: MessageModel::default(), | |
| consume_from_where: ConsumeFromWhere::default(), | |
| subscription_data_set: HashSet::new(), | |
| unit_mode: false, | |
| }; | |
| let consumer_data2 = ConsumerData { | |
| group_name: CheetahString::from("group2"), | |
| consume_type: ConsumeType::default(), | |
| message_model: MessageModel::default(), | |
| consume_from_where: ConsumeFromWhere::default(), | |
| subscription_data_set: HashSet::new(), | |
| unit_mode: false, | |
| }; | |
| assert_ne!(consumer_data1, consumer_data2); | |
| } | |
| #[test] | |
| fn consumer_data_inequality() { | |
| let base_consumer = ConsumerData { | |
| group_name: CheetahString::from("group1"), | |
| consume_type: ConsumeType::default(), | |
| message_model: MessageModel::default(), | |
| consume_from_where: ConsumeFromWhere::default(), | |
| subscription_data_set: HashSet::new(), | |
| unit_mode: false, | |
| }; | |
| // Test inequality for each field | |
| let consumer_data1 = ConsumerData { | |
| group_name: CheetahString::from("group2"), | |
| ..base_consumer.clone() | |
| }; | |
| assert_ne!(base_consumer, consumer_data1); | |
| let consumer_data2 = ConsumerData { | |
| consume_type: ConsumeType::PASSIVELY, | |
| ..base_consumer.clone() | |
| }; | |
| assert_ne!(base_consumer, consumer_data2); | |
| let consumer_data3 = ConsumerData { | |
| message_model: MessageModel::BROADCASTING, | |
| ..base_consumer.clone() | |
| }; | |
| assert_ne!(base_consumer, consumer_data3); | |
| let mut subscription_set = HashSet::new(); | |
| let mut sub = SubscriptionData::default(); | |
| sub.topic = CheetahString::from("topic1"); | |
| subscription_set.insert(sub); | |
| let consumer_data4 = ConsumerData { | |
| subscription_data_set: subscription_set, | |
| ..base_consumer.clone() | |
| }; | |
| assert_ne!(base_consumer, consumer_data4); | |
| let consumer_data5 = ConsumerData { | |
| unit_mode: true, | |
| ..base_consumer | |
| }; | |
| assert_ne!(base_consumer, consumer_data5); | |
| } |
TeslaRustor
approved these changes
Nov 26, 2024
rocketmq-rust-bot
added
approved
This was referenced Nov 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Which Issue(s) This PR Fixes(Closes)
Fixes #1328
Brief Description
How Did You Test This Change?
Summary by CodeRabbit
ConsumerDatastruct.ConsumerDatainstances.