Add basic testing of EventQueue

Author: tnull

src/event.rs

@@ -32,8 +32,8 @@ pub(crate) const EVENTS_PERSISTENCE_KEY: &str = "events";
 /// An event emitted by [`LdkLite`] that should be handled by the user.
 ///
 /// [`LdkLite`]: [`crate::LdkLite`]
-#[derive(Debug, Clone)]
-pub enum LdkLiteEvent {
+#[derive(Debug, Clone, PartialEq)]
+pub enum Event {
 	/// A payment we sent was successful.
 	PaymentSuccessful {
 		/// The hash of the payment.
@@ -564,3 +564,29 @@ impl LdkEventHandler for LdkLiteEventHandler {
 		}
 	}
 }
+
+#[cfg(test)]
+mod tests {
+	use super::*;
+	use crate::test_utils::TestPersister;
+
+	#[test]
+	fn event_queue_persistence() {
+		let test_persister = Arc::new(TestPersister::new());
+		let event_queue = EventQueue::new(Arc::clone(&test_persister));
+
+		let expected_event = Event::ChannelReady { channel_id: [23u8; 32], user_channel_id: 2323 };
+		event_queue.add_event(expected_event.clone()).unwrap();
+		assert!(test_persister.get_and_clear_pending_persist());
+
+		// Check we get the expected event and that it is returned until we mark it handled.
+		for _ in 0..5 {
+			assert_eq!(event_queue.next_event(), expected_event);
+			assert_eq!(false, test_persister.get_and_clear_pending_persist());
+		}
+
+		// Check we persisted on `event_handled()`
+		event_queue.event_handled().unwrap();
+		assert!(test_persister.get_and_clear_pending_persist());
+	}
+}

src/test_utils.rs

@@ -0,0 +1,26 @@
+use lightning::util::persist::KVStorePersister;
+use lightning::util::ser::Writeable;
+
+use std::sync::atomic::{AtomicBool, Ordering};
+
+pub(crate) struct TestPersister {
+	pending_persist: AtomicBool,
+}
+
+impl TestPersister {
+	pub fn new() -> Self {
+		let pending_persist = AtomicBool::new(false);
+		Self { pending_persist }
+	}
+
+	pub fn get_and_clear_pending_persist(&self) -> bool {
+		self.pending_persist.swap(false, Ordering::SeqCst)
+	}
+}
+
+impl KVStorePersister for TestPersister {
+	fn persist<W: Writeable>(&self, _key: &str, _object: &W) -> std::io::Result<()> {
+		self.pending_persist.store(true, Ordering::SeqCst);
+		Ok(())
+	}
+}