embers-test-support 0.1.0

Shared integration-test harnesses and helpers for Embers crates.
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
use std::time::{Duration, Instant};

use embers_core::{PtySize, new_request_id};
use embers_protocol::{
    BufferRecord, BufferRecordState, BufferRequest, ClientMessage, InputRequest, OkResponse,
    ServerResponse, SnapshotResponse,
};
use embers_test_support::{TestConnection, TestServer, acquire_test_lock};
use tokio::time::sleep;

async fn create_buffer(connection: &mut TestConnection, command: &[&str]) -> BufferRecord {
    let response = connection
        .request(&ClientMessage::Buffer(BufferRequest::Create {
            request_id: new_request_id(),
            title: Some("buffer".to_owned()),
            command: command.iter().map(|part| (*part).to_owned()).collect(),
            cwd: None,
            env: Default::default(),
        }))
        .await
        .expect("create buffer request succeeds");

    match response {
        ServerResponse::Buffer(buffer) => buffer.buffer,
        other => panic!("expected buffer response, got {other:?}"),
    }
}

async fn get_buffer(
    connection: &mut TestConnection,
    buffer_id: embers_core::BufferId,
) -> BufferRecord {
    let response = connection
        .request(&ClientMessage::Buffer(BufferRequest::Get {
            request_id: new_request_id(),
            buffer_id,
        }))
        .await
        .expect("get buffer request succeeds");

    match response {
        ServerResponse::Buffer(buffer) => buffer.buffer,
        other => panic!("expected buffer response, got {other:?}"),
    }
}

async fn list_detached_buffers(connection: &mut TestConnection) -> Vec<BufferRecord> {
    let response = connection
        .request(&ClientMessage::Buffer(BufferRequest::List {
            request_id: new_request_id(),
            session_id: None,
            attached_only: false,
            detached_only: true,
        }))
        .await
        .expect("list buffers request succeeds");

    match response {
        ServerResponse::Buffers(buffers) => buffers.buffers,
        other => panic!("expected buffers response, got {other:?}"),
    }
}

async fn capture_buffer(
    connection: &mut TestConnection,
    buffer_id: embers_core::BufferId,
) -> SnapshotResponse {
    let response = connection
        .request(&ClientMessage::Buffer(BufferRequest::Capture {
            request_id: new_request_id(),
            buffer_id,
        }))
        .await
        .expect("capture request succeeds");

    match response {
        ServerResponse::Snapshot(snapshot) => snapshot,
        other => panic!("expected snapshot response, got {other:?}"),
    }
}

async fn send_input(
    connection: &mut TestConnection,
    buffer_id: embers_core::BufferId,
    input: &str,
) {
    let response = connection
        .request(&ClientMessage::Input(InputRequest::Send {
            request_id: new_request_id(),
            buffer_id,
            bytes: input.as_bytes().to_vec(),
        }))
        .await
        .expect("send input request succeeds");

    assert!(matches!(response, ServerResponse::Ok(OkResponse { .. })));
}

async fn resize_buffer(
    connection: &mut TestConnection,
    buffer_id: embers_core::BufferId,
    cols: u16,
    rows: u16,
) {
    let response = connection
        .request(&ClientMessage::Input(InputRequest::Resize {
            request_id: new_request_id(),
            buffer_id,
            cols,
            rows,
        }))
        .await
        .expect("resize request succeeds");

    assert!(matches!(response, ServerResponse::Ok(OkResponse { .. })));
}

async fn detach_buffer(connection: &mut TestConnection, buffer_id: embers_core::BufferId) {
    let response = connection
        .request(&ClientMessage::Buffer(BufferRequest::Detach {
            request_id: new_request_id(),
            buffer_id,
        }))
        .await
        .expect("detach request succeeds");

    assert!(matches!(response, ServerResponse::Ok(OkResponse { .. })));
}

async fn kill_buffer(connection: &mut TestConnection, buffer_id: embers_core::BufferId) {
    let response = connection
        .request(&ClientMessage::Buffer(BufferRequest::Kill {
            request_id: new_request_id(),
            buffer_id,
            force: true,
        }))
        .await
        .expect("kill request succeeds");

    assert!(matches!(response, ServerResponse::Ok(OkResponse { .. })));
}

async fn wait_for_capture_contains(
    connection: &mut TestConnection,
    buffer_id: embers_core::BufferId,
    needle: &str,
) -> SnapshotResponse {
    let deadline = Instant::now() + Duration::from_secs(3);
    loop {
        let snapshot = capture_buffer(connection, buffer_id).await;
        let text = snapshot.lines.join("\n");
        if text.contains(needle) {
            return snapshot;
        }
        if Instant::now() >= deadline {
            panic!("timed out waiting for capture containing {needle:?}; got {text:?}");
        }
        sleep(Duration::from_millis(25)).await;
    }
}

async fn wait_for_exit(
    connection: &mut TestConnection,
    buffer_id: embers_core::BufferId,
) -> BufferRecord {
    let deadline = Instant::now() + Duration::from_secs(3);
    loop {
        let buffer = get_buffer(connection, buffer_id).await;
        if matches!(buffer.state, BufferRecordState::Exited) {
            return buffer;
        }
        if Instant::now() >= deadline {
            panic!("timed out waiting for buffer {buffer_id} to exit");
        }
        sleep(Duration::from_millis(25)).await;
    }
}

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn detached_buffers_accept_input_and_keep_running_after_detach_requests() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");

    let buffer = create_buffer(
        &mut connection,
        &[
            "/bin/sh",
            "-lc",
            "printf 'ready\\n'; while IFS= read -r line; do printf 'seen:%s\\n' \"$line\"; done",
        ],
    )
    .await;
    assert_eq!(buffer.state, BufferRecordState::Running);
    assert_eq!(buffer.attachment_node_id, None);

    let detached = list_detached_buffers(&mut connection).await;
    assert!(detached.iter().any(|candidate| candidate.id == buffer.id));

    wait_for_capture_contains(&mut connection, buffer.id, "ready").await;
    send_input(&mut connection, buffer.id, "hello\n").await;
    wait_for_capture_contains(&mut connection, buffer.id, "seen:hello").await;

    detach_buffer(&mut connection, buffer.id).await;
    let detached_buffer = get_buffer(&mut connection, buffer.id).await;
    assert_eq!(detached_buffer.attachment_node_id, None);
    assert_eq!(detached_buffer.state, BufferRecordState::Running);

    send_input(&mut connection, buffer.id, "again\n").await;
    wait_for_capture_contains(&mut connection, buffer.id, "seen:again").await;

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

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn resize_and_kill_requests_update_buffer_state_and_preserve_capture() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");

    let buffer = create_buffer(
        &mut connection,
        &["/bin/sh", "-lc", "printf 'alive\\n'; cat"],
    )
    .await;
    wait_for_capture_contains(&mut connection, buffer.id, "alive").await;

    resize_buffer(&mut connection, buffer.id, 100, 30).await;
    let resized = get_buffer(&mut connection, buffer.id).await;
    assert_eq!(resized.pty_size, PtySize::new(100, 30));
    let resized_snapshot = capture_buffer(&mut connection, buffer.id).await;
    assert_eq!(resized_snapshot.size, PtySize::new(100, 30));

    kill_buffer(&mut connection, buffer.id).await;
    let exited = wait_for_exit(&mut connection, buffer.id).await;
    assert_eq!(exited.state, BufferRecordState::Exited);

    let captured = capture_buffer(&mut connection, buffer.id).await;
    assert!(captured.lines.join("\n").contains("alive"));

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

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn capture_preserves_scrollback_for_long_output() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");

    let buffer = create_buffer(
        &mut connection,
        &[
            "/bin/sh",
            "-lc",
            "i=1; while [ $i -le 40 ]; do printf 'line-%02d\\n' \"$i\"; i=$((i+1)); done",
        ],
    )
    .await;

    let snapshot = wait_for_capture_contains(&mut connection, buffer.id, "line-40").await;
    let text = snapshot.lines.join("\n");
    assert!(text.contains("line-01"));
    assert!(text.contains("line-40"));

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

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn visible_snapshot_surfaces_terminal_modes_and_cursor_metadata() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");

    let buffer = create_buffer(
        &mut connection,
        &[
            "/bin/sh",
            "-lc",
            "printf '\\033]0;embers\\007\\033[?1049h\\033[?1000h\\033[?1004h\\033[?2004hhello'",
        ],
    )
    .await;
    wait_for_capture_contains(&mut connection, buffer.id, "hello").await;

    let snapshot = connection
        .capture_visible_buffer(buffer.id)
        .await
        .expect("visible capture succeeds");
    let text = snapshot.lines.join("\n");
    assert!(text.contains("hello"));
    assert_eq!(snapshot.title.as_deref(), Some("embers"));
    assert!(snapshot.alternate_screen);
    assert!(snapshot.mouse_reporting);
    assert!(snapshot.focus_reporting);
    assert!(snapshot.bracketed_paste);
    assert!(snapshot.total_lines >= u64::from(snapshot.size.rows));
    assert!(snapshot.cursor.is_some());

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

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn scrollback_slice_returns_history_while_full_capture_stays_available() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");

    let buffer = create_buffer(
        &mut connection,
        &[
            "/bin/sh",
            "-lc",
            "i=1; while [ $i -le 40 ]; do printf 'line-%02d\\n' \"$i\"; i=$((i+1)); done",
        ],
    )
    .await;

    let captured = wait_for_capture_contains(&mut connection, buffer.id, "line-40").await;
    wait_for_exit(&mut connection, buffer.id).await;
    let visible = connection
        .capture_visible_buffer(buffer.id)
        .await
        .expect("visible capture succeeds");
    let slice = connection
        .capture_scrollback_slice(buffer.id, 0, 3)
        .await
        .expect("scrollback slice succeeds");
    let expected_prefix = captured.lines.iter().take(3).cloned().collect::<Vec<_>>();

    assert!(captured.lines.join("\n").contains("line-01"));
    assert!(captured.lines.join("\n").contains("line-40"));
    assert!(visible.total_lines >= 40);
    assert!(visible.viewport_top_line > 0);
    assert_eq!(slice.lines, expected_prefix);
    assert_eq!(slice.start_line, 0);
    assert_eq!(slice.total_lines, visible.total_lines);

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

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn repeated_snapshot_reads_stay_stable_without_new_output() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");

    let buffer = create_buffer(
        &mut connection,
        &[
            "/bin/sh",
            "-lc",
            "i=1; while [ $i -le 8 ]; do printf 'line-%02d\\n' \"$i\"; i=$((i+1)); done",
        ],
    )
    .await;

    wait_for_capture_contains(&mut connection, buffer.id, "line-08").await;
    wait_for_exit(&mut connection, buffer.id).await;

    let first_full = capture_buffer(&mut connection, buffer.id).await;
    let second_full = capture_buffer(&mut connection, buffer.id).await;
    assert_eq!(first_full.sequence, second_full.sequence);
    assert_eq!(first_full.size, second_full.size);
    assert_eq!(first_full.lines, second_full.lines);
    assert_eq!(first_full.title, second_full.title);
    assert_eq!(first_full.cwd, second_full.cwd);

    let first_visible = connection
        .capture_visible_buffer(buffer.id)
        .await
        .expect("first visible capture succeeds");
    let second_visible = connection
        .capture_visible_buffer(buffer.id)
        .await
        .expect("second visible capture succeeds");
    assert_eq!(first_visible.sequence, second_visible.sequence);
    assert_eq!(first_visible.size, second_visible.size);
    assert_eq!(first_visible.lines, second_visible.lines);
    assert_eq!(first_visible.title, second_visible.title);
    assert_eq!(first_visible.cwd, second_visible.cwd);
    assert_eq!(
        first_visible.viewport_top_line,
        second_visible.viewport_top_line
    );
    assert_eq!(first_visible.total_lines, second_visible.total_lines);
    assert_eq!(
        first_visible.alternate_screen,
        second_visible.alternate_screen
    );
    assert_eq!(
        first_visible.mouse_reporting,
        second_visible.mouse_reporting
    );
    assert_eq!(
        first_visible.focus_reporting,
        second_visible.focus_reporting
    );
    assert_eq!(
        first_visible.bracketed_paste,
        second_visible.bracketed_paste
    );
    assert_eq!(first_visible.cursor, second_visible.cursor);

    let first_slice = connection
        .capture_scrollback_slice(buffer.id, 2, 3)
        .await
        .expect("first scrollback slice succeeds");
    let second_slice = connection
        .capture_scrollback_slice(buffer.id, 2, 3)
        .await
        .expect("second scrollback slice succeeds");
    assert_eq!(first_slice.start_line, second_slice.start_line);
    assert_eq!(first_slice.total_lines, second_slice.total_lines);
    assert_eq!(first_slice.lines, second_slice.lines);

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

#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn detached_visible_capture_tracks_latest_size_and_output() {
    let _guard = acquire_test_lock().await.expect("acquire test lock");
    let server = TestServer::start().await.expect("start server");
    let mut connection = TestConnection::connect(server.socket_path())
        .await
        .expect("connect protocol client");

    let buffer = create_buffer(
        &mut connection,
        &[
            "/bin/sh",
            "-lc",
            "printf '\\033]0;detached-preview\\007ready\\n'; while IFS= read -r line; do printf 'seen:%s\\n' \"$line\"; done",
        ],
    )
    .await;
    assert_eq!(buffer.attachment_node_id, None);

    wait_for_capture_contains(&mut connection, buffer.id, "ready").await;
    let initial_visible = connection
        .capture_visible_buffer(buffer.id)
        .await
        .expect("initial visible capture succeeds");
    assert_eq!(initial_visible.size, PtySize::new(80, 24));
    assert_eq!(initial_visible.title.as_deref(), Some("detached-preview"));
    assert!(initial_visible.lines.join("\n").contains("ready"));

    resize_buffer(&mut connection, buffer.id, 96, 18).await;
    let resized_visible = connection
        .capture_visible_buffer(buffer.id)
        .await
        .expect("resized visible capture succeeds");
    assert_eq!(resized_visible.size, PtySize::new(96, 18));
    assert!(resized_visible.total_lines >= 1);

    send_input(&mut connection, buffer.id, "after-resize\n").await;
    wait_for_capture_contains(&mut connection, buffer.id, "seen:after-resize").await;

    let visible = connection
        .capture_visible_buffer(buffer.id)
        .await
        .expect("final visible capture succeeds");
    assert_eq!(visible.size, PtySize::new(96, 18));
    assert_eq!(visible.title.as_deref(), Some("detached-preview"));
    assert!(visible.lines.join("\n").contains("seen:after-resize"));

    let captured = capture_buffer(&mut connection, buffer.id).await;
    assert_eq!(captured.size, PtySize::new(96, 18));
    assert!(captured.lines.join("\n").contains("ready"));
    assert!(captured.lines.join("\n").contains("seen:after-resize"));

    let slice = connection
        .capture_scrollback_slice(buffer.id, 0, 4)
        .await
        .expect("detached scrollback slice succeeds");
    assert!(slice.total_lines >= 2);
    assert!(slice.lines.join("\n").contains("ready"));

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