Модульне тестування
Тести — це функції Rust, які перевіряють, що код, який не є тестовим, працює очікуваним чином. Тіла тестових функцій зазвичай виконують певне налаштування, запускають код, який ми хочемо протестувати, а потім стверджують, чи є результати такими, як ми очікуємо.
Більшість модульних тестів потрапляють у tests [модуль][mod] з #[cfg(test)] [атрибутом][attribute].
Тестові функції позначаються атрибутом #[test].
Тести зазнають невдачі, коли щось у тестовій функції [panic’иться][panic]. Є кілька допоміжних [макросів][macros]:
assert!(expression)- викликає panic, якщо expression обчислюється вfalse.assert_eq!(left, right)іassert_ne!(left, right)- перевіряють лівий і правий вирази на рівність і нерівність відповідно.
pub fn add(a: i32, b: i32) -> i32 {
a + b
}
// This is a really bad adding function, its purpose is to fail in this
// example.
#[allow(dead_code)]
fn bad_add(a: i32, b: i32) -> i32 {
a - b
}
#[cfg(test)]
mod tests {
// Note this useful idiom: importing names from outer (for mod tests) scope.
use super::*;
#[test]
fn test_add() {
assert_eq!(add(1, 2), 3);
}
#[test]
fn test_bad_add() {
// This assert would fire and test will fail.
// Please note, that private functions can be tested too!
assert_eq!(bad_add(1, 2), 3);
}
}Тести можна запускати за допомогою cargo test.
$ cargo test
running 2 tests
test tests::test_bad_add ... FAILED
test tests::test_add ... ok
failures:
---- tests::test_bad_add stdout ----
thread 'tests::test_bad_add' panicked at 'assertion failed: `(left == right)`
left: `-1`,
right: `3`', src/lib.rs:21:8
note: Run with `RUST_BACKTRACE=1` for a backtrace.
failures:
tests::test_bad_add
test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out
Тести та ?
Жоден із попередніх прикладів модульних тестів не мав типу, що повертається. Але в Rust 2018,
ваші модульні тести можуть повертати Result<()>, що дає змогу використовувати в них ?! Це
може зробити їх значно лаконічнішими.
fn sqrt(number: f64) -> Result<f64, String> {
if number >= 0.0 {
Ok(number.powf(0.5))
} else {
Err("negative floats don't have square roots".to_owned())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_sqrt() -> Result<(), String> {
let x = 4.0;
assert_eq!(sqrt(x)?.powf(2.0), x);
Ok(())
}
}Докладніше див. [“The Edition Guide”][editionguide].
Тестування panic
Щоб перевірити функції, які мають викликати panic за певних обставин, використовуйте атрибут
#[should_panic]. Цей атрибут приймає необов’язковий параметр expected = з
текстом повідомлення panic. Якщо ваша функція може викликати panic кількома способами, це допомагає
переконатися, що ваш тест перевіряє правильний panic.
Примітка: Rust також дозволяє скорочену форму #[should_panic = "message"], яка працює
точно так само, як #[should_panic(expected = "message")]. Обидві форми є чинними; остання є
поширенішою і вважається більш явною.
pub fn divide_non_zero_result(a: u32, b: u32) -> u32 {
if b == 0 {
panic!("Divide-by-zero error");
} else if a < b {
panic!("Divide result is zero");
}
a / b
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_divide() {
assert_eq!(divide_non_zero_result(10, 2), 5);
}
#[test]
#[should_panic]
fn test_any_panic() {
divide_non_zero_result(1, 0);
}
#[test]
#[should_panic(expected = "Divide result is zero")]
fn test_specific_panic() {
divide_non_zero_result(1, 10);
}
#[test]
#[should_panic = "Divide result is zero"] // This also works
fn test_specific_panic_shorthand() {
divide_non_zero_result(1, 10);
}
}Запуск цих тестів дає нам:
$ cargo test
running 4 tests
test tests::test_any_panic ... ok
test tests::test_divide ... ok
test tests::test_specific_panic ... ok
test tests::test_specific_panic_shorthand ... ok
test result: ok. 4 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
Doc-tests tmp-test-should-panic
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
Запуск окремих тестів
Щоб запустити окремі тести, можна вказати ім’я тесту для команди cargo test.
$ cargo test test_any_panic
running 1 test
test tests::test_any_panic ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 3 filtered out
Doc-tests tmp-test-should-panic
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
Щоб запустити кілька тестів, можна вказати частину імені тесту, яка збігається з усіма тестами, що мають бути запущені.
$ cargo test panic
running 3 tests
test tests::test_any_panic ... ok
test tests::test_specific_panic ... ok
test tests::test_specific_panic_shorthand ... ok
test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out
Doc-tests tmp-test-should-panic
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
Ігнорування тестів
Тести можна позначити атрибутом #[ignore], щоб виключити деякі тести. Або щоб запустити
їх за допомогою команди cargo test -- --ignored
pub fn add(a: i32, b: i32) -> i32 {
a + b
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_add() {
assert_eq!(add(2, 2), 4);
}
#[test]
fn test_add_hundred() {
assert_eq!(add(100, 2), 102);
assert_eq!(add(2, 100), 102);
}
#[test]
#[ignore]
fn ignored_test() {
assert_eq!(add(0, 0), 0);
}
}$ cargo test
running 3 tests
test tests::ignored_test ... ignored
test tests::test_add ... ok
test tests::test_add_hundred ... ok
test result: ok. 2 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out
Doc-tests tmp-ignore
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
$ cargo test -- --ignored
running 1 test
test tests::ignored_test ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
Doc-tests tmp-ignore
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
[атрибутом][attribute]: ../attribute.md [panic]: ../std/panic.md [макросів][macros]: ../macros.md [модуль][mod]: ../mod.md [editionguide]: https://doc.rust-lang.org/edition-guide/rust-2018/error-handling-and-panics/question-mark-in-main-and-tests.html