nut-shell 0.1.2

A lightweight command-line interface library for embedded systems
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
//! Tests for Shell authentication and password masking.
//!
//! These tests validate the authentication flow and password masking behavior.

#![cfg(feature = "authentication")]

#[allow(clippy::duplicate_mod)]
#[path = "fixtures/mod.rs"]
mod fixtures;

#[allow(clippy::duplicate_mod)]
#[path = "helpers.rs"]
mod helpers;

use nut_shell::config::{DefaultConfig, ShellConfig};

// ============================================================================
// Password Masking Tests
// ============================================================================

#[test]
fn test_password_masking_basic() {
    let mut shell = helpers::create_auth_shell();

    // Type username
    helpers::type_input_auth(&mut shell, "admin");

    let output = shell.io().output();
    assert!(
        output.contains("admin"),
        "Username should be echoed normally"
    );
    assert!(!output.contains("*"), "No masking before colon");

    shell.io_mut().clear_output();

    // Type colon delimiter
    shell.process_char(':').unwrap();
    let output = shell.io().output();
    assert_eq!(output, ":", "Colon should be echoed normally");

    shell.io_mut().clear_output();

    // Type password
    helpers::type_input_auth(&mut shell, "pass");

    let output = shell.io().output();
    assert_eq!(output, "****", "Password should be masked with asterisks");
}

#[test]
fn test_password_with_special_chars() {
    let mut shell = helpers::create_auth_shell();

    // Type username with @ and password with special characters
    helpers::type_input_auth(&mut shell, "user@example.com:P@ss!");

    let output = shell.io().output();

    // Username should be visible (including @)
    assert!(
        output.contains("user@example.com:"),
        "Username with @ should be visible"
    );

    // Password should be masked (5 characters = 5 asterisks)
    assert!(
        output.contains("*****"),
        "Password with special chars should be masked"
    );

    // Should NOT contain actual password
    assert!(
        !output.contains("P@ss!"),
        "Actual password should not appear"
    );
}

#[test]
fn test_password_with_multiple_colons() {
    let mut shell = helpers::create_auth_shell();

    // Type password with additional colons (as per spec, they're part of password)
    helpers::type_input_auth(&mut shell, "admin:P:a:s:s");

    let output = shell.io().output();

    // First part should be visible
    assert!(
        output.contains("admin:"),
        "Username and first colon visible"
    );

    // Password part should be fully masked (7 characters including colons)
    // "P:a:s:s" = 7 characters
    let asterisk_count = output.matches('*').count();
    assert_eq!(
        asterisk_count, 7,
        "All password characters including colons should be masked"
    );

    // Should NOT contain the actual password characters
    assert!(
        !output.contains("P:a:s:s"),
        "Actual password should not appear"
    );
}

#[test]
fn test_password_masking_with_backspace() {
    let mut shell = helpers::create_auth_shell();

    // Type "admin:pass"
    helpers::type_input_auth(&mut shell, "admin:pass");

    // Verify password is masked (4 asterisks for "pass")
    let output_before = shell.io().output();
    assert!(output_before.contains("****"), "Password should be masked");

    shell.io_mut().clear_output();

    // Backspace once (should remove one character)
    shell.process_char('\x7f').unwrap(); // DEL character

    let output_after = shell.io().output();
    // Backspace sequence is "\x08 \x08" (backspace, space, backspace)
    assert!(
        output_after.contains("\x08"),
        "Should send backspace sequence"
    );
}

#[test]
fn test_password_masking_empty_username() {
    let mut shell = helpers::create_auth_shell();

    // Type just colon and password (empty username per spec is invalid, but masking should work)
    helpers::type_input_auth(&mut shell, ":password");

    let output = shell.io().output();

    // Colon should be visible
    assert!(output.starts_with(":"), "Colon should be visible");

    // Password should be masked (8 characters)
    assert!(
        output.contains("********"),
        "Password should be masked even with empty username"
    );
}

#[test]
fn test_password_masking_unicode_chars() {
    let mut shell = helpers::create_auth_shell();

    // Type password with unicode characters
    helpers::type_input_auth(&mut shell, "admin:päss");

    let output = shell.io().output();

    // Should have 4 asterisks (one per character: p, ä, s, s)
    let asterisk_count = output.matches('*').count();
    assert_eq!(
        asterisk_count, 4,
        "Unicode characters should be masked individually"
    );

    // Should not contain actual unicode password
    assert!(
        !output.contains("päss"),
        "Actual password should not appear"
    );
}

#[test]
fn test_double_esc_clears_masked_input() {
    let mut shell = helpers::create_auth_shell();

    // Type partial login
    helpers::type_input_auth(&mut shell, "admin:pass");

    // Verify masked password was displayed before clearing
    let output_before = shell.io_mut().output();
    assert!(
        output_before.contains("admin:****"),
        "Password should be masked before clearing: {}",
        output_before
    );

    shell.io_mut().clear_output();

    // Double ESC to clear
    shell.process_char('\x1b').unwrap(); // First ESC
    shell.process_char('\x1b').unwrap(); // Second ESC

    let clear_output = shell.io().output();

    // Should send clear sequence: \r (CR) + \x1b[K (clear to end of line) + prompt
    assert!(
        clear_output.contains("\r"),
        "Should send carriage return after double ESC: {:?}",
        clear_output
    );
    assert!(
        clear_output.contains("\x1b[K"),
        "Should send clear-to-EOL sequence after double ESC: {:?}",
        clear_output
    );

    // Now press enter - should not process the cleared login
    shell.io_mut().clear_output();
    shell.process_char('\n').unwrap();

    let output_after = shell.io_mut().output();

    // Empty input should show invalid format message, not successful login
    assert!(
        output_after.contains(DefaultConfig::MSG_INVALID_LOGIN_FORMAT),
        "Empty input after double ESC should show invalid format message, got: {}",
        output_after
    );
    assert!(
        !output_after.contains(DefaultConfig::MSG_LOGIN_SUCCESS)
            && !output_after.contains(DefaultConfig::MSG_LOGIN_FAILED),
        "Double ESC should have cleared login buffer, got: {}",
        output_after
    );
}

// ============================================================================
// Authentication Edge Cases (documents login behavior)
// ============================================================================

#[test]
fn test_login_with_wrong_password() {
    // Wrong password should show failure message
    let mut shell = helpers::create_auth_shell();

    let output = helpers::execute_command_auth(&mut shell, "admin:wrongpass");

    assert!(
        output.contains(DefaultConfig::MSG_LOGIN_FAILED),
        "Wrong password should show failure: {}",
        output
    );
}

#[test]
fn test_login_with_nonexistent_user() {
    // Non-existent user should show failure (not reveal user doesn't exist)
    let mut shell = helpers::create_auth_shell();

    let output = helpers::execute_command_auth(&mut shell, "nobody:password");

    assert!(
        output.contains(DefaultConfig::MSG_LOGIN_FAILED),
        "Non-existent user should show generic failure: {}",
        output
    );
}

#[test]
fn test_login_with_empty_username() {
    // Empty username is processed as valid format but fails authentication
    let mut shell = helpers::create_auth_shell();

    let output = helpers::execute_command_auth(&mut shell, ":password");

    assert!(
        output.contains(DefaultConfig::MSG_LOGIN_FAILED),
        "Empty username should show login failed: {}",
        output
    );
}

#[test]
fn test_login_with_empty_password() {
    // Empty password should still be processed (and fail)
    let mut shell = helpers::create_auth_shell();

    let output = helpers::execute_command_auth(&mut shell, "admin:");

    assert!(
        output.contains(DefaultConfig::MSG_LOGIN_FAILED),
        "Empty password should show failure: {}",
        output
    );
}

#[test]
fn test_login_without_colon() {
    // Missing colon should show invalid format
    let mut shell = helpers::create_auth_shell();

    let output = helpers::execute_command_auth(&mut shell, "admin");

    assert!(
        output.contains(DefaultConfig::MSG_INVALID_LOGIN_FORMAT),
        "Missing colon should show invalid format: {}",
        output
    );
}

#[test]
fn test_multiple_login_attempts() {
    // Multiple login attempts should be allowed
    let mut shell = helpers::create_auth_shell();

    // First attempt - wrong password
    let output1 = helpers::execute_command_auth(&mut shell, "admin:wrong1");
    assert!(output1.contains(DefaultConfig::MSG_LOGIN_FAILED));

    // Second attempt - still wrong
    let output2 = helpers::execute_command_auth(&mut shell, "admin:wrong2");
    assert!(output2.contains(DefaultConfig::MSG_LOGIN_FAILED));

    // Third attempt - correct
    let output3 = helpers::execute_command_auth(&mut shell, "admin:admin123");
    assert!(
        output3.contains(DefaultConfig::MSG_LOGIN_SUCCESS),
        "Should eventually succeed with correct credentials: {}",
        output3
    );
}

#[test]
fn test_password_backspace_removes_asterisks() {
    // Backspace in password field should remove asterisks
    let mut shell = helpers::create_auth_shell();

    helpers::type_input_auth(&mut shell, "admin:pass");

    let before = shell.io().output();
    assert_eq!(
        helpers::count_char(&before, '*'),
        4,
        "Should have 4 asterisks before backspace"
    );

    shell.io_mut().clear_output();

    // Backspace once
    helpers::press_backspace_auth(&mut shell);

    let after = shell.io().output();
    // Should emit backspace sequence
    assert!(
        after.contains("\x08"),
        "Backspace should emit backspace sequence"
    );
}

#[test]
fn test_successful_login_changes_prompt() {
    // After successful login, prompt should show username
    let mut shell = helpers::create_auth_shell();

    helpers::execute_command_auth(&mut shell, "admin:admin123");

    // Execute a command to see the prompt
    shell.io_mut().clear_output();
    helpers::execute_command_auth(&mut shell, "echo test");

    let output = shell.io().output();
    assert!(
        output.contains("admin@/>"),
        "Prompt should show username after login: {}",
        output
    );
}

#[test]
fn test_case_sensitive_username() {
    // Usernames should be case-sensitive
    let mut shell = helpers::create_auth_shell();

    let output = helpers::execute_command_auth(&mut shell, "Admin:admin123");

    assert!(
        output.contains(DefaultConfig::MSG_LOGIN_FAILED),
        "Username should be case-sensitive: {}",
        output
    );
}

#[test]
fn test_password_masking_immediate() {
    // Password masking should start immediately after first colon
    let mut shell = helpers::create_auth_shell();

    helpers::type_input_auth(&mut shell, "admin:");

    shell.io_mut().clear_output();

    // Type one character
    helpers::type_input_auth(&mut shell, "x");

    let output = shell.io().output();
    assert_eq!(
        output, "*",
        "First char after colon should be masked: {:?}",
        output
    );
}