Управление запуском тестов
Точно так же, как cargo run компилирует ваш код и затем запускает полученный бинарный файл,
cargo test компилирует ваш код в тестовом режиме и запускает полученный тестовый
бинарный файл. Поведение по умолчанию бинарного файла, созданного cargo test, — запускать
все тесты параллельно и захватывать вывод, сгенерированный во время выполнения тестов,
предотвращая отображение вывода и упрощая чтение
вывода, связанного с результатами тестов. Однако вы можете указать параметры командной строки, чтобы изменить это поведение по умолчанию.
Некоторые параметры командной строки передаются в cargo test, а некоторые — в полученный тестовый
бинарный файл. Чтобы разделить эти два типа аргументов, вы перечисляете аргументы, которые
передаются в cargo test, за которыми следует разделитель --, а затем те, которые передаются в
тестовый бинарный файл. Запуск cargo test --help отображает параметры, которые вы можете использовать
с cargo test, а запуск cargo test -- --help отображает параметры, которые вы
можете использовать после разделителя. Эти параметры также документированы в разделе «Тесты»
книги rustc.
Запуск тестов параллельно или последовательно
Когда вы запускаете несколько тестов, по умолчанию они выполняются параллельно с использованием потоков, что означает, что они завершаются быстрее, и вы получаете обратную связь раньше. Поскольку тесты выполняются одновременно, вы должны убедиться, что ваши тесты не зависят друг от друга или от какого-либо общего состояния, включая общую среду, такую как текущий рабочий каталог или переменные окружения.
Например, предположим, что каждый из ваших тестов выполняет некоторый код, который создаёт файл на диске с именем test-output.txt и записывает некоторые данные в этот файл. Затем каждый тест читает данные в этом файле и утверждает, что файл содержит определённое значение, которое отличается в каждом тесте. Поскольку тесты выполняются одновременно, один тест может перезаписать файл в промежутке между записью и чтением файла другим тестом. Второй тест затем завершится неудачей не потому, что код неверен, а потому что тесты помешали друг другу во время параллельного выполнения. Одно из решений — убедиться, что каждый тест записывает в разный файл; другое решение — запускать тесты по одному.
Если вы не хотите запускать тесты параллельно или хотите более тонкий
контроль над количеством используемых потоков, вы можете передать флаг --test-threads
и количество потоков, которые вы хотите использовать, тестовому бинарному файлу. Взгляните на
следующий пример:
$ cargo test -- --test-threads=1
Мы установили количество тестовых потоков в 1, сказав программе не использовать
параллелизм. Запуск тестов с использованием одного потока займёт больше времени, чем запуск
их параллельно, но тесты не будут мешать друг другу, если они разделяют
состояние.
Отображение вывода функций
По умолчанию, если тест проходит, тестовая библиотека Rust захватывает всё, что печатается в
стандартный вывод. Например, если мы вызываем println! в тесте и тест
проходит, мы не увидим вывод println! в терминале; мы увидим только
строку, указывающую, что тест прошёл. Если тест не проходит, мы увидим всё, что было
напечатано в стандартный вывод, вместе с остальным сообщением о сбое.
В качестве примера, листинг 11-10 содержит глупую функцию, которая печатает значение своего параметра и возвращает 10, а также тест, который проходит, и тест, который не проходит.
fn prints_and_returns_10(a: i32) -> i32 {
println!("I got the value {a}");
10
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn this_test_will_pass() {
let value = prints_and_returns_10(4);
assert_eq!(value, 10);
}
#[test]
fn this_test_will_fail() {
let value = prints_and_returns_10(8);
assert_eq!(value, 5);
}
}
println!Когда мы запускаем эти тесты с помощью cargo test, мы увидим следующий вывод:
$ cargo test
Compiling silly-function v0.1.0 (file:///projects/silly-function)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
running 2 tests
test tests::this_test_will_fail ... FAILED
test tests::this_test_will_pass ... ok
failures:
---- tests::this_test_will_fail stdout ----
I got the value 8
thread 'tests::this_test_will_fail' (6019863) panicked at src/lib.rs:19:9:
assertion `left == right` failed
left: 10
right: 5
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::this_test_will_fail
test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
Обратите внимание, что нигде в этом выводе мы не видим I got the value 4, которая
печатается, когда выполняется проходящий тест. Этот вывод был захвачен.
Вывод из теста, который не прошёл, I got the value 8, появляется в разделе
сводки тестов, который также показывает причину сбоя теста.
Если мы хотим видеть напечатанные значения также для проходящих тестов, мы можем сказать Rust
также показывать вывод успешных тестов с помощью --show-output:
$ cargo test -- --show-output
Когда мы запускаем тесты в листинге 11-10 снова с флагом --show-output, мы
видим следующий вывод:
$ cargo test -- --show-output
Compiling silly-function v0.1.0 (file:///projects/silly-function)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s
Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
running 2 tests
test tests::this_test_will_fail ... FAILED
test tests::this_test_will_pass ... ok
successes:
---- tests::this_test_will_pass stdout ----
I got the value 4
successes:
tests::this_test_will_pass
failures:
---- tests::this_test_will_fail stdout ----
I got the value 8
thread 'tests::this_test_will_fail' (6022313) panicked at src/lib.rs:19:9:
assertion `left == right` failed
left: 10
right: 5
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::this_test_will_fail
test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
Запуск подмножества тестов по имени
Запуск полного набора тестов иногда может занимать много времени. Если вы работаете над
кодом в определённой области, вы можете захотеть запустить только тесты, относящиеся к
этому коду. Вы можете выбрать, какие тесты запускать, передав cargo test имя
или имена тестов, которые вы хотите запустить, в качестве аргумента.
Чтобы продемонстрировать, как запустить подмножество тестов, мы сначала создадим три теста для
нашей функции add_two, как показано в листинге 11-11, и выберем, какие из них запускать.
pub fn add_two(a: u64) -> u64 {
a + 2
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn add_two_and_two() {
let result = add_two(2);
assert_eq!(result, 4);
}
#[test]
fn add_three_and_two() {
let result = add_two(3);
assert_eq!(result, 5);
}
#[test]
fn one_hundred() {
let result = add_two(100);
assert_eq!(result, 102);
}
}
Если мы запустим тесты без передачи каких-либо аргументов, как мы видели ранее, все тесты будут выполняться параллельно:
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.62s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 3 tests
test tests::add_three_and_two ... ok
test tests::add_two_and_two ... ok
test tests::one_hundred ... ok
test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests adder
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Запуск отдельных тестов
Мы можем передать имя любой тестовой функции в cargo test, чтобы запустить только этот тест:
$ cargo test one_hundred
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.69s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 1 test
test tests::one_hundred ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out; finished in 0.00s
Запустился только тест с именем one_hundred; два других теста не совпали с этим именем. Вывод теста сообщает нам, что у нас было больше тестов, которые не запускались,
отображая 2 filtered out в конце.
Мы не можем указать имена нескольких тестов таким образом; будет использоваться только первое значение,
переданное в cargo test. Но есть способ запустить несколько тестов.
Фильтрация для запуска нескольких тестов
Мы можем указать часть имени теста, и любой тест, чьё имя совпадает с этим значением,
будет запущен. Например, поскольку два из наших тестов содержат add в именах, мы можем
запустить их, выполнив cargo test add:
$ cargo test add
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 2 tests
test tests::add_three_and_two ... ok
test tests::add_two_and_two ... ok
test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
Эта команда запустила все тесты с add в имени и отфильтровала тест
с именем one_hundred. Также обратите внимание, что модуль, в котором появляется тест, становится
частью имени теста, поэтому мы можем запустить все тесты в модуле, фильтруя
по имени модуля.
Игнорирование тестов, если они не запрошены специально
Иногда некоторые конкретные тесты могут быть очень трудоёмкими для выполнения, поэтому вы
можете захотеть исключить их из большинства запусков cargo test. Вместо
перечисления в качестве аргументов всех тестов, которые вы хотите запустить, вы можете вместо этого аннотировать
трудоёмкие тесты с помощью атрибута ignore, чтобы исключить их, как показано
здесь:
Имя файла: src/lib.rs
pub fn add(left: u64, right: u64) -> u64 {
left + right
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() {
let result = add(2, 2);
assert_eq!(result, 4);
}
#[test]
#[ignore]
fn expensive_test() {
// код, выполнение которого занимает час
}
}
После #[test] мы добавляем строку #[ignore] к тесту, который хотим исключить.
Теперь, когда мы запускаем наши тесты, it_works выполняется, но expensive_test — нет:
$ cargo test
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 2 tests
test tests::expensive_test ... ignored
test tests::it_works ... ok
test result: ok. 1 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out; finished in 0.00s
Doc-tests adder
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Функция expensive_test указана как ignored. Если мы хотим запустить только
игнорируемые тесты, мы можем использовать cargo test -- --ignored:
$ cargo test -- --ignored
Compiling adder v0.1.0 (file:///projects/adder)
Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
running 1 test
test tests::expensive_test ... ok
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
Doc-tests adder
running 0 tests
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Управляя тем, какие тесты запускать, вы можете убедиться, что результаты cargo test
возвращаются быстро. Когда вы находитесь в точке, где имеет смысл проверить
результаты ignored-тестов и у вас есть время ждать результатов,
вы можете запустить cargo test -- --ignored вместо этого. Если вы хотите запустить все тесты,
независимо от того, игнорируются они или нет, вы можете запустить cargo test -- --include-ignored.