我正在构建一个库，该库会询问其运行环境以将值返回给询问程序。有时就像
一样简单pub fn func_name() -> Option<String> {
match env::var("ENVIRONMENT_VARIABLE") {
Ok(s) => Some(s),
Err(e) => None
}
}
但有时会稍微复杂一些，甚至会产生由各种环境变量组成的结果。如何测试这些方法是否按预期运行？
【问题讨论】：
标签： unit-testing environment-variables rust
“我如何测试 X”几乎总是用“通过控制 X”来回答。在这种情况下，您需要控制环境变量：
use std::env;
fn env_is_set() -> bool {
match env::var("ENVIRONMENT_VARIABLE") {
Ok(s) => s == "yes",
_ => false
}
}
#[test]
fn when_set_yes() {
env::set_var("ENVIRONMENT_VARIABLE", "yes");
assert!(env_is_set());
}
#[test]
fn when_set_no() {
env::set_var("ENVIRONMENT_VARIABLE", "no");
assert!(!env_is_set());
}
#[test]
fn when_unset() {
env::remove_var("ENVIRONMENT_VARIABLE");
assert!(!env_is_set());
}
但是，您需要注意环境变量是共享资源。来自the docs for set_var，强调我的：
将当前正在运行的进程的环境变量
k设置为v。
您可能还需要注意，Rust 测试运行器默认并行运行测试，因此有可能让一个测试破坏另一个测试。
此外，您可能希望在测试后将环境变量“重置”为已知的良好状态。
【讨论】：
您的另一个选择（如果您不想搞乱实际设置环境变量）是抽象调用。我只是在学习 Rust，所以我不确定这是否是“Rust 方式（tm）”......但这肯定是我在另一种语言/环境中的做法：
use std::env;
pub trait QueryEnvironment {
fn get_var(&self, var: &str) -> Result<String, std::env::VarError>;
}
struct MockQuery;
struct ActualQuery;
impl QueryEnvironment for MockQuery {
fn get_var(&self, _var: &str) -> Result<String, std::env::VarError> {
Ok("Some Mocked Result".to_string()) // Returns a mocked response
}
}
impl QueryEnvironment for ActualQuery {
fn get_var(&self, var: &str) -> Result<String, std::env::VarError> {
env::var(var) // Returns an actual response
}
}
fn main() {
env::set_var("ENVIRONMENT_VARIABLE", "user"); // Just to make program execute for ActualQuery type
let mocked_query = MockQuery;
let actual_query = ActualQuery;
println!("The mocked environment value is: {}", func_name(mocked_query).unwrap());
println!("The actual environment value is: {}", func_name(actual_query).unwrap());
}
pub fn func_name<T: QueryEnvironment>(query: T) -> Option<String> {
match query.get_var("ENVIRONMENT_VARIABLE") {
Ok(s) => Some(s),
Err(_) => None
}
}
rust playground 上的示例
注意 actual 调用是如何发生恐慌的。这是您将在 实际 代码中使用的实现。对于您的测试，您将使用模拟的。
【讨论】：
_ 以避免警告它们未使用。这避免了使用指令#[allow(unused_variables)]。
第三种选择，我认为更好的选择是传入现有类型 - 而不是创建每个人都必须强制执行的新抽象。
pub fn new<I>(vars: I)
where I: Iterator<Item = (String, String)>
{
for (x, y) in vars {
println!("{}: {}", x, y)
}
}
#[test]
fn trivial_call() {
let vars = [("fred".to_string(), "jones".to_string())];
new(vars.iter().cloned());
}
感谢#rust 上的 qrlpz 帮助我为我的程序排序，只是分享结果以帮助其他人:)
【讨论】：
iter::empty。
编辑： 下面的测试助手现在可以在 dedicated crate
中使用免责声明：我是合著者
我也有同样的需求，并实现了一些小型测试助手来处理@Shepmaster 提到的注意事项。
这些测试助手支持这样的测试：
#[test]
fn test_default_log_level_is_info() {
with_env_vars(
vec![
("LOGLEVEL", None),
("SOME_OTHER_VAR", Some("foo"))
],
|| {
let actual = Config::new();
assert_eq!("INFO", actual.log_level);
},
);
}
with_env_vars 将负责：
帮手：
use lazy_static::lazy_static;
use std::env::VarError;
use std::panic::{RefUnwindSafe, UnwindSafe};
use std::sync::Mutex;
use std::{env, panic};
lazy_static! {
static ref SERIAL_TEST: Mutex<()> = Default::default();
}
/// Sets environment variables to the given value for the duration of the closure.
/// Restores the previous values when the closure completes or panics, before unwinding the panic.
pub fn with_env_vars<F>(kvs: Vec<(&str, Option<&str>)>, closure: F)
where
F: Fn() + UnwindSafe + RefUnwindSafe,
{
let guard = SERIAL_TEST.lock().unwrap();
let mut old_kvs: Vec<(&str, Result<String, VarError>)> = Vec::new();
for (k, v) in kvs {
let old_v = env::var(k);
old_kvs.push((k, old_v));
match v {
None => env::remove_var(k),
Some(v) => env::set_var(k, v),
}
}
match panic::catch_unwind(|| {
closure();
}) {
Ok(_) => {
for (k, v) in old_kvs {
reset_env(k, v);
}
}
Err(err) => {
for (k, v) in old_kvs {
reset_env(k, v);
}
drop(guard);
panic::resume_unwind(err);
}
};
}
fn reset_env(k: &str, old: Result<String, VarError>) {
if let Ok(v) = old {
env::set_var(k, v);
} else {
env::remove_var(k);
}
}
【讨论】：