Skip to content

[ISSUE #1152] Add test case for MessageQueue #1153

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions rocketmq-common/src/common/message/message_queue.rs
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,82 @@ impl Default for MessageQueue {
MessageQueue::new()
}
}

#[cfg(test)]
mod test {
use super::*;

#[test]
fn new_message_queue_has_default_values() {
let mq = MessageQueue::new();
assert_eq!(mq.get_topic(), "");
assert_eq!(mq.get_broker_name(), "");
assert_eq!(mq.get_queue_id(), 0);
}

#[test]
fn from_other_creates_identical_copy() {
let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
let mq2 = MessageQueue::from_other(&mq1);
assert_eq!(mq1, mq2);
}

#[test]
fn from_parts_creates_message_queue_with_given_values() {
let mq = MessageQueue::from_parts("topic1", "broker1", 1);
assert_eq!(mq.get_topic(), "topic1");
assert_eq!(mq.get_broker_name(), "broker1");
assert_eq!(mq.get_queue_id(), 1);
}

#[test]
fn set_topic_updates_topic() {
let mut mq = MessageQueue::new();
mq.set_topic(CheetahString::from("new_topic"));
assert_eq!(mq.get_topic(), "new_topic");
}

#[test]
fn set_broker_name_updates_broker_name() {
let mut mq = MessageQueue::new();
mq.set_broker_name(CheetahString::from("new_broker"));
assert_eq!(mq.get_broker_name(), "new_broker");
}

#[test]
fn set_queue_id_updates_queue_id() {
let mut mq = MessageQueue::new();
mq.set_queue_id(10);
assert_eq!(mq.get_queue_id(), 10);
}

#[test]
fn message_queue_equality() {
let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
let mq2 = MessageQueue::from_parts("topic1", "broker1", 1);
assert_eq!(mq1, mq2);
}

#[test]
fn message_queue_inequality() {
let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
let mq2 = MessageQueue::from_parts("topic2", "broker2", 2);
assert_ne!(mq1, mq2);
}

#[test]
fn message_queue_ordering() {
let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
let mq2 = MessageQueue::from_parts("topic1", "broker1", 2);
assert!(mq1 < mq2);
}
Comment on lines +206 to +211
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance ordering test coverage.

The current test only verifies ordering based on queue_id. Consider adding tests for:

  • Ordering by topic
  • Ordering by broker_name
  • Different combinations of fields

Here's a suggested implementation:

 #[test]
 fn message_queue_ordering() {
     let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
     let mq2 = MessageQueue::from_parts("topic1", "broker1", 2);
+    let mq3 = MessageQueue::from_parts("topic2", "broker1", 1);
+    let mq4 = MessageQueue::from_parts("topic1", "broker2", 1);
     assert!(mq1 < mq2);
+    assert!(mq1 < mq3);
+    assert!(mq1 < mq4);
 }
📝 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 message_queue_ordering() {
let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
let mq2 = MessageQueue::from_parts("topic1", "broker1", 2);
assert!(mq1 < mq2);
}
#[test]
fn message_queue_ordering() {
let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
let mq2 = MessageQueue::from_parts("topic1", "broker1", 2);
let mq3 = MessageQueue::from_parts("topic2", "broker1", 1);
let mq4 = MessageQueue::from_parts("topic1", "broker2", 1);
assert!(mq1 < mq2);
assert!(mq1 < mq3);
assert!(mq1 < mq4);
}


#[test]
fn message_queue_display_format() {
let mq = MessageQueue::from_parts("topic1", "broker1", 1);
assert_eq!(
format!("{}", mq),
"MessageQueue [topic=topic1, broker_name=broker1, queue_id=1]"
);
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add tests for Hash and Default implementations.

The MessageQueue struct implements both Hash and Default traits, but these aren't explicitly tested.

Add these test cases:

#[test]
fn test_hash_implementation() {
    use std::collections::HashSet;
    
    let mq1 = MessageQueue::from_parts("topic1", "broker1", 1);
    let mq2 = MessageQueue::from_parts("topic1", "broker1", 1);
    let mq3 = MessageQueue::from_parts("topic2", "broker1", 1);
    
    let mut set = HashSet::new();
    set.insert(mq1);
    assert!(!set.insert(mq2)); // Should return false as equivalent item exists
    assert!(set.insert(mq3));  // Should return true as this is a new item
}

#[test]
fn test_default_matches_new() {
    let default_mq = MessageQueue::default();
    let new_mq = MessageQueue::new();
    assert_eq!(default_mq, new_mq);
}

Loading