forked from torrust/torrust-tracker
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This feature will be used in the future to write assertions about logs. It also changes when we show logs running tests. If you run tests with: ```console cargo test ``` logs win't be showed. If you want to see logs you have to execute tests with: ```console cargo test -- --nocapture ```
- Loading branch information
1 parent
4a9dcef
commit d11ab32
Showing
15 changed files
with
302 additions
and
438 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,156 @@ | ||
| #![allow(clippy::doc_markdown)] | ||
| //! Logging for the Integration Tests | ||
| //! | ||
| //! Tests should start their own logging. | ||
| //! | ||
| //! To find tests that do not start their own logging: | ||
| //! | ||
| //! ´´´ sh | ||
| //! awk 'BEGIN{RS=""; FS="\n"} /#\[tokio::test\]\s*async\s+fn\s+\w+\s*\(\s*\)\s*\{[^}]*\}/ && !/#\[tokio::test\]\s*async\s+fn\s+\w+\s*\(\s*\)\s*\{[^}]*INIT\.call_once/' $(find . -name "*.rs") | ||
| //! ´´´ | ||
| //! | ||
| use std::sync::Once; | ||
| //! Setup for logging in tests. | ||
| use std::collections::VecDeque; | ||
| use std::io; | ||
| use std::sync::{Mutex, MutexGuard, Once, OnceLock}; | ||
|
|
||
| use torrust_tracker::bootstrap::logging::TraceStyle; | ||
| use tracing::level_filters::LevelFilter; | ||
| use tracing_subscriber::fmt::MakeWriter; | ||
|
|
||
| #[allow(dead_code)] | ||
| pub static INIT: Once = Once::new(); | ||
| static INIT: Once = Once::new(); | ||
|
|
||
| /// A global buffer containing the latest lines captured from logs. | ||
| #[doc(hidden)] | ||
| pub fn captured_logs_buffer() -> &'static Mutex<CircularBuffer> { | ||
| static CAPTURED_LOGS_GLOBAL_BUFFER: OnceLock<Mutex<CircularBuffer>> = OnceLock::new(); | ||
| CAPTURED_LOGS_GLOBAL_BUFFER.get_or_init(|| Mutex::new(CircularBuffer::new(10000, 200))) | ||
| } | ||
|
|
||
| pub fn setup() { | ||
| INIT.call_once(|| { | ||
| tracing_init(LevelFilter::ERROR, &TraceStyle::Default); | ||
| }); | ||
| } | ||
|
|
||
| fn tracing_init(level_filter: LevelFilter, style: &TraceStyle) { | ||
| let mock_writer = LogCapturer::new(captured_logs_buffer()); | ||
|
|
||
| #[allow(dead_code)] | ||
| pub fn tracing_stderr_init(filter: LevelFilter) { | ||
| let builder = tracing_subscriber::fmt() | ||
| .with_max_level(filter) | ||
| .with_max_level(level_filter) | ||
| .with_ansi(true) | ||
| .with_writer(std::io::stderr); | ||
| .with_test_writer() | ||
| .with_writer(mock_writer); | ||
|
|
||
| builder.pretty().with_file(true).init(); | ||
| let () = match style { | ||
| TraceStyle::Default => builder.init(), | ||
| TraceStyle::Pretty(display_filename) => builder.pretty().with_file(*display_filename).init(), | ||
| TraceStyle::Compact => builder.compact().init(), | ||
| TraceStyle::Json => builder.json().init(), | ||
| }; | ||
|
|
||
| tracing::info!("Logging initialized"); | ||
| } | ||
|
|
||
| /// It returns true is there is a log line containing all the texts passed. | ||
| /// | ||
| /// # Panics | ||
| /// | ||
| /// Will panic if it can't get the lock for the global buffer or convert it into | ||
| /// a vec. | ||
| #[must_use] | ||
| #[allow(dead_code)] | ||
| pub fn logs_contains_a_line_with(texts: &[&str]) -> bool { | ||
| // code-review: we can search directly in the buffer instead of converting | ||
| // the buffer into a string but that would slow down the tests because | ||
| // cloning should be faster that locking the buffer for searching. | ||
| // Because the buffer is not big. | ||
| let logs = String::from_utf8(captured_logs_buffer().lock().unwrap().as_vec()).unwrap(); | ||
|
|
||
| for line in logs.split('\n') { | ||
| if contains(line, texts) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| false | ||
| } | ||
|
|
||
| #[allow(dead_code)] | ||
| fn contains(text: &str, texts: &[&str]) -> bool { | ||
| texts.iter().all(|&word| text.contains(word)) | ||
| } | ||
|
|
||
| /// A tracing writer which captures the latests logs lines into a buffer. | ||
| /// It's used to capture the logs in the tests. | ||
| #[derive(Debug)] | ||
| pub struct LogCapturer<'a> { | ||
| logs: &'a Mutex<CircularBuffer>, | ||
| } | ||
|
|
||
| impl<'a> LogCapturer<'a> { | ||
| pub fn new(buf: &'a Mutex<CircularBuffer>) -> Self { | ||
| Self { logs: buf } | ||
| } | ||
|
|
||
| fn buf(&self) -> io::Result<MutexGuard<'a, CircularBuffer>> { | ||
| self.logs.lock().map_err(|_| io::Error::from(io::ErrorKind::Other)) | ||
| } | ||
| } | ||
|
|
||
| impl io::Write for LogCapturer<'_> { | ||
| fn write(&mut self, buf: &[u8]) -> io::Result<usize> { | ||
| print!("{}", String::from_utf8(buf.to_vec()).unwrap()); | ||
|
|
||
| let mut target = self.buf()?; | ||
|
|
||
| target.write(buf) | ||
| } | ||
|
|
||
| fn flush(&mut self) -> io::Result<()> { | ||
| self.buf()?.flush() | ||
| } | ||
| } | ||
|
|
||
| impl MakeWriter<'_> for LogCapturer<'_> { | ||
| type Writer = Self; | ||
|
|
||
| fn make_writer(&self) -> Self::Writer { | ||
| LogCapturer::new(self.logs) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Debug)] | ||
| pub struct CircularBuffer { | ||
| max_size: usize, | ||
| buffer: VecDeque<u8>, | ||
| } | ||
|
|
||
| impl CircularBuffer { | ||
| #[must_use] | ||
| pub fn new(max_lines: usize, average_line_size: usize) -> Self { | ||
| Self { | ||
| max_size: max_lines * average_line_size, | ||
| buffer: VecDeque::with_capacity(max_lines * average_line_size), | ||
| } | ||
| } | ||
|
|
||
| /// # Errors | ||
| /// | ||
| /// Won't return any error. | ||
| #[allow(clippy::unnecessary_wraps)] | ||
| pub fn write(&mut self, buf: &[u8]) -> io::Result<usize> { | ||
| for &byte in buf { | ||
| if self.buffer.len() == self.max_size { | ||
| // Remove oldest byte to make space | ||
| self.buffer.pop_front(); | ||
| } | ||
| self.buffer.push_back(byte); | ||
| } | ||
|
|
||
| Ok(buf.len()) | ||
| } | ||
|
|
||
| /// # Errors | ||
| /// | ||
| /// Won't return any error. | ||
| #[allow(clippy::unnecessary_wraps)] | ||
| #[allow(clippy::unused_self)] | ||
| pub fn flush(&mut self) -> io::Result<()> { | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[must_use] | ||
| pub fn as_vec(&self) -> Vec<u8> { | ||
| self.buffer.iter().copied().collect() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.