embedded-cli 0.2.1

CLI with autocompletion, help and history for embedded systems (like Arduino or STM32)
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
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use embedded_cli::command::RawCommand;
use embedded_cli::service::FromRaw;
use embedded_cli::Command;

use crate::wrapper::{CliWrapper, CommandConvert, ParseError};

use crate::terminal::assert_terminal;

#[derive(Debug, Clone, Command, PartialEq)]
enum TestCommand {
    GetLed,
    GetAdc,
    Exit,
}

impl CommandConvert for TestCommand {
    fn convert(cmd: RawCommand<'_>) -> Result<Self, ParseError> {
        Ok(TestCommand::parse(cmd)?)
    }
}

#[test]
fn complete_when_single_variant() {
    let mut cli = CliWrapper::new();

    cli.process_str("e\t");

    assert_terminal!(cli.terminal(), 7, vec!["$ exit"]);

    cli.process_str("\n");

    assert_eq!(cli.received_commands(), vec![Ok(TestCommand::Exit)]);

    assert_terminal!(cli.terminal(), 2, vec!["$ exit", "$"]);
}

#[test]
fn complete_when_multiple_variants() {
    let mut cli = CliWrapper::new();

    cli.process_str("g\t");

    assert_terminal!(cli.terminal(), 6, vec!["$ get-"]);

    cli.process_str("a\t");

    assert_terminal!(cli.terminal(), 10, vec!["$ get-adc"]);

    cli.process_str("\n");
    assert_terminal!(cli.terminal(), 2, vec!["$ get-adc", "$"]);
    assert_eq!(cli.received_commands(), vec![Ok(TestCommand::GetAdc)]);
}

#[test]
fn complete_when_name_finished() {
    let mut cli = CliWrapper::new();

    cli.process_str("exit\t");

    assert_terminal!(cli.terminal(), 7, vec!["$ exit"]);

    cli.process_str("\n");

    assert_eq!(cli.received_commands(), vec![Ok(TestCommand::Exit)]);
}

#[test]
fn complete_with_leading_spaces() {
    let mut cli = CliWrapper::new();

    cli.process_str("  ex\t");

    assert_terminal!(cli.terminal(), 9, vec!["$   exit"]);

    cli.process_str("\n");

    assert_eq!(cli.received_commands(), vec![Ok(TestCommand::Exit)]);
}

#[test]
fn complete_with_trailing_spaces() {
    let mut cli = CliWrapper::<TestCommand>::new();

    cli.process_str("ex \t");

    assert_terminal!(cli.terminal(), 5, vec!["$ ex"]);
}

#[test]
fn complete_when_inside() {
    let mut cli = CliWrapper::<TestCommand>::new();

    cli.process_str("ex");
    cli.send_left();
    assert_terminal!(cli.terminal(), 3, vec!["$ ex"]);

    cli.send_tab();
    assert_terminal!(cli.terminal(), 7, vec!["$ exit"]);

    cli.send_enter();
    assert_eq!(cli.received_commands(), vec![Ok(TestCommand::Exit)]);
}

#[test]
fn complete_when_inside_with_trailing_spaces() {
    let mut cli = CliWrapper::<TestCommand>::new();

    cli.process_str("ex ");
    cli.send_left();
    cli.send_left();
    assert_terminal!(cli.terminal(), 3, vec!["$ ex"]);

    cli.send_tab();
    assert_terminal!(cli.terminal(), 7, vec!["$ exit"]);

    cli.send_enter();
    assert_eq!(cli.received_commands(), vec![Ok(TestCommand::Exit)]);
}

#[test]
fn complete_when_inside_after_complete() {
    let mut cli = CliWrapper::<TestCommand>::new();

    cli.process_str("e");
    cli.send_tab();
    assert_terminal!(cli.terminal(), 7, vec!["$ exit"]);

    cli.send_left();
    cli.send_left();
    cli.send_left();
    assert_terminal!(cli.terminal(), 4, vec!["$ exit"]);

    cli.send_tab();
    assert_terminal!(cli.terminal(), 7, vec!["$ exit"]);

    cli.send_enter();
    assert_eq!(cli.received_commands(), vec![Ok(TestCommand::Exit)]);
}

#[test]
fn complete_when_inside_without_variants() {
    let mut cli = CliWrapper::<TestCommand>::new();

    cli.process_str("do");
    cli.send_left();
    assert_terminal!(cli.terminal(), 3, vec!["$ do"]);

    cli.send_tab();
    assert_terminal!(cli.terminal(), 3, vec!["$ do"]);
}

#[test]
fn complete_when_inside_and_empty_completion() {
    let mut cli = CliWrapper::<TestCommand>::new();

    cli.process_str("g");
    cli.send_tab();
    assert_terminal!(cli.terminal(), 6, vec!["$ get-"]);

    cli.send_left();
    cli.send_left();
    assert_terminal!(cli.terminal(), 4, vec!["$ get-"]);

    cli.send_tab();
    assert_terminal!(cli.terminal(), 6, vec!["$ get-"]);
}