embers-cli 0.1.0

Interactive terminal UI and automation CLI for the Embers terminal multiplexer.
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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
use std::fs;
use std::time::Duration;

use embers_core::{ErrorCode, RequestId};
use embers_protocol::{BufferRequest, ClientMessage, InputRequest, ServerResponse};
use embers_test_support::{TestConnection, TestServer, acquire_test_lock};
use predicates::prelude::*;
use tempfile::tempdir;
use tokio::time::sleep;

use crate::support::{cli_command, run_cli, session_snapshot_by_name, stdout};

async fn wait_for_file_contains(path: &std::path::Path, needle: &str) {
    let deadline = tokio::time::Instant::now() + Duration::from_secs(3);
    loop {
        if let Ok(contents) = fs::read_to_string(path)
            && contents.contains(needle)
        {
            return;
        }
        assert!(
            tokio::time::Instant::now() < deadline,
            "timed out waiting for file {:?} to contain {needle:?}",
            path
        );
        sleep(Duration::from_millis(25)).await;
    }
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn pane_commands_round_trip_through_cli() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");

    run_cli(&server, ["new-session", "alpha"]);
    run_cli(
        &server,
        [
            "new-window",
            "-t",
            "alpha",
            "--title",
            "work",
            "--",
            "/bin/sh",
        ],
    );

    let split = run_cli(&server, ["split-window", "--", "/bin/sh"]);
    let new_pane_id = stdout(&split)
        .trim()
        .parse::<u64>()
        .expect("split-window returns pane id");

    let listed = run_cli(&server, ["list-panes"]);
    let lines = stdout(&listed)
        .trim()
        .lines()
        .map(str::to_owned)
        .collect::<Vec<_>>();
    assert_eq!(lines.len(), 2);

    let pane_ids = lines
        .iter()
        .map(|line| {
            line.split('\t')
                .next()
                .expect("pane id column")
                .parse::<u64>()
                .expect("pane id parses")
        })
        .collect::<Vec<_>>();
    assert!(pane_ids.contains(&new_pane_id));
    let other_pane_id = pane_ids
        .into_iter()
        .find(|pane_id| *pane_id != new_pane_id)
        .expect("other pane exists");

    run_cli(&server, ["select-pane", "-t", &other_pane_id.to_string()]);
    let listed = run_cli(&server, ["list-panes"]);
    assert!(
        stdout(&listed)
            .lines()
            .any(|line| line.starts_with(&format!("{other_pane_id}\t")) && line.contains("\t1\t"))
    );

    run_cli(
        &server,
        [
            "resize-pane",
            "-t",
            &other_pane_id.to_string(),
            "--sizes",
            "3,1",
        ],
    );

    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let parent_split = snapshot
        .nodes
        .iter()
        .find(|node| {
            node.split.as_ref().is_some_and(|split| {
                split
                    .child_ids
                    .contains(&embers_core::NodeId(other_pane_id))
            })
        })
        .expect("parent split exists");
    assert_eq!(
        parent_split.split.as_ref().expect("split payload").sizes,
        vec![3, 1]
    );

    run_cli(
        &server,
        [
            "send-keys",
            "-t",
            &other_pane_id.to_string(),
            "--enter",
            "printf",
            "cli-pane\\n",
        ],
    );
    let deadline = tokio::time::Instant::now() + Duration::from_secs(2);
    let captured = loop {
        let captured = run_cli(&server, ["capture-pane", "-t", &other_pane_id.to_string()]);
        if stdout(&captured).contains("cli-pane") {
            break captured;
        }
        assert!(
            tokio::time::Instant::now() < deadline,
            "timed out waiting for pane {} to render cli-pane",
            other_pane_id
        );
        sleep(Duration::from_millis(50)).await;
    };
    assert!(stdout(&captured).contains("cli-pane"));

    run_cli(&server, ["kill-pane", "-t", &other_pane_id.to_string()]);
    let listed = run_cli(&server, ["list-panes"]);
    assert_eq!(stdout(&listed).trim().lines().count(), 1);

    server.shutdown().await.expect("shutdown server");
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn detached_buffers_can_be_listed_and_attached_via_cli() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");

    run_cli(&server, ["new-session", "alpha"]);
    run_cli(
        &server,
        [
            "new-window",
            "-t",
            "alpha",
            "--title",
            "work",
            "--",
            "/bin/sh",
        ],
    );

    let split = run_cli(&server, ["split-window", "--", "/bin/sh"]);
    let target_pane_id = stdout(&split)
        .trim()
        .parse::<u64>()
        .expect("split-window returns pane id");

    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");
    let detached = connection
        .request(&ClientMessage::Buffer(BufferRequest::Create {
            request_id: RequestId(1),
            title: Some("detached-tools".to_owned()),
            command: vec!["/bin/sh".to_owned()],
            cwd: None,
            env: Default::default(),
        }))
        .await
        .expect("buffer create succeeds");
    let detached_buffer_id = match detached {
        ServerResponse::Buffer(response) => response.buffer.id,
        other => panic!("expected buffer response, got {other:?}"),
    };

    let listed = run_cli(&server, ["list-buffers", "--detached"]);
    assert!(
        stdout(&listed)
            .lines()
            .filter(|line| line.starts_with(&format!("{detached_buffer_id}\t")))
            .any(|line| {
                let fields: Vec<&str> = line.split('\t').collect();
                fields
                    .get(1)
                    .is_some_and(|status| status == &"created" || status == &"running")
            })
    );

    run_cli(
        &server,
        [
            "attach-buffer",
            &detached_buffer_id.to_string(),
            "-t",
            &target_pane_id.to_string(),
        ],
    );

    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let moved_leaf = snapshot
        .nodes
        .iter()
        .find(|node| node.id == embers_core::NodeId(target_pane_id))
        .expect("target pane exists");
    assert_eq!(
        moved_leaf
            .buffer_view
            .as_ref()
            .expect("target is buffer view")
            .buffer_id,
        detached_buffer_id
    );

    let listed = run_cli(&server, ["list-buffers", "--attached"]);
    assert!(
        stdout(&listed)
            .lines()
            .any(|line| line.starts_with(&format!(
                "{detached_buffer_id}\trunning\tattached:{target_pane_id}\t"
            )))
    );

    let buffers = connection
        .request(&ClientMessage::Buffer(BufferRequest::List {
            request_id: RequestId(2),
            session_id: None,
            attached_only: false,
            detached_only: false,
        }))
        .await
        .expect("buffer list succeeds");
    let previous_buffer_id = match buffers {
        ServerResponse::Buffers(response) => response
            .buffers
            .into_iter()
            .find(|buffer| buffer.id != detached_buffer_id && buffer.attachment_node_id.is_none())
            .map(|buffer| buffer.id)
            .expect("previous pane buffer became detached"),
        other => panic!("expected buffers response, got {other:?}"),
    };

    let detached_again = run_cli(&server, ["list-buffers", "--detached"]);
    assert!(
        stdout(&detached_again)
            .lines()
            .any(|line| line.starts_with(&format!("{previous_buffer_id}\trunning\tdetached\t")))
    );

    server.shutdown().await.expect("shutdown server");
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn buffer_show_and_history_open_helper_buffers() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");

    run_cli(&server, ["new-session", "alpha"]);
    run_cli(
        &server,
        [
            "new-window",
            "-t",
            "alpha",
            "--title",
            "work",
            "--",
            "/bin/sh",
        ],
    );

    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let leaf = snapshot
        .session
        .focused_leaf_id
        .expect("focused pane exists");
    let session_id = snapshot.session.id;
    let buffer_id = snapshot
        .nodes
        .iter()
        .find(|node| node.id == leaf)
        .and_then(|node| node.buffer_view.as_ref())
        .map(|view| view.buffer_id)
        .expect("focused pane buffer exists");

    run_cli(
        &server,
        [
            "send-keys",
            "-t",
            &leaf.to_string(),
            "--enter",
            "printf",
            "history-helper\\n",
        ],
    );
    let deadline = tokio::time::Instant::now() + Duration::from_secs(2);
    loop {
        let captured = run_cli(&server, ["capture-pane", "-t", &leaf.to_string()]);
        if stdout(&captured).contains("history-helper") {
            break;
        }
        assert!(
            tokio::time::Instant::now() < deadline,
            "timed out waiting for pane output"
        );
        sleep(Duration::from_millis(50)).await;
    }

    let shown = run_cli(&server, ["buffer", "show", &buffer_id.to_string()]);
    let shown_stdout = stdout(&shown);
    assert!(shown_stdout.contains(&format!("id\t{buffer_id}")));
    assert!(shown_stdout.contains("kind\tpty"));
    assert!(shown_stdout.contains(&format!("location\tsession:{session_id} node:{leaf}")));

    let opened = run_cli(
        &server,
        [
            "buffer",
            "history",
            &buffer_id.to_string(),
            "--scope",
            "visible",
        ],
    );
    let opened_stdout = stdout(&opened).trim().to_owned();
    let helper_buffer_id = opened_stdout
        .split('\t')
        .next()
        .expect("helper buffer id column")
        .parse::<u64>()
        .expect("helper buffer id parses");

    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let helper = snapshot
        .buffers
        .iter()
        .find(|buffer| buffer.id.0 == helper_buffer_id)
        .expect("helper buffer exists in session");
    assert_eq!(helper.kind, embers_protocol::BufferRecordKind::Helper);
    assert!(helper.read_only);
    assert_eq!(helper.helper_source_buffer_id, Some(buffer_id));
    assert_eq!(
        helper.helper_scope,
        Some(embers_protocol::BufferHistoryScope::Visible)
    );

    let helper_capture = connection
        .request(&ClientMessage::Buffer(BufferRequest::Capture {
            request_id: RequestId(3),
            buffer_id: helper.id,
        }))
        .await
        .expect("capture helper succeeds");
    let helper_text = match helper_capture {
        ServerResponse::Snapshot(response) => response.lines.join("\n"),
        other => panic!("expected helper snapshot response, got {other:?}"),
    };
    assert!(helper_text.contains("history-helper"));

    let send = connection
        .request(&ClientMessage::Input(InputRequest::Send {
            request_id: RequestId(4),
            buffer_id: helper.id,
            bytes: b"nope".to_vec(),
        }))
        .await
        .expect("helper send request returns a response");
    assert!(
        matches!(
            send,
            ServerResponse::Error(ref response)
                if response.error.code == ErrorCode::Conflict
                    && response.error.message.contains("read-only")
        ),
        "helper buffers should reject input with a read-only conflict, got {send:?}"
    );

    server.shutdown().await.expect("shutdown server");
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn buffer_pipe_start_show_stop_round_trips_and_rejects_helper_buffers() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let tempdir = tempdir().expect("tempdir");
    let pipe_path = tempdir.path().join("pipe-output.txt");

    run_cli(&server, ["new-session", "alpha"]);
    run_cli(
        &server,
        [
            "new-window",
            "-t",
            "alpha",
            "--title",
            "work",
            "--",
            "/bin/sh",
        ],
    );

    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let leaf = snapshot
        .session
        .focused_leaf_id
        .expect("focused pane exists");
    let buffer_id = snapshot
        .nodes
        .iter()
        .find(|node| node.id == leaf)
        .and_then(|node| node.buffer_view.as_ref())
        .map(|view| view.buffer_id)
        .expect("focused pane buffer exists");

    let shell_command = format!("cat >> '{}'", pipe_path.display());
    let started = run_cli(
        &server,
        [
            "buffer",
            "pipe",
            "start",
            &buffer_id.to_string(),
            "--",
            "/bin/sh",
            "-lc",
            &shell_command,
        ],
    );
    let started_stdout = stdout(&started);
    assert!(started_stdout.contains(&format!("buffer_id\t{buffer_id}")));
    assert!(started_stdout.contains("state\trunning"));

    run_cli(
        &server,
        [
            "send-keys",
            "-t",
            &leaf.to_string(),
            "--enter",
            "printf",
            "pipe-cli-marker\\n",
        ],
    );
    wait_for_file_contains(&pipe_path, "pipe-cli-marker").await;

    let shown = run_cli(&server, ["buffer", "pipe", "show", &buffer_id.to_string()]);
    let shown_stdout = stdout(&shown);
    assert!(shown_stdout.contains("state\trunning"));
    assert!(shown_stdout.contains("command\t["));

    let stopped = run_cli(&server, ["buffer", "pipe", "stop", &buffer_id.to_string()]);
    let stopped_stdout = stdout(&stopped);
    assert!(stopped_stdout.contains("state\tstopped"));
    assert!(stopped_stdout.contains("stop_reason\trequested"));

    let opened = run_cli(
        &server,
        [
            "buffer",
            "history",
            &buffer_id.to_string(),
            "--scope",
            "visible",
        ],
    );
    let helper_buffer_id = stdout(&opened)
        .trim()
        .split('\t')
        .next()
        .expect("helper buffer id column")
        .parse::<u64>()
        .expect("helper buffer id parses");

    cli_command(&server)
        .args([
            "buffer",
            "pipe",
            "start",
            &helper_buffer_id.to_string(),
            "--",
            "/bin/cat",
        ])
        .assert()
        .failure()
        .stderr(predicate::str::contains("read-only"));

    server.shutdown().await.expect("shutdown server");
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn node_commands_cover_zoom_swap_break_join_and_reorder() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");

    run_cli(&server, ["new-session", "alpha"]);
    run_cli(
        &server,
        [
            "new-window",
            "-t",
            "alpha",
            "--title",
            "work",
            "--",
            "/bin/sh",
        ],
    );
    let split = run_cli(&server, ["split-window", "--", "/bin/sh"]);
    let second_pane_id = stdout(&split)
        .trim()
        .parse::<u64>()
        .expect("split-window returns pane id");

    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let first_pane_id = snapshot
        .nodes
        .iter()
        .find(|node| node.buffer_view.as_ref().is_some() && node.id.0 != second_pane_id)
        .map(|node| node.id.0)
        .expect("first pane id exists");

    run_cli(&server, ["node", "zoom", &first_pane_id.to_string()]);
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    assert_eq!(
        snapshot.session.zoomed_node_id,
        Some(embers_core::NodeId(first_pane_id))
    );

    run_cli(&server, ["node", "unzoom", "-t", "alpha"]);
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    assert_eq!(snapshot.session.zoomed_node_id, None);

    let parent_split_id = snapshot
        .nodes
        .iter()
        .find(|node| {
            node.split.as_ref().is_some_and(|split| {
                split
                    .child_ids
                    .contains(&embers_core::NodeId(first_pane_id))
                    && split
                        .child_ids
                        .contains(&embers_core::NodeId(second_pane_id))
            })
        })
        .map(|node| node.id)
        .expect("parent split exists");

    run_cli(
        &server,
        [
            "node",
            "swap",
            &first_pane_id.to_string(),
            &second_pane_id.to_string(),
        ],
    );
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let split = snapshot
        .nodes
        .iter()
        .find(|node| node.id == parent_split_id)
        .and_then(|node| node.split.as_ref())
        .expect("split still exists");
    assert_eq!(split.child_ids[0], embers_core::NodeId(second_pane_id));

    run_cli(
        &server,
        [
            "node",
            "move-before",
            &first_pane_id.to_string(),
            &second_pane_id.to_string(),
        ],
    );
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let split = snapshot
        .nodes
        .iter()
        .find(|node| node.id == parent_split_id)
        .and_then(|node| node.split.as_ref())
        .expect("split still exists after reorder");
    assert_eq!(split.child_ids[0], embers_core::NodeId(first_pane_id));

    run_cli(
        &server,
        [
            "node",
            "break",
            &second_pane_id.to_string(),
            "--to",
            "floating",
        ],
    );
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    assert_eq!(snapshot.floating.len(), 1);
    assert_eq!(
        snapshot.floating[0].root_node_id,
        embers_core::NodeId(second_pane_id)
    );

    let detached = connection
        .request(&ClientMessage::Buffer(BufferRequest::Create {
            request_id: RequestId(10),
            title: Some("notes".to_owned()),
            command: vec!["/bin/sh".to_owned()],
            cwd: None,
            env: Default::default(),
        }))
        .await
        .expect("buffer create succeeds");
    let detached_buffer_id = match detached {
        ServerResponse::Buffer(response) => response.buffer.id,
        other => panic!("expected buffer response, got {other:?}"),
    };

    run_cli(
        &server,
        [
            "node",
            "join-buffer",
            &first_pane_id.to_string(),
            &detached_buffer_id.to_string(),
            "--as",
            "tab-after",
        ],
    );
    let snapshot = session_snapshot_by_name(&mut connection, "alpha").await;
    let (first_index, detached_index) = snapshot
        .nodes
        .iter()
        .find_map(|node| {
            node.tabs.as_ref().and_then(|tabs| {
                let first_index = tabs.tabs.iter().position(|tab| tab.child_id.0 == first_pane_id)?;
                let detached_index = tabs.tabs.iter().position(|tab| {
                    snapshot
                        .nodes
                        .iter()
                        .find(|candidate| candidate.id == tab.child_id)
                        .and_then(|candidate| candidate.buffer_view.as_ref())
                        .is_some_and(|view| view.buffer_id == detached_buffer_id)
                })?;
                Some((first_index, detached_index))
            })
        })
        .expect("join-buffer attached the detached buffer into the same tabs container as the first pane");
    assert_eq!(
        detached_index,
        first_index + 1,
        "join-buffer placed the detached buffer immediately after the first pane"
    );

    server.shutdown().await.expect("shutdown server");
}