Add assert_log method to Logger trait to harden test

Extend visibility of ChannelManager logger for test only

Author: Antoine Riard

fuzz/src/full_stack.rs

@@ -553,6 +553,8 @@ mod tests {
 			*self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 			println!("{:<5} [{} : {}, {}] {}", record.level.to_string(), record.module_path, record.file, record.line, record.args);
 		}
+
+		fn assert_log(&self, module: String, line: String, count: usize) {}
 	}
 
 	#[test]

fuzz/src/utils/test_logger.rs

@@ -20,4 +20,5 @@ impl Logger for TestLogger {
 		#[cfg(not(test))]
 		let _ = format!("{}", record.args);
 	}
+	fn assert_log(&self, module: String, line: String, count: usize) {}
 }

lightning/src/ln/channelmanager.rs

@@ -354,6 +354,9 @@ pub struct ChannelManager<ChanSigner: ChannelKeys> {
 
 	keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
 
+	#[cfg(test)]
+	pub(super) logger: Arc<Logger>,
+	#[cfg(not(test))]
 	logger: Arc<Logger>,
 }
 

lightning/src/util/logger.rs

@@ -119,6 +119,8 @@ impl<'a> Record<'a> {
 pub trait Logger: Sync + Send {
 	/// Logs the `Record`
 	fn log(&self, record: &Record);
+	/// Assert log count (used to harden test)
+	fn assert_log(&self, module: String, line: String, count: usize);
 }
 
 pub(crate) struct LogHolder<'a> { pub(crate) logger: &'a Arc<Logger> }

lightning/src/util/test_utils.rs

@@ -22,6 +22,7 @@ use secp256k1::{SecretKey, PublicKey};
 use std::time::{SystemTime, UNIX_EPOCH};
 use std::sync::{Arc,Mutex};
 use std::{mem};
+use std::collections::HashMap;
 
 pub struct TestVecWriter(pub Vec<u8>);
 impl Writer for TestVecWriter {
@@ -190,6 +191,7 @@ impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
 pub struct TestLogger {
 	level: Level,
 	id: String,
+	pub lines: Mutex<HashMap<(String, String), usize>>,
 }
 
 impl TestLogger {
@@ -200,6 +202,7 @@ impl TestLogger {
 		TestLogger {
 			level: Level::Trace,
 			id,
+			lines: Mutex::new(HashMap::new())
 		}
 	}
 	pub fn enable(&mut self, level: Level) {
@@ -209,10 +212,16 @@ impl TestLogger {
 
 impl Logger for TestLogger {
 	fn log(&self, record: &Record) {
+		*self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 		if self.level >= record.level {
 			println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
 		}
 	}
+
+	fn assert_log(&self, module: String, line: String, count: usize) {
+		let log_entries = self.lines.lock().unwrap();
+		assert_eq!(log_entries.get(&(module, line)), Some(&count));
+	}
 }
 
 pub struct TestKeysInterface {