bugstalker 0.4.4

BugStalker is a modern and lightweight debugger for rust applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

use crate::HW_APP;
use crate::common::TestHooks;
use crate::common::TestInfo;
use crate::{CALC_APP, assert_no_proc, prepare_debugee_process};
use bugstalker::debugger::DebuggerBuilder;
use bugstalker::debugger::variable::render::{RenderValue, ValueLayout};
use serial_test::serial;
use std::borrow::Cow;
use std::mem;

#[test]
#[serial]
fn test_read_register_write() {
    let process = prepare_debugee_process(HW_APP, &[]);
    let debugee_pid = process.pid();
    let builder = DebuggerBuilder::new().with_hooks(TestHooks::default());
    let mut debugger = builder.build(process).unwrap();

    debugger
        .set_breakpoint_at_line("hello_world.rs", 10)
        .unwrap();

    debugger.start_debugee().unwrap();

    debugger.set_register_value("rip", 0x55555555BD20).unwrap();

    let val = debugger.get_register_value("rip");
    assert_eq!(val.unwrap(), 0x55555555BD20);

    mem::drop(debugger);
    assert_no_proc!(debugee_pid);
}

#[test]
#[serial]
fn test_backtrace() {
    let process = prepare_debugee_process(HW_APP, &[]);
    let debugee_pid = process.pid();
    let info = TestInfo::default();
    let builder = DebuggerBuilder::new().with_hooks(TestHooks::new(info.clone()));
    let mut debugger = builder.build(process).unwrap();

    debugger
        .set_breakpoint_at_line("hello_world.rs", 15)
        .unwrap();

    debugger.start_debugee().unwrap();
    assert_eq!(info.line.take(), Some(15));

    let bt = debugger.backtrace(debugee_pid).unwrap();
    assert_eq!(bt.len(), 11);

    assert_ne!(bt[0].fn_start_ip.unwrap().as_u64(), 0);
    assert!(bt[0].func_name.as_ref().unwrap().contains("myprint"));
    assert_ne!(bt[1].fn_start_ip.unwrap().as_u64(), 0);
    assert_eq!(bt[1].func_name.as_ref().unwrap(), "hello_world::main");

    debugger.continue_debugee().unwrap();
    debugger.continue_debugee().unwrap();

    assert_no_proc!(debugee_pid);
}

#[test]
#[serial]
fn test_read_value_u64() {
    let process = prepare_debugee_process(CALC_APP, &["1", "2", "3", "--description", "result"]);
    let debugee_pid = process.pid();
    let info = TestInfo::default();
    let builder = DebuggerBuilder::new().with_hooks(TestHooks::new(info.clone()));
    let mut debugger = builder.build(process).unwrap();
    debugger.set_breakpoint_at_line("main.rs", 15).unwrap();

    debugger.start_debugee().unwrap();
    assert_eq!(info.line.take(), Some(15));

    let vars = debugger.read_local_variables().unwrap();

    assert_eq!(vars.len(), 5);

    let s = &vars[4];
    assert_eq!(s.identity().to_string(), "s");
    assert_eq!(s.value().r#type().name_fmt(), "i64");
    assert!(matches!(
        s.value().value_layout().unwrap(),
        ValueLayout::PreRendered(Cow::Owned(str)) if str == "6"
    ));

    debugger.continue_debugee().unwrap();

    assert_no_proc!(debugee_pid);
}