2 releases
0.0.2 | Jul 13, 2024 |
---|---|
0.0.1 | Jul 12, 2024 |
#337 in Command-line interface
23 downloads per month
15KB
129 lines
r3bl_test_fixtures
This is a test fixtures library that provides reusable components for testing. It is
meant to be used by all the crates in the r3bl-open-core
monorepo. This crate is
intended to be a
dev-dependency
for other creates in the monorepo.
It provides fixtures to test async streams and stdout. This allows TUI frameworks to be tested "end to end".
- The async stream fixtures are used to test the input stream of a TUI framework.
- The stdout fixtures are used to test the output of a TUI framework.
async_stream_fixtures
Here's an example of how create a stream of T
from a Vec<T>
.
#[tokio::test]
async fn test_gen_input_stream() {
use futures_util::StreamExt;
use r3bl_test_fixtures::gen_input_stream;
let mut input_stream = gen_input_stream(vec![1, 2, 3]);
for _ in 1..=3 {
input_stream.next().await;
}
pretty_assertions::assert_eq!(input_stream.next().await, None);
}
Here's another example of how to use this with a delay.
#[tokio::test]
async fn test_gen_input_stream_with_delay() {
use futures_util::StreamExt;
use r3bl_test_fixtures::gen_input_stream_with_delay;
let delay = 100;
// Start timer.
let start_time = std::time::Instant::now();
let mut input_stream = gen_input_stream_with_delay(vec![1, 2, 3], Duration::from_millis(delay));
for _ in 1..=3 {
input_stream.next().await;
}
// End timer.
let end_time = std::time::Instant::now();
pretty_assertions::assert_eq!(input_stream.next().await, None);
assert!(end_time - start_time >= Duration::from_millis(delay * 3));
}
stdout_fixtures
Here's an example of how to use this.
#[tokio::test]
async fn test_stdout_mock_no_strip_ansi() {
use strip_ansi_escapes::strip;
use super::*;
use std::{
io::{Result, Write},
sync::Arc,
};
let mut stdout_mock = StdoutMock::default();
let stdout_mock_clone = stdout_mock.clone(); // Points to the same inner value as `stdout_mock`.
let normal_text = "hello world";
stdout_mock.write_all(normal_text.as_bytes()).unwrap();
stdout_mock.flush().unwrap();
pretty_assertions::assert_eq!(stdout_mock.get_copy_of_buffer_as_string(), normal_text);
pretty_assertions::assert_eq!(
stdout_mock_clone.get_copy_of_buffer_as_string(),
normal_text
);
}
Dependencies
~9–16MB
~201K SLoC