Archives/bat
2
0
Fork 0
mirror of https://github.com/sharkdp/bat synced 2024-11-16 21:25:56 +00:00
Code Issues Projects Releases Wiki Activity

tests: Move 'mocked pagers' utils to separate file

Browse Source
This commit is contained in:
Martin Nordholts 2021-01-10 14:05:39 +01:00
parent 7809008016
commit eda72c31b2
3 changed files with 84 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
tests/integration_tests.rs
View File

@ -2,15 +2,17 @@ use assert_cmd::assert::OutputAssertExt;
use assert_cmd::cargo::CommandCargoExt;
use predicates::{prelude::predicate, str::PredicateStrExt};
use serial_test::serial;
use std::env;
use std::fs::File;
use std::path::{Path, PathBuf};
use std::path::Path;
use std::process::{Command, Stdio};
use std::str::from_utf8;
#[cfg(unix)]
use std::time::Duration;
mod utils;
use utils::mocked_pagers;
const EXAMPLES_DIR: &str = "tests/examples";
#[cfg(unix)]
@ -41,71 +43,6 @@ fn bat() -> assert_cmd::Command {
cmd
}
/// For some tests we want mocked versions of some pagers
/// This fn returns the absolute path to the directory with these mocked pagers
fn get_mocked_pagers_dir() -> PathBuf {
let cargo_manifest_dir = env::var("CARGO_MANIFEST_DIR").expect("Missing CARGO_MANIFEST_DIR");
Path::new(&cargo_manifest_dir)
.join("tests")
.join("mocked-pagers")
}
/// On Unix: 'most' -> 'most'
/// On Windows: 'most' -> 'most.bat'
fn mocked_pager(base: &str) -> String {
if cfg!(windows) {
format!("{}.bat", base)
} else {
String::from(base)
}
}
/// Prepends a directory to the PATH environment variable
/// Returns the original value for later restoration
fn prepend_dir_to_path_env_var(dir: PathBuf) -> String {
// Get current PATH
let original_path = env::var("PATH").expect("No PATH?!");
// Add the new dir first
let mut split_paths = env::split_paths(&original_path).collect::<Vec<_>>();
split_paths.insert(0, dir);
// Set PATH with the new dir
let new_path = env::join_paths(split_paths).expect("Failed to join paths");
env::set_var("PATH", new_path);
// Return the original value for later restoration of it
original_path
}
/// Helper to restore the value of PATH
fn restore_path(original_path: String) {
env::set_var("PATH", original_path);
}
/// Allows test to run that require our mocked versions of 'more' and 'most'
/// in PATH. Temporarily changes PATH while the test code runs, and then restore it
/// to avoid pollution of global state
fn with_mocked_versions_of_more_and_most_in_path(actual_test: fn()) {
let original_path = prepend_dir_to_path_env_var(get_mocked_pagers_dir());
// Make sure our own variants of 'more' and 'most' are used
Command::new(mocked_pager("more"))
.assert()
.success()
.stdout(predicate::str::contains("I am more"));
Command::new(mocked_pager("most"))
.assert()
.success()
.stdout(predicate::str::contains("I am most"));
// Now run the actual test
actual_test();
// Make sure to restore PATH since it is global state
restore_path(original_path);
}
#[test]
fn basic() {
bat()
@ -577,10 +514,10 @@ fn pager_value_bat() {
#[test]
#[serial] // Because of PATH
fn pager_most_from_pager_env_var() {
with_mocked_versions_of_more_and_most_in_path(|| {
mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
// If the output is not "I am most" then we know 'most' is not used
bat()
.env("PAGER", mocked_pager("most"))
.env("PAGER", mocked_pagers::from("most"))
.arg("--paging=always")
.arg("test.txt")
.assert()
@ -594,9 +531,9 @@ fn pager_most_from_pager_env_var() {
#[test]
#[serial] // Because of PATH
fn pager_most_from_bat_pager_env_var() {
with_mocked_versions_of_more_and_most_in_path(|| {
mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
bat()
.env("BAT_PAGER", mocked_pager("most"))
.env("BAT_PAGER", mocked_pagers::from("most"))
.arg("--paging=always")
.arg("test.txt")
.assert()
@ -609,10 +546,10 @@ fn pager_most_from_bat_pager_env_var() {
#[test]
#[serial] // Because of PATH
fn pager_most_from_pager_arg() {
with_mocked_versions_of_more_and_most_in_path(|| {
mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
bat()
.arg("--paging=always")
.arg(format!("--pager={}", mocked_pager("most")))
.arg(format!("--pager={}", mocked_pagers::from("most")))
.arg("test.txt")
.assert()
.success()
@ -624,9 +561,9 @@ fn pager_most_from_pager_arg() {
#[test]
#[serial] // Because of PATH
fn pager_most_with_arg() {
with_mocked_versions_of_more_and_most_in_path(|| {
mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
bat()
.env("PAGER", format!("{} -w", mocked_pager("most")))
.env("PAGER", format!("{} -w", mocked_pagers::from("most")))
.arg("--paging=always")
.arg("test.txt")
.assert()
@ -639,9 +576,9 @@ fn pager_most_with_arg() {
#[test]
#[serial] // Because of PATH
fn pager_more() {
with_mocked_versions_of_more_and_most_in_path(|| {
mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
bat()
.env("PAGER", mocked_pager("more"))
.env("PAGER", mocked_pagers::from("more"))
.arg("--paging=always")
.arg("test.txt")
.assert()

69
tests/utils/mocked_pagers.rs Normal file
View File

@ -0,0 +1,69 @@
use assert_cmd::Command;
use predicates::prelude::predicate;
use std::env;
use std::path::{Path, PathBuf};
/// For some tests we want mocked versions of some pagers
/// This fn returns the absolute path to the directory with these mocked pagers
fn get_mocked_pagers_dir() -> PathBuf {
let cargo_manifest_dir = env::var("CARGO_MANIFEST_DIR").expect("Missing CARGO_MANIFEST_DIR");
Path::new(&cargo_manifest_dir)
.join("tests")
.join("mocked-pagers")
}
/// On Unix: 'most' -> 'most'
/// On Windows: 'most' -> 'most.bat'
pub fn from(base: &str) -> String {
if cfg!(windows) {
format!("{}.bat", base)
} else {
String::from(base)
}
}
/// Prepends a directory to the PATH environment variable
/// Returns the original value for later restoration
fn prepend_dir_to_path_env_var(dir: PathBuf) -> String {
// Get current PATH
let original_path = env::var("PATH").expect("No PATH?!");
// Add the new dir first
let mut split_paths = env::split_paths(&original_path).collect::<Vec<_>>();
split_paths.insert(0, dir);
// Set PATH with the new dir
let new_path = env::join_paths(split_paths).expect("Failed to join paths");
env::set_var("PATH", new_path);
// Return the original value for later restoration of it
original_path
}
/// Helper to restore the value of PATH
fn restore_path(original_path: String) {
env::set_var("PATH", original_path);
}
/// Allows test to run that require our mocked versions of 'more' and 'most'
/// in PATH. Temporarily changes PATH while the test code runs, and then restore it
/// to avoid pollution of global state
pub fn with_mocked_versions_of_more_and_most_in_path(actual_test: fn()) {
let original_path = prepend_dir_to_path_env_var(get_mocked_pagers_dir());
// Make sure our own variants of 'more' and 'most' are used
Command::new(from("more"))
.assert()
.success()
.stdout(predicate::str::contains("I am more"));
Command::new(from("most"))
.assert()
.success()
.stdout(predicate::str::contains("I am most"));
// Now run the actual test
actual_test();
// Make sure to restore PATH since it is global state
restore_path(original_path);
}

1
tests/utils/mod.rs Normal file
View File

@ -0,0 +1 @@
pub mod mocked_pagers;