我该如何在GDB中调试失败的cargo测试？

Question

我有一个失败的Cargo测试：

$ cargo test
[snip]
    Running target/gunzip-c62d8688496249d8

running 2 tests
test test_extract_failure ... FAILED
test test_extract_success ... ok

failures:

---- test_extract_failure stdout ----
        task 'test_extract_failure' panicked at 'assertion failed: result.is_err()', /home/dhardy/other/flate2-rs/tests/gunzip.rs:19



failures:
    test_extract_failure

test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured

task '<main>' panicked at 'Some tests failed', /home/rustbuild/src/rust-buildbot/slave/nightly-linux/build/src/libtest/lib.rs:250

我该如何在像GDB这样的调试器中启动失败的测试？

这应该是一个通用的问题，但对于那些想要重走我的步骤的人，请安装最近的夜间版Rust构建，并执行以下操作：

git clone https://github.com/dhardy/flate2-rs.git
git checkout 24979640a880
cd flate2-rs
cargo test

- dhardy

Answer 1

你可以通过向测试二进制文件传递其他参数来筛选要运行的测试用例；Cargo也直接支持这个功能。因此，cargo test test_extract_failure将只运行特定的测试用例。（如果你有其他测试用例会出现panic并且预计会失败，那么这很方便，因为它们不会调用我即将提到的rust_panic函数，只会留下有问题的调用。）

为了使用gdb，你需要直接运行测试二进制文件（如果你使用Cargo，则它在子进程中运行，因此gdb无法捕获其中的panic）。Cargo会帮助你告诉文件名是target/gunzip-c62d8688496249d8。你可以使用--test直接运行它以进行测试：

$ target/gunzip-c62d8688496249d8 --test test_extract_failure
running 1 test
test test_extract_failure ... FAILED

failures:

---- test_extract_failure stdout ----
        task 'test_extract_failure' panicked at 'assertion failed: result.is_err()', /home/dhardy/other/flate2-rs/tests/gunzip.rs:19



failures:
    test_extract_failure

test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured

task '<main>' panicked at 'Some tests failed', /home/rustbuild/src/rust-buildbot/slave/nightly-linux/build/src/libtest/lib.rs:250

现在让我们将其与gdb连接起来。有一个便捷的函数可以插入断点，rust_panic。一旦进入gdb，break rust_panic表示每当某个东西触发panic时，它都会暂停，然后才进行展开。

以下是会话可能最终看起来像什么：

$ gdb target/demo-92d91e26f6ebc557
…
Reading symbols from target/demo-92d91e26f6ebc557...done.
(gdb) break rust_panic
Breakpoint 1 at 0xccb60
(gdb) run --test test_extract_failure
Starting program: /tmp/demo/target/demo-92d91e26f6ebc557 --test test_extract_failure
warning: Could not load shared library symbols for linux-vdso.so.1.
Do you need "set solib-search-path" or "set sysroot"?
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/usr/lib/libthread_db.so.1".

running 1 test
[New Thread 0x7ffff6ef4700 (LWP 14254)]
[New Thread 0x7ffff5fff700 (LWP 14255)]
[Switching to Thread 0x7ffff5fff700 (LWP 14255)]

Breakpoint 1, 0x0000555555620b60 in rust_panic ()
(gdb) bt
#0  0x0000555555620b60 in rust_panic ()
#1  0x0000555555621274 in unwind::begin_unwind_inner::hb821324209c8ed246Qc ()
#2  0x000055555556bb6d in unwind::begin_unwind::h7834652822578025936 ()
#3  0x000055555556b9fd in demo::do_something () at <std macros>:8
#4  0x000055555556b98e in demo::test_extract_failure () at src/lib.rs:3
#5  0x000055555559aa4b in task::TaskBuilder::try_future::closure.8077 ()
#6  0x000055555560fd03 in task::TaskBuilder::spawn_internal::closure.30919 ()
#7  0x000055555561f672 in task::Task::spawn::closure.5759 ()
#8  0x0000555555621cac in rust_try_inner ()
#9  0x0000555555621c96 in rust_try ()
#10 0x000055555561f713 in unwind::try::ha8078a6ae9b50ccepFc ()
#11 0x000055555561f51c in task::Task::run::hdb5fabf381084abafOb ()
#12 0x000055555561f168 in task::Task::spawn::closure.5735 ()
#13 0x0000555555620595 in thread::thread_start::h4d73784c295273b3i6b ()
#14 0x00007ffff79c2314 in start_thread () from /usr/lib/libpthread.so.0
#15 0x00007ffff72e25bd in clone () from /usr/lib/libc.so.6
(gdb) 

在那个特定的情况下，#0-#2和#5-#15是噪音，#3和#4才是我们想要的信号。

- Chris Morgan

---

谢谢，Chris！但是Cargo仍在构建flate2库时没有调试信息，这意味着我无法对除测试函数外的任何内容进行调试。我该如何启用flate2库/所有库的调试功能？据我了解，Cargo有一个--release标志来打开优化，那么为什么默认情况下不开启调试信息？相关问题 - dhardy

Answer 2

cargo build现在有一个参数

 --test [<NAME>]           Build only the specified test target

该工具可以根据传递的参数构建二进制文件，其中仅包含指定测试集。

- Alen Siljak