Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Mengontrol Cara Test Dijalankan

Sama seperti cargo run yang mengompilasi kode kamu lalu menjalankan biner yang dihasilkan, cargo test mengompilasi kode kamu dalam mode test dan menjalankan biner test yang dihasilkan. Secara default, biner yang dihasilkan cargo test menjalankan semua test secara paralel dan menangkap output yang dibuat selama test berjalan, sehingga output itu tidak ditampilkan dan output yang berkaitan dengan hasil test lebih mudah dibaca. Namun, kamu bisa menentukan opsi command line untuk mengubah perilaku default ini.

Sebagian opsi command line ditujukan ke cargo test, dan sebagian lagi ke biner test yang dihasilkan. Untuk memisahkan kedua jenis argumen ini, tuliskan argumen untuk cargo test lebih dulu, lalu pemisah --, kemudian argumen untuk biner test. Menjalankan cargo test --help menampilkan opsi yang bisa kamu pakai dengan cargo test, sedangkan cargo test -- --help menampilkan opsi yang bisa dipakai setelah pemisah. Opsi-opsi ini juga didokumentasikan di bagian “Tests” dalam The rustc Book.

Menjalankan Test Secara Paralel atau Berurutan

Saat kamu menjalankan beberapa test, secara default test-test itu berjalan secara paralel menggunakan thread, sehingga selesai lebih cepat dan kamu mendapat umpan balik lebih awal. Karena test-test itu berjalan bersamaan, kamu harus memastikan test-test kamu tidak saling bergantung atau bergantung pada state bersama, termasuk lingkungan bersama, seperti direktori kerja saat ini atau variabel lingkungan.

Misalnya, anggaplah setiap test kamu menjalankan kode yang membuat file di disk bernama test-output.txt dan menulis sejumlah data ke file itu. Lalu, setiap test membaca data di file tersebut dan menegaskan bahwa file itu berisi nilai tertentu yang berbeda di setiap test. Karena test-test itu berjalan bersamaan, satu test bisa menimpa file di antara waktu test lain menulis dan membaca file itu. Test kedua lalu gagal—bukan karena kodenya salah, melainkan karena test-test itu saling mengganggu saat berjalan secara paralel. Salah satu solusinya adalah memastikan setiap test menulis ke file yang berbeda; solusi lainnya adalah menjalankan test satu per satu.

Jika kamu tidak ingin menjalankan test secara paralel atau ingin kontrol yang lebih detail atas jumlah thread yang dipakai, kamu bisa mengirimkan flag --test-threads beserta jumlah thread yang ingin kamu gunakan ke biner test. Perhatikan contoh berikut:

$ cargo test -- --test-threads=1

Kita menetapkan jumlah thread test menjadi 1, memberi tahu program untuk tidak memakai paralelisme sama sekali. Menjalankan test dengan satu thread memang lebih lama dibanding menjalankannya secara paralel, tetapi test-test itu tidak akan saling mengganggu jika mereka berbagi state.

Menampilkan Output Fungsi

Secara default, jika sebuah test lulus, library test Rust menangkap apa pun yang dicetak ke standard output. Misalnya, jika kita memanggil println! di dalam test dan test itu lulus, kita tidak akan melihat output println! itu di terminal; kita hanya akan melihat baris yang menandakan test itu lulus. Jika test gagal, kita akan melihat apa pun yang dicetak ke standard output bersama pesan kegagalan lainnya.

Sebagai contoh, Listing 11-10 berisi fungsi sederhana yang mencetak nilai parameternya dan mengembalikan 10, serta sebuah test yang lulus dan sebuah test yang gagal.

Filename: src/lib.rs
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);
    }
}
Listing 11-10: Test untuk fungsi yang memanggil println!

Saat kita menjalankan test-test ini dengan cargo test, kita akan melihat output berikut:

$ 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`

Perhatikan bahwa di seluruh output ini kita tidak melihat I got the value 4, yang dicetak saat test yang lulus berjalan. Output itu sudah ditangkap. Output dari test yang gagal, I got the value 8, muncul di bagian ringkasan hasil test, yang juga menampilkan penyebab kegagalan test itu.

Jika kita ingin melihat nilai yang dicetak oleh test yang lulus juga, kita bisa meminta Rust untuk menampilkan output test yang berhasil dengan --show-output:

$ cargo test -- --show-output

Saat kita menjalankan kembali test di Listing 11-10 dengan flag --show-output, kita melihat output berikut:

$ 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`

Menjalankan Sebagian Test Berdasarkan Nama

Menjalankan seluruh rangkaian test kadang bisa memakan waktu lama. Jika kamu sedang mengerjakan kode di area tertentu, kamu mungkin ingin menjalankan hanya test yang berkaitan dengan kode itu. Kamu bisa memilih test mana yang dijalankan dengan memberikan nama satu atau beberapa test yang ingin kamu jalankan sebagai argumen ke cargo test.

Untuk menunjukkan cara menjalankan sebagian test, kita akan membuat tiga test untuk fungsi add_two kita, seperti yang ditunjukkan di Listing 11-11, lalu memilih mana yang akan dijalankan.

Filename: src/lib.rs
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);
    }
}
Listing 11-11: Tiga test dengan tiga nama yang berbeda

Jika kita menjalankan test tanpa memberikan argumen apa pun, seperti yang kita lihat sebelumnya, semua test akan berjalan secara paralel:

$ 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

Menjalankan Satu Test

Kita bisa memberikan nama fungsi test mana pun ke cargo test untuk menjalankan hanya test itu:

$ 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

Hanya test bernama one_hundred yang dijalankan; dua test lainnya tidak cocok dengan nama itu. Output test memberi tahu kita bahwa ada test lain yang tidak dijalankan dengan menampilkan 2 filtered out di akhir.

Kita tidak bisa menentukan nama beberapa test dengan cara ini; hanya nilai pertama yang diberikan ke cargo test yang dipakai. Tetapi ada cara untuk menjalankan beberapa test.

Memfilter untuk Menjalankan Beberapa Test

Kita bisa menentukan sebagian nama test, dan test mana pun yang namanya cocok dengan nilai itu akan dijalankan. Misalnya, karena dua nama test kita mengandung add, kita bisa menjalankan keduanya dengan 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

Perintah ini menjalankan semua test yang memiliki add di namanya dan menyaring test bernama one_hundred. Perhatikan juga bahwa module tempat sebuah test berada menjadi bagian dari nama test itu, sehingga kita bisa menjalankan semua test dalam sebuah module dengan memfilter berdasarkan nama module-nya.

Mengabaikan Test Kecuali Diminta Secara Khusus

Kadang beberapa test tertentu bisa sangat memakan waktu untuk dijalankan, sehingga kamu mungkin ingin mengecualikannya pada sebagian besar jalannya cargo test. Alih-alih mencantumkan sebagai argumen semua test yang memang ingin kamu jalankan, kamu bisa menandai test yang memakan waktu itu dengan atribut ignore agar dikecualikan, seperti yang ditunjukkan di sini:

Nama file: 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() {
        // code that takes an hour to run
    }
}

Setelah #[test], kita menambahkan baris #[ignore] pada test yang ingin kita kecualikan. Sekarang saat kita menjalankan test, it_works berjalan, tetapi expensive_test tidak:

$ 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

Fungsi expensive_test tercantum sebagai ignored. Jika kita ingin menjalankan hanya test yang diabaikan, kita bisa memakai 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

Dengan mengontrol test mana yang dijalankan, kamu bisa memastikan hasil cargo test dikembalikan dengan cepat. Saat tibanya waktu yang tepat untuk memeriksa hasil test ignored dan kamu punya waktu untuk menunggu, kamu bisa menjalankan cargo test -- --ignored sebagai gantinya. Jika kamu ingin menjalankan semua test, baik yang diabaikan maupun tidak, kamu bisa menjalankan cargo test -- --include-ignored.