Add unit tests to priority_collector

Author: HoOngEe

Diff for: core/src/consensus/tendermint/priority_collector.rs

@@ -28,6 +28,7 @@ pub struct PriorityCollector {
     priorities: BTreeMap<SortitionRound, BinaryHeap<PriorityInfoSummary>>,
 }
 
+#[cfg_attr(test, derive(Debug))]
 #[derive(Eq, PartialEq)]
 pub struct PriorityInfoSummary {
     priority: Priority,
@@ -75,3 +76,83 @@ impl PriorityCollector {
         self.priorities = new_collector;
     }
 }
+
+#[cfg(test)]
+mod priority_collector_tests {
+    use super::*;
+    use crate::consensus::PriorityInfo;
+    #[test]
+    fn compare_priority_info_summary1() {
+        let greater_priority_info_summary = PriorityInfoSummary {
+            priority: 0xffu64.into(),
+            signer_idx: 0,
+        };
+        let less_priority_info_summary = PriorityInfoSummary {
+            priority: 0x7fu64.into(),
+            signer_idx: 1,
+        };
+        assert!(greater_priority_info_summary > less_priority_info_summary);
+    }
+
+    #[test]
+    fn compare_priority_info_summary2() {
+        let greater_priority_info_summary = PriorityInfoSummary {
+            priority: 0x55555544u64.into(),
+            signer_idx: 0,
+        };
+        let less_priority_info_summary = PriorityInfoSummary {
+            priority: 0x55555523u64.into(),
+            signer_idx: 22,
+        };
+        assert!(greater_priority_info_summary > less_priority_info_summary);
+    }
+
+    fn add_fixed_priorities(collector: &mut PriorityCollector, round: SortitionRound) {
+        let priority_messages = [0x55u64, 0xffu64, 0x44u64, 0xeeu64].into_iter().map(|priority| {
+            let info = PriorityInfo::create_from_members((*priority).into(), 1, vec![], vec![]);
+            PriorityMessage {
+                seed: 0xffffu64.into(),
+                info,
+            }
+        });
+        priority_messages
+            .zip([1, 2, 3, 4].iter())
+            .for_each(|(message, signer_idx)| collector.insert(&message, *signer_idx, round));
+    }
+
+    #[test]
+    fn insert_and_get_highest() {
+        let mut collector: PriorityCollector = Default::default();
+        let round = SortitionRound {
+            height: 1,
+            view: 0,
+        };
+        add_fixed_priorities(&mut collector, round);
+        assert_eq!(collector.get_highest_priority(round).unwrap(), PriorityInfoSummary {
+            priority: 0xffu64.into(),
+            signer_idx: 2,
+        });
+    }
+
+    #[test]
+    fn throw_away_old() {
+        let mut collector: PriorityCollector = Default::default();
+        let rounds = [(1, 0), (3, 1), (5, 2), (100, 7), (0, 8)].into_iter().map(|(height, view)| SortitionRound {
+            height: *height,
+            view: *view,
+        });
+        rounds.clone().for_each(|round| add_fixed_priorities(&mut collector, round));
+        let target_round = SortitionRound {
+            height: 5,
+            view: 2,
+        };
+        collector.throw_away_old(&target_round);
+        rounds
+            .clone()
+            .filter(|round| round >= &target_round)
+            .for_each(|round_gte| assert!(collector.get_highest_priority(round_gte).is_some()));
+        rounds
+            .filter(|round| round < &target_round)
+            .for_each(|round_lt| assert!(collector.get_highest_priority(round_lt).is_none()))
+    }
+}