triton-tui 3.0.0

Terminal User Interface to help debugging programs written for Triton VM.
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! Tests for the command line arguments of the TUI.
//! Lives in a dedicated file because `src/args.rs` is `include!`d in `build.rs`.

use assert2::let_assert;
use clap::Parser;

use crate::args::*;

pub const EXAMPLE_INPUT_PATH: &str = "examples/public_input.txt";
pub const EXAMPLE_NON_DETERMINISM_PATH: &str = "examples/non_determinism.json";
pub const EXAMPLE_INITIAL_STATE_PATH: &str = "examples/initial_state.json";

fn binary_name() -> Vec<String> {
    vec!["triton-tui".into()]
}

fn tui_arg_help() -> Vec<String> {
    vec!["--help".into()]
}

fn tui_arg_program() -> Vec<String> {
    vec!["program.tasm".into()]
}

fn tui_arg_public_input() -> Vec<String> {
    vec!["--input".into(), "my_input.txt".into()]
}

fn tui_arg_non_determinism() -> Vec<String> {
    vec!["--non-determinism".into(), "my_non_determinism.json".into()]
}

fn tui_arg_initial_state() -> Vec<String> {
    vec!["--initial-state".into(), "my_state.json".into()]
}

pub fn args_for_test_program_with_test_input() -> TuiArgs {
    let program_path = format!("{MANIFEST_DIR}/{EXAMPLE_PROGRAM_PATH}");
    let input_path = format!("{MANIFEST_DIR}/{EXAMPLE_INPUT_PATH}");
    let non_determinism_path = format!("{MANIFEST_DIR}/{EXAMPLE_NON_DETERMINISM_PATH}");

    let args = [
        binary_name(),
        vec![program_path],
        vec!["-i".into(), input_path],
        vec!["-n".into(), non_determinism_path],
    ]
    .concat();
    TuiArgs::parse_from(args)
}

pub fn args_for_test_program_with_initial_state() -> TuiArgs {
    let initial_state_path = format!("{MANIFEST_DIR}/{EXAMPLE_INITIAL_STATE_PATH}");

    let args = [
        binary_name(),
        vec!["--initial-state".into(), initial_state_path],
    ]
    .concat();
    TuiArgs::parse_from(args)
}

#[test]
fn tui_requires_some_arguments() {
    let args = binary_name();
    let_assert!(Err(_) = TuiArgs::try_parse_from(args));
}

#[test]
fn argument_help_is_valid() {
    let args = [binary_name(), tui_arg_help()].concat();
    TuiArgs::parse_from(args);
}

#[test]
fn argument_just_program_is_valid() {
    let args = [binary_name(), tui_arg_program()].concat();
    TuiArgs::parse_from(args);
}

#[test]
fn argument_program_and_public_input_is_valid() {
    let args = [binary_name(), tui_arg_program(), tui_arg_public_input()].concat();
    TuiArgs::parse_from(args);
}

#[test]
fn argument_program_and_secret_input_is_valid() {
    let args = [binary_name(), tui_arg_program(), tui_arg_non_determinism()].concat();
    TuiArgs::parse_from(args);
}

#[test]
fn argument_program_and_public_input_and_secret_input_is_valid() {
    let args = [
        binary_name(),
        tui_arg_program(),
        tui_arg_public_input(),
        tui_arg_non_determinism(),
    ]
    .concat();
    TuiArgs::parse_from(args);
}

#[test]
fn argument_initial_state_conflicts_with_program() {
    let args = [binary_name(), tui_arg_program(), tui_arg_initial_state()].concat();
    let_assert!(Err(_) = TuiArgs::try_parse_from(args));
}

#[test]
fn argument_initial_state_conflicts_with_public_input() {
    let args = [
        binary_name(),
        tui_arg_program(),
        tui_arg_public_input(),
        tui_arg_initial_state(),
    ]
    .concat();
    let_assert!(Err(_) = TuiArgs::try_parse_from(args));
}

#[test]
fn argument_initial_state_conflicts_with_non_determinism() {
    let args = [
        binary_name(),
        tui_arg_program(),
        tui_arg_public_input(),
        tui_arg_initial_state(),
    ]
    .concat();
    let_assert!(Err(_) = TuiArgs::try_parse_from(args));
}