BEEFY add tests for rounds (#10328)

* new_rounds()

* WIP

* test add_vote()

* test drop()

* learn  to spell

* go get some coffee

* cargo fmt

* lump everythings together again

substrate/client/beefy/src/round.rs

@@ -123,3 +123,154 @@ where
 		)
 	}
 }
+
+#[cfg(test)]
+mod tests {
+	use sc_network_test::Block;
+	use sp_core::H256;
+	use sp_runtime::traits::NumberFor;
+
+	use beefy_primitives::{crypto::Public, ValidatorSet};
+
+	use super::Rounds;
+	use crate::keystore::tests::Keyring;
+
+	#[test]
+	fn new_rounds() {
+		sp_tracing::try_init_simple();
+
+		let rounds = Rounds::<H256, NumberFor<Block>>::new(ValidatorSet::<Public>::empty());
+
+		assert_eq!(0, rounds.validator_set_id());
+		assert!(rounds.validators().is_empty());
+
+		let validators = ValidatorSet::<Public> {
+			validators: vec![
+				Keyring::Alice.public(),
+				Keyring::Bob.public(),
+				Keyring::Charlie.public(),
+			],
+			id: 42,
+		};
+
+		let rounds = Rounds::<H256, NumberFor<Block>>::new(validators);
+
+		assert_eq!(42, rounds.validator_set_id());
+
+		assert_eq!(
+			vec![Keyring::Alice.public(), Keyring::Bob.public(), Keyring::Charlie.public()],
+			rounds.validators()
+		);
+	}
+
+	#[test]
+	fn add_vote() {
+		sp_tracing::try_init_simple();
+
+		let validators = ValidatorSet::<Public> {
+			validators: vec![
+				Keyring::Alice.public(),
+				Keyring::Bob.public(),
+				Keyring::Charlie.public(),
+			],
+			id: Default::default(),
+		};
+
+		let mut rounds = Rounds::<H256, NumberFor<Block>>::new(validators);
+
+		assert!(rounds.add_vote(
+			(H256::from_low_u64_le(1), 1),
+			(Keyring::Alice.public(), Keyring::Alice.sign(b"I am committed"))
+		));
+
+		assert!(!rounds.is_done(&(H256::from_low_u64_le(1), 1)));
+
+		// invalid vote
+		assert!(!rounds.add_vote(
+			(H256::from_low_u64_le(1), 1),
+			(Keyring::Dave.public(), Keyring::Dave.sign(b"I am committed"))
+		));
+
+		assert!(!rounds.is_done(&(H256::from_low_u64_le(1), 1)));
+
+		assert!(rounds.add_vote(
+			(H256::from_low_u64_le(1), 1),
+			(Keyring::Bob.public(), Keyring::Bob.sign(b"I am committed"))
+		));
+
+		assert!(!rounds.is_done(&(H256::from_low_u64_le(1), 1)));
+
+		assert!(rounds.add_vote(
+			(H256::from_low_u64_le(1), 1),
+			(Keyring::Charlie.public(), Keyring::Charlie.sign(b"I am committed"))
+		));
+
+		assert!(rounds.is_done(&(H256::from_low_u64_le(1), 1)));
+	}
+
+	#[test]
+	fn drop() {
+		sp_tracing::try_init_simple();
+
+		let validators = ValidatorSet::<Public> {
+			validators: vec![
+				Keyring::Alice.public(),
+				Keyring::Bob.public(),
+				Keyring::Charlie.public(),
+			],
+			id: Default::default(),
+		};
+
+		let mut rounds = Rounds::<H256, NumberFor<Block>>::new(validators);
+
+		// round 1
+		rounds.add_vote(
+			(H256::from_low_u64_le(1), 1),
+			(Keyring::Alice.public(), Keyring::Alice.sign(b"I am committed")),
+		);
+		rounds.add_vote(
+			(H256::from_low_u64_le(1), 1),
+			(Keyring::Bob.public(), Keyring::Bob.sign(b"I am committed")),
+		);
+
+		// round 2
+		rounds.add_vote(
+			(H256::from_low_u64_le(2), 2),
+			(Keyring::Alice.public(), Keyring::Alice.sign(b"I am again committed")),
+		);
+		rounds.add_vote(
+			(H256::from_low_u64_le(2), 2),
+			(Keyring::Bob.public(), Keyring::Bob.sign(b"I am again committed")),
+		);
+
+		// round 3
+		rounds.add_vote(
+			(H256::from_low_u64_le(3), 3),
+			(Keyring::Alice.public(), Keyring::Alice.sign(b"I am still committed")),
+		);
+		rounds.add_vote(
+			(H256::from_low_u64_le(3), 3),
+			(Keyring::Bob.public(), Keyring::Bob.sign(b"I am still committed")),
+		);
+
+		assert_eq!(3, rounds.rounds.len());
+
+		// drop unknown round
+		assert!(rounds.drop(&(H256::from_low_u64_le(5), 5)).is_none());
+		assert_eq!(3, rounds.rounds.len());
+
+		// drop round 2
+		let signatures = rounds.drop(&(H256::from_low_u64_le(2), 2)).unwrap();
+
+		assert_eq!(2, rounds.rounds.len());
+
+		assert_eq!(
+			signatures,
+			vec![
+				Some(Keyring::Alice.sign(b"I am again committed")),
+				Some(Keyring::Bob.sign(b"I am again committed")),
+				None
+			]
+		);
+	}
+}