miden-debug 0.17.0

An interactive debugger for Miden VM programs
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

use clap::Parser;

use super::*;

#[derive(Parser)]
struct Cli {
    #[command(flatten)]
    config: DebuggerConfig,
}

#[test]
fn parses_artifact_execution_and_linker_options() {
    let artifact = tempfile::Builder::new().suffix(".masp").tempfile().unwrap();
    let cli = Cli::try_parse_from([
        "miden-debug",
        artifact.path().to_str().unwrap(),
        "--repl",
        "--color",
        "never",
        "--working-dir",
        "workspace",
        "--entrypoint",
        "example::main",
        "--source-path-prefix",
        "/workspace",
        "-L",
        "libraries",
        "-l",
        "masp:static=example",
        "--commands",
        "commands.txt",
        "--",
        "42",
        "true",
    ])
    .unwrap();
    assert!(cli.config.input.is_some());
    assert!(cli.config.repl);
    assert_eq!(cli.config.color, ColorChoice::Never);
    assert_eq!(cli.config.working_dir, Some(PathBuf::from("workspace")));
    assert_eq!(cli.config.entrypoint.as_deref(), Some("example::main"));
    assert_eq!(cli.config.source_path_prefixes, [PathBuf::from("/workspace")]);
    assert_eq!(cli.config.search_path, [PathBuf::from("libraries")]);
    assert_eq!(cli.config.link_libraries[0].name(), "example");
    assert_eq!(cli.config.link_libraries[0].linkage, miden_debug_engine::Linkage::Static);
    assert_eq!(cli.config.commands, Some(PathBuf::from("commands.txt")));
    assert_eq!(cli.config.args, ["42", "true"]);
    assert!(Cli::try_parse_from(["miden-debug", "--color", "invalid"]).is_err());
}

#[test]
fn color_choices_parse_and_respect_forced_preferences() {
    for (text, expected) in [
        ("always", ColorChoice::Always),
        ("ALWAYS-ANSI", ColorChoice::AlwaysAnsi),
        ("never", ColorChoice::Never),
        ("auto", ColorChoice::Auto),
    ] {
        assert_eq!(text.parse::<ColorChoice>().unwrap(), expected);
    }
    assert_eq!(
        "invalid".parse::<ColorChoice>().unwrap_err().to_string(),
        "invalid color choice: invalid"
    );
    assert!(ColorChoice::Always.should_attempt_color());
    assert!(ColorChoice::AlwaysAnsi.should_attempt_color());
    assert!(!ColorChoice::Never.should_attempt_color());
    assert_eq!(ColorChoice::Auto.should_attempt_color(), ColorChoice::Auto.env_allows_color());
    assert_eq!(ColorChoice::default(), ColorChoice::Auto);
}