rmux-server 0.10.0

Tokio daemon and request dispatcher for the RMUX terminal multiplexer.
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
use super::*;

#[test]
fn parsed_list_keys_accepts_attached_sort_order_format_and_reverse() {
    let handler = RequestHandler::new();
    let state = handler.state.blocking_lock();
    let parsed = crate::handler::scripting_support::parse_request_from_parts(
        "list-keys".to_owned(),
        vec![
            "-r".to_owned(),
            "-F#{key_table}".to_owned(),
            "-Okey".to_owned(),
        ],
        None,
        &state.sessions,
        &state.options,
        &TargetFindContext::new(None),
    )
    .expect("list-keys sort flags parse like tmux");

    let Request::ListKeys(request) = parsed else {
        panic!("expected ListKeys request");
    };
    assert!(request.reversed);
    assert_eq!(request.format.as_deref(), Some("#{key_table}"));
    assert_eq!(request.sort_order.as_deref(), Some("key"));
}

#[tokio::test]
async fn parsed_list_panes_accepts_filter_sort_order_and_reverse() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: alpha,
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));
    let state = handler.state.lock().await;
    let parsed = crate::handler::scripting_support::parse_request_from_parts(
        "list-panes".to_owned(),
        vec![
            "-t".to_owned(),
            "alpha:0".to_owned(),
            "-f".to_owned(),
            "#{==:#{pane_index},0}".to_owned(),
            "-O".to_owned(),
            "index".to_owned(),
            "-r".to_owned(),
            "-F".to_owned(),
            "#{pane_index}".to_owned(),
        ],
        None,
        &state.sessions,
        &state.options,
        &TargetFindContext::new(None),
    )
    .expect("list-panes filter/sort flags parse like tmux");

    let Request::ListPanes(request) = parsed else {
        panic!("expected ListPanes request");
    };
    assert_eq!(request.target, session_name("alpha"));
    assert_eq!(request.target_window_index, Some(0));
    assert_eq!(request.filter.as_deref(), Some("#{==:#{pane_index},0}"));
    assert_eq!(request.sort_order.as_deref(), Some("index"));
    assert!(request.reversed);
    assert_eq!(request.format.as_deref(), Some("#{pane_index}"));
}

#[tokio::test]
async fn parsed_list_windows_applies_filter_sort_order_and_reverse() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: alpha.clone(),
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));
    handler
        .handle(Request::NewWindow(Box::new(NewWindowRequest {
            target: alpha.clone(),
            name: None,
            command: None,
            process_command: None,
            detached: false,
            start_directory: None,
            environment: None,
            target_window_index: None,
            insert_at_target: false,
        })))
        .await;

    let filtered = CommandParser::new()
        .parse("list-windows -t alpha -f '#{==:#{window_index},1}' -F '#{window_index}'")
        .expect("list-windows filter parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), filtered)
        .await
        .expect("filtered list-windows executes");
    assert_eq!(output.stdout(), b"1\n");

    let reversed = CommandParser::new()
        .parse("list-windows -t alpha -O index -r -F '#{window_index}'")
        .expect("list-windows sort parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), reversed)
        .await
        .expect("sorted list-windows executes");
    assert_eq!(output.stdout(), b"1\n0\n");
}

#[tokio::test]
async fn parsed_set_option_scope_flags_use_tmux_precedence_and_natural_tables() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: alpha,
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));

    let parsed = CommandParser::new()
        .parse("set-option -s -p @scope server")
        .expect("set-option user scope flags parse");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-option user scope executes");
    let shown = CommandParser::new()
        .parse("show-options -gsv @scope")
        .expect("show-options server user parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), shown)
        .await
        .expect("show-options server user executes");
    assert_eq!(output.stdout(), b"server\n");

    let parsed = CommandParser::new()
        .parse("set-option -w -t alpha status off")
        .expect("set-option known option parses");
    {
        let state = handler.state.lock().await;
        let request = crate::handler::scripting_support::parse_request_from_parts(
            "set-option".to_owned(),
            vec![
                "-w".to_owned(),
                "-t".to_owned(),
                "alpha:0".to_owned(),
                "status".to_owned(),
                "off".to_owned(),
            ],
            None,
            &state.sessions,
            &state.options,
            &TargetFindContext::new(None),
        )
        .expect("resolved set-option parses");
        let Request::SetOptionByName(request) = request else {
            panic!("expected SetOptionByName request");
        };
        assert_eq!(
            request.scope,
            OptionScopeSelector::Session(session_name("alpha"))
        );
    }
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-option known option executes");
    {
        let state = handler.state.lock().await;
        assert_eq!(
            state
                .options
                .resolve(Some(&session_name("alpha")), OptionName::Status),
            Some("off")
        );
    }
    let shown = CommandParser::new()
        .parse("show-options -v -t alpha status")
        .expect("show-options session status parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), shown)
        .await
        .expect("show-options session status executes");
    assert_eq!(output.stdout(), b"off\n");

    let parsed = CommandParser::new()
        .parse("set-option -wg status on")
        .expect("set-option -wg known option parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-option -wg known option executes");
    let shown = CommandParser::new()
        .parse("show-options -gv status")
        .expect("show-options global status parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), shown)
        .await
        .expect("show-options global status executes");
    assert_eq!(output.stdout(), b"on\n");

    let parsed = CommandParser::new()
        .parse("set-option -pg status off")
        .expect("set-option -pg known option parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-option -pg known option executes");
    let output = handler
        .execute_parsed_commands_for_test(
            std::process::id(),
            CommandParser::new()
                .parse("show-options -gv status")
                .expect("show-options global status parses"),
        )
        .await
        .expect("show-options global status executes");
    assert_eq!(output.stdout(), b"off\n");

    let parsed = CommandParser::new()
        .parse("set-option -gp pane-border-style fg=red")
        .expect("set-option -gp pane option parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-option -gp pane option executes");
    let output = handler
        .execute_parsed_commands_for_test(
            std::process::id(),
            CommandParser::new()
                .parse("show-options -gpqv pane-border-style")
                .expect("show-options -gp pane option parses"),
        )
        .await
        .expect("show-options -gp pane option executes");
    assert_eq!(output.stdout(), b"fg=red\n");

    let parsed = CommandParser::new()
        .parse("set-option -gp @pane-global pane-global")
        .expect("set-option -gp user option parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-option -gp user option executes");
    let output = handler
        .execute_parsed_commands_for_test(
            std::process::id(),
            CommandParser::new()
                .parse("show-options -gpqv @pane-global")
                .expect("show-options -gp user option parses"),
        )
        .await
        .expect("show-options -gp user option executes");
    assert_eq!(output.stdout(), b"pane-global\n");

    let parsed = CommandParser::new()
        .parse("set-option -p -t alpha:0.0 pane-border-style fg=blue")
        .expect("pane-local option parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("pane-local option executes");
    let parsed = CommandParser::new()
        .parse("set-option -U -t alpha:0 pane-border-style")
        .expect("set-option -U without value parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-option -U unsets pane overrides without a value");

    let output = handler
        .execute_parsed_commands_for_test(
            std::process::id(),
            CommandParser::new()
                .parse("show-options -pqv -t alpha:0.0 pane-border-style")
                .expect("show pane option parses"),
        )
        .await
        .expect("show pane option executes");
    assert_eq!(output.stdout(), b"");
}

#[tokio::test]
async fn parsed_queue_bind_key_accepts_command_blocks() {
    let handler = RequestHandler::new();
    let bind = CommandParser::new()
        .parse("bind-key x { display-message -p -- from-block }")
        .expect("bind-key block parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), bind)
        .await
        .expect("bind-key block executes");

    let list = CommandParser::new()
        .parse("list-keys -T prefix")
        .expect("list-keys parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), list)
        .await
        .expect("list-keys executes");
    let stdout = std::str::from_utf8(output.stdout()).expect("list-keys utf8");

    assert!(
        stdout.contains("display-message -p -- from-block"),
        "{stdout}"
    );
}

#[tokio::test]
async fn parsed_queue_set_hook_accepts_command_blocks() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("set-hook -g after-new-window { display-message -p -- hook-block }")
        .expect("set-hook block parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-hook block executes");

    let state = handler.state.lock().await;
    assert_eq!(
        state
            .hooks
            .global_command(rmux_proto::HookName::AfterNewWindow),
        Some("display-message -p -- hook-block")
    );
}

#[tokio::test]
async fn parsed_queue_set_hook_resolves_relative_targets_before_block_parse() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: alpha.clone(),
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));

    let parsed = CommandParser::new()
        .parse("set-hook -t . after-new-window { display-message -p -- hook-block }")
        .expect("set-hook block parses");
    handler
        .execute_parsed_commands(
            std::process::id(),
            parsed,
            QueueExecutionContext::without_caller_cwd()
                .with_current_target(Some(Target::Pane(PaneTarget::with_window(alpha, 0, 0)))),
        )
        .await
        .expect("set-hook -t . should execute");
}

#[tokio::test]
async fn parsed_queue_set_hook_session_target_uses_hook_natural_window_scope() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: alpha.clone(),
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));

    let parsed = CommandParser::new()
        .parse("set-hook -t alpha window-renamed { display-message -p -- renamed }")
        .expect("set-hook parses");
    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("set-hook executes");

    let state = handler.state.lock().await;
    assert_eq!(
        state.hooks.session_command(&alpha, HookName::WindowRenamed),
        None
    );
    assert_eq!(
        state.hooks.window_command(
            &WindowTarget::with_window(alpha, 0),
            HookName::WindowRenamed
        ),
        Some("display-message -p -- renamed")
    );
}

#[tokio::test]
async fn parsed_hook_commands_resolve_implicit_current_scopes() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha-implicit-hooks");
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: alpha.clone(),
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));

    let state = handler.state.lock().await;
    let current = TargetFindContext::new(Some(Target::Pane(PaneTarget::with_window(
        alpha.clone(),
        0,
        0,
    ))));
    for (arguments, expected_scope) in [
        (vec![], ScopeSelector::Session(alpha.clone())),
        (
            vec!["-w".to_owned()],
            ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
        ),
        (
            vec!["-p".to_owned()],
            ScopeSelector::Pane(PaneTarget::with_window(alpha.clone(), 0, 0)),
        ),
    ] {
        let request = crate::handler::scripting_support::parse_request_from_parts(
            "show-hooks".to_owned(),
            arguments,
            None,
            &state.sessions,
            &state.options,
            &current,
        )
        .expect("show-hooks resolves its implicit current target");
        let Request::ShowHooks(request) = request else {
            panic!("expected ShowHooks request");
        };
        assert_eq!(request.scope, expected_scope);
    }

    for (arguments, expected_scope) in [
        (
            vec![
                "-w".to_owned(),
                "window-renamed".to_owned(),
                "display-message window".to_owned(),
            ],
            ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
        ),
        (
            vec![
                "-p".to_owned(),
                "pane-mode-changed".to_owned(),
                "display-message pane".to_owned(),
            ],
            ScopeSelector::Pane(PaneTarget::with_window(alpha, 0, 0)),
        ),
    ] {
        let request = crate::handler::scripting_support::parse_request_from_parts(
            "set-hook".to_owned(),
            arguments,
            None,
            &state.sessions,
            &state.options,
            &current,
        )
        .expect("set-hook resolves its implicit current target");
        let Request::SetHookMutation(request) = request else {
            panic!("expected SetHookMutation request");
        };
        assert_eq!(request.scope, expected_scope);
    }
}

#[test]
fn parsed_set_window_option_rejects_non_window_scope_flags() {
    let handler = RequestHandler::new();
    let state = handler.state.blocking_lock();
    for token in ["-s", "-w", "-p", "-U", "-gs", "-gw", "-gp", "-gU"] {
        let error = crate::handler::scripting_support::parse_request_from_parts(
            "set-window-option".to_owned(),
            vec![
                token.to_owned(),
                "-g".to_owned(),
                "pane-border-style".to_owned(),
                "fg=red".to_owned(),
            ],
            None,
            &state.sessions,
            &state.options,
            &TargetFindContext::new(None),
        )
        .expect_err("set-window-option rejects incompatible scope flags");
        assert!(
            error.to_string().contains("unknown flag"),
            "unexpected error for {token}: {error}"
        );
    }
}