Merge pull request #1145 from tnull/add_gossip_log_level

[rust-lightning] / lightning / src / util / logger.rs

diff --git a/lightning/src/util/logger.rs b/lightning/src/util/logger.rs
index acd6d323e8f319e9b3c84550ab099d2258f486cb..103f89891cf30115c238f0a9494379c8e6719169 100644 (file)
--- a/lightning/src/util/logger.rs
+++ b/lightning/src/util/logger.rs
@@ -14,26 +14,26 @@
 //! The second one, client-side by implementing check against Record Level field.
 //! Each module may have its own Logger or share one.
 
-use std::cmp;
-use std::fmt;
+use core::cmp;
+use core::fmt;
 
-static LOG_LEVEL_NAMES: [&'static str; 6] = ["OFF", "ERROR", "WARN", "INFO", "DEBUG", "TRACE"];
+static LOG_LEVEL_NAMES: [&'static str; 6] = ["GOSSIP", "TRACE", "DEBUG", "INFO", "WARN", "ERROR"];
 
 /// An enum representing the available verbosity levels of the logger.
 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
 pub enum Level {
-       ///Designates logger being silent
-       Off,
-       /// Designates very serious errors
-       Error,
-       /// Designates hazardous situations
-       Warn,
-       /// Designates useful information
-       Info,
-       /// Designates lower priority information
-       Debug,
+       /// Designates extremely verbose information, including gossip-induced messages
+       Gossip,
        /// Designates very low priority, often extremely verbose, information
        Trace,
+       /// Designates lower priority information
+       Debug,
+       /// Designates useful information
+       Info,
+       /// Designates hazardous situations
+       Warn,
+       /// Designates very serious errors
+       Error,
 }
 
 impl PartialOrd for Level {
@@ -80,7 +80,7 @@ impl Level {
        /// Returns the most verbose logging level.
        #[inline]
        pub fn max() -> Level {
-               Level::Trace
+               Level::Gossip
        }
 }
 
@@ -117,16 +117,29 @@ impl<'a> Record<'a> {
 }
 
 /// A trait encapsulating the operations required of a logger
-pub trait Logger: Sync + Send {
+pub trait Logger {
        /// Logs the `Record`
        fn log(&self, record: &Record);
 }
 
+/// Wrapper for logging byte slices in hex format.
+/// (C-not exported) as fmt can't be used in C
+#[doc(hidden)]
+pub struct DebugBytes<'a>(pub &'a [u8]);
+impl<'a> core::fmt::Display for DebugBytes<'a> {
+       fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+               for i in self.0 {
+                       write!(f, "{:02x}", i)?;
+               }
+               Ok(())
+       }
+}
+
 #[cfg(test)]
 mod tests {
        use util::logger::{Logger, Level};
        use util::test_utils::TestLogger;
-       use std::sync::Arc;
+       use sync::Arc;
 
        #[test]
        fn test_level_show() {
@@ -152,15 +165,53 @@ mod tests {
                        log_info!(self.logger, "This is an info");
                        log_debug!(self.logger, "This is a debug");
                        log_trace!(self.logger, "This is a trace");
+                       log_gossip!(self.logger, "This is a gossip");
                }
        }
 
        #[test]
        fn test_logging_macros() {
                let mut logger = TestLogger::new();
-               logger.enable(Level::Trace);
+               logger.enable(Level::Gossip);
                let logger : Arc<Logger> = Arc::new(logger);
                let wrapper = WrapperLog::new(Arc::clone(&logger));
                wrapper.call_macros();
        }
+
+       #[test]
+       fn test_log_ordering() {
+               assert!(Level::Error > Level::Warn);
+               assert!(Level::Error >= Level::Warn);
+               assert!(Level::Error >= Level::Error);
+               assert!(Level::Warn > Level::Info);
+               assert!(Level::Warn >= Level::Info);
+               assert!(Level::Warn >= Level::Warn);
+               assert!(Level::Info > Level::Debug);
+               assert!(Level::Info >= Level::Debug);
+               assert!(Level::Info >= Level::Info);
+               assert!(Level::Debug > Level::Trace);
+               assert!(Level::Debug >= Level::Trace);
+               assert!(Level::Debug >= Level::Debug);
+               assert!(Level::Trace > Level::Gossip);
+               assert!(Level::Trace >= Level::Gossip);
+               assert!(Level::Trace >= Level::Trace);
+               assert!(Level::Gossip >= Level::Gossip);
+
+               assert!(Level::Error <= Level::Error);
+               assert!(Level::Warn < Level::Error);
+               assert!(Level::Warn <= Level::Error);
+               assert!(Level::Warn <= Level::Warn);
+               assert!(Level::Info < Level::Warn);
+               assert!(Level::Info <= Level::Warn);
+               assert!(Level::Info <= Level::Info);
+               assert!(Level::Debug < Level::Info);
+               assert!(Level::Debug <= Level::Info);
+               assert!(Level::Debug <= Level::Debug);
+               assert!(Level::Trace < Level::Debug);
+               assert!(Level::Trace <= Level::Debug);
+               assert!(Level::Trace <= Level::Trace);
+               assert!(Level::Gossip < Level::Trace);
+               assert!(Level::Gossip <= Level::Trace);
+               assert!(Level::Gossip <= Level::Gossip);
+       }
 }