#[ignore] 忽略测试
核心概念
#[ignore] 属性标注在测试函数上,让 cargo test 默认跳过该测试。被忽略的测试不会编译失败,但不会被自动运行。可以通过 cargo test -- --ignored 显式运行被忽略的测试,或通过 cargo test -- --include-ignored 运行所有测试(包括被忽略的)。
#[ignore] 常用于标记耗时较长的测试、需要外部依赖(数据库、网络)的测试、或暂时无法通过的测试。
#[cfg(test)]
mod tests {
#[test]
fn quick_test() {
// 正常运行的快速测试
assert_eq!(2 + 2, 4);
}
#[test]
#[ignore]
fn slow_test() {
// 这个测试默认被跳过
// cargo test -- --ignored 时才运行
std::thread::sleep(std::time::Duration::from_secs(5));
assert!(true);
}
#[test]
#[ignore = "需要数据库连接"]
fn database_test() {
// 可以提供忽略原因
// 跳过时会显示原因
assert!(true);
}
}
fn main() {
println!("cargo test 跳过 #[ignore] 测试");
println!("cargo test -- --ignored 只运行被忽略的测试");
println!("cargo test -- --include-ignored 运行所有测试");
}常用命令
| 命令 | 行为 |
|---|---|
cargo test | 运行所有非 ignore 测试 |
cargo test -- --ignored | 只运行 ignore 测试 |
cargo test -- --include-ignored | 运行所有测试 |
基本示例
pub fn process_data(data: &[u8]) -> Vec<u8> {
data.iter().map(|b| b.wrapping_add(1)).collect()
}
pub fn validate_checksum(data: &[u8]) -> bool {
let sum: u32 = data.iter().map(|&b| b as u32).sum();
sum % 256 == 0
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_process_data() {
let input = vec![1, 2, 3];
let output = process_data(&input);
assert_eq!(output, vec![2, 3, 4]);
}
#[test]
fn test_empty_data() {
let output = process_data(&[]);
assert!(output.is_empty());
}
#[test]
#[ignore = "需要大量内存"]
fn test_large_data() {
// 处理 100MB 数据
let large = vec![0u8; 100_000_000];
let result = process_data(&large);
assert_eq!(result.len(), 100_000_000);
}
#[test]
#[ignore = "需要网络连接"]
fn test_remote_api() {
// 模拟需要网络的测试
// 实际中会调用外部 API
assert!(true);
}
#[test]
#[ignore = "运行时间超过 30 秒"]
fn test_stress() {
// 压力测试
for i in 0..1_000_000 {
let data = vec![i as u8; 100];
let _ = process_data(&data);
}
}
}
fn main() {
let data = vec![10, 20, 30];
let result = process_data(&data);
println!("处理结果: {:?}", result);
}常见问题
问题一:#[ignore] 和注释掉测试有什么区别?
#[ignore] 的测试仍然会被编译,编译错误会被发现。注释掉的测试不会被编译,代码可能悄悄过时。#[ignore] 还可以通过 --ignored 选择性运行。
问题二:CI 中怎么处理 ignore 测试?
可以分两步:cargo test 运行快速测试,然后在专门的 CI 步骤中 cargo test -- --ignored 运行慢速测试。也可以用 --include-ignored 全部运行。
问题三:ignore 可以加条件吗?
不能直接给 #[ignore] 加条件。但可以用 #[cfg_attr(not(feature = "slow_tests"), ignore)] 实现条件忽略——默认忽略,启用 slow_tests feature 时运行。
问题四:怎么知道有多少测试被忽略了?
cargo test 的输出会显示 "X passed; Y failed; Z ignored"。被忽略的测试数量在 Z 中。
适用场景
- 耗时测试:运行时间超过几秒的测试
- 外部依赖:需要数据库、网络、文件系统的测试
- 资源密集:需要大量内存或 CPU 的测试
- 暂时跳过:正在重构中暂时无法通过的测试
注意事项
- 被忽略的测试仍然会被编译
#[ignore = "原因"]可以提供忽略的理由--ignored只运行忽略的测试,--include-ignored运行全部- 不要滥用 ignore 来隐藏失败的测试
- CI 中应该有运行 ignored 测试的步骤
- 可以配合
cfg_attr实现条件忽略
总结
#[ignore] 让测试函数默认被 cargo test 跳过,但仍然会被编译。通过 cargo test -- --ignored 显式运行被忽略的测试,--include-ignored 运行所有测试。可以用 #[ignore = "原因"] 提供忽略理由。常用于耗时测试、需要外部依赖的测试和暂时跳过的测试。被忽略的测试仍被编译,能及时发现编译错误。CI 中应安排专门的步骤运行忽略的测试。