bugstalker 0.4.4

use crate::common::TestHooks;
use crate::common::TestInfo;
use crate::{CALC_APP, prepare_debugee_process};
use crate::{FIZZBUZZ_APP, HW_APP, SHARED_LIB_APP, VARS_APP, assert_no_proc};
use bugstalker::debugger::DebuggerBuilder;
use serial_test::serial;

#[test]
#[serial]
fn test_debugee_run() {
    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.start_debugee().unwrap();
    assert_no_proc!(debugee_pid);
}

#[test]
#[serial]
fn test_multiple_brkpt_on_addr() {
    let process = prepare_debugee_process(HW_APP, &[]);
    let attempt_1_pid = process.pid();
    let info = TestInfo::default();
    let builder = DebuggerBuilder::new().with_hooks(TestHooks::new(info.clone()));
    let mut dbg = builder.build(process).unwrap();
    dbg.set_breakpoint_at_line("hello_world.rs", 5).unwrap();
    dbg.set_breakpoint_at_line("hello_world.rs", 9).unwrap();

    dbg.start_debugee().unwrap();

    // save addresses
    assert_eq!(info.line.take(), Some(5));
    let addr_1 = info.addr.take().unwrap();

    dbg.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(9));
    let addr_2 = info.addr.take().unwrap();

    dbg.remove_breakpoint_at_line("hello_world.rs", 5).unwrap();
    dbg.remove_breakpoint_at_line("hello_world.rs", 9).unwrap();

    // set new breakpoints at addresses
    dbg.set_breakpoint_at_addr(addr_1).unwrap();
    dbg.set_breakpoint_at_addr(addr_2).unwrap();

    // restart
    let attempt_2_pid = dbg.restart_debugee().unwrap();

    // assert stop points
    assert_eq!(info.line.take(), Some(5));

    dbg.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(9));

    dbg.continue_debugee().unwrap();

    assert_no_proc!(attempt_1_pid);
    assert_no_proc!(attempt_2_pid);
}

#[test]
#[serial]
fn test_brkpt_on_function() {
    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_fn("sum2").unwrap();

    debugger.start_debugee().unwrap();
    let pc1 = debugger.ecx().location().pc;
    assert!(u64::from(pc1) > 0);
    assert_eq!(info.line.take(), Some(21));

    debugger.continue_debugee().unwrap();
    let pc2 = debugger.ecx().location().pc;
    assert_eq!(pc1, pc2);
    assert_eq!(info.line.take(), Some(21));

    debugger.remove_breakpoint_at_fn("sum2").unwrap();

    debugger.continue_debugee().unwrap();
    assert_no_proc!(debugee_pid);
}

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

    // assert that two breakpoints is set
    assert_eq!(debugger.set_breakpoint_at_fn("sum2").unwrap().len(), 2);
    // assert that two breakpoints is removed
    assert_eq!(debugger.remove_breakpoint_at_fn("sum2").unwrap().len(), 2);

    // assert that two breakpoints is set
    assert_eq!(debugger.set_breakpoint_at_fn("sum3").unwrap().len(), 2);
    // assert that two breakpoints is removed
    assert_eq!(debugger.remove_breakpoint_at_fn("sum3").unwrap().len(), 2);

    // set breakpoint to function in concrete module
    assert_eq!(
        debugger.set_breakpoint_at_fn("float::sum3").unwrap().len(),
        1
    );
    assert_eq!(
        debugger
            .remove_breakpoint_at_fn("float::sum3")
            .unwrap()
            .len(),
        1
    );
}

#[test]
#[serial]
fn test_brkpt_on_line_collision() {
    let process = prepare_debugee_process(SHARED_LIB_APP, &[]);
    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", 19).unwrap();
    debugger.start_debugee().unwrap();
    assert_eq!(info.line.take(), Some(19));

    // assert that two breakpoints is set at two lib.rs from two shared libraries
    let brkpts = debugger.set_breakpoint_at_line("lib.rs", 3).unwrap();
    assert_eq!(brkpts.len(), 2);
    // assert that two breakpoints is removed
    let brkpts = debugger.remove_breakpoint_at_line("lib.rs", 3).unwrap();
    assert_eq!(brkpts.len(), 2);

    // set breakpoint to function in concrete file
    let brkpts = debugger
        .set_breakpoint_at_line("printer_lib/src/lib.rs", 3)
        .unwrap();
    assert_eq!(brkpts.len(), 1);
    let brkpts = debugger
        .remove_breakpoint_at_line("printer_lib/src/lib.rs", 3)
        .unwrap();
    assert_eq!(brkpts.len(), 1);
}

#[test]
#[serial]
fn test_brkpt_on_line() {
    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();
    let pc1 = debugger.ecx().location().pc;
    assert!(u64::from(pc1) > 0);
    assert_eq!(info.line.take(), Some(15));

    debugger.continue_debugee().unwrap();
    let pc2 = debugger.ecx().location().pc;
    assert_eq!(pc1, pc2);
    assert_eq!(info.line.take(), Some(15));

    debugger.continue_debugee().unwrap();
    assert_no_proc!(debugee_pid);
}

#[test]
#[serial]
fn test_brkpt_on_line2() {
    let process = prepare_debugee_process(VARS_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("vars.rs", 144).unwrap();
    debugger.set_breakpoint_at_line("vars.rs", 310).unwrap();

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

    debugger.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(310));

    debugger.continue_debugee().unwrap();
    assert_no_proc!(debugee_pid);
}

#[test]
#[serial]
fn test_set_breakpoint_idempotence() {
    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));

    // set brkpt again on same address, but debugee now in execution state
    debugger
        .set_breakpoint_at_line("hello_world.rs", 15)
        .unwrap();

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

    debugger.continue_debugee().unwrap();
    assert_no_proc!(debugee_pid);
}

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

    assert!(debugger.set_breakpoint_at_fn("print_sum").is_err());
    debugger.add_deferred_at_function("print_sum");
    debugger.start_debugee().unwrap();

    assert!(info.line.take().is_some());
}

#[test]
#[serial]
fn test_breakpoint_at_fn_with_monomorphization() {
    let process = prepare_debugee_process(FIZZBUZZ_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();

    let brkpts = debugger.set_breakpoint_at_fn("solve").unwrap();
    assert_eq!(brkpts.len(), 3);
    let brkpts = debugger
        .set_breakpoint_at_fn("FizzBuzzSolver<P,CMP>::new")
        .unwrap();
    assert_eq!(brkpts.len(), 3);

    debugger.start_debugee().unwrap();
    assert_eq!(info.line.take(), Some(80));
    debugger.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(83));
    debugger.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(80));
    debugger.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(83));
    debugger.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(80));
    debugger.continue_debugee().unwrap();
    assert_eq!(info.line.take(), Some(83));

    debugger.continue_debugee().unwrap();
    assert_no_proc!(debugee_pid);
}

#[test]
#[serial]
fn test_breakpoint_at_line_with_monomorphization() {
    let process = prepare_debugee_process(FIZZBUZZ_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();

    let brkpts = debugger.set_breakpoint_at_line("main.rs", 83).unwrap();
    assert_eq!(brkpts.len(), 3);

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

    debugger.continue_debugee().unwrap();
    assert_no_proc!(debugee_pid);
}