tmux-lib 0.5.0

Tmux helper functions.
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
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
//! Integration tests for tmux-lib.
//!
//! These tests require tmux to be installed and available in PATH.
//! They create real tmux sessions/windows/panes and clean them up after each test.

use std::process::Command;
use std::str::FromStr;
use std::sync::atomic::{AtomicU32, Ordering};

use tmux_lib::{
    pane, server, session,
    session::Session,
    session_id::SessionId,
    window::{self, Window},
    window_id::WindowId,
};

/// Counter for generating unique test session names.
static TEST_COUNTER: AtomicU32 = AtomicU32::new(0);

/// Generate a unique session name for testing.
fn unique_session_name(prefix: &str) -> String {
    let count = TEST_COUNTER.fetch_add(1, Ordering::SeqCst);
    let pid = std::process::id();
    format!("test-{}-{}-{}", prefix, pid, count)
}

/// Kill a tmux session by name, ignoring errors.
fn kill_session_sync(name: &str) {
    let _ = Command::new("tmux")
        .args(["kill-session", "-t", &format!("={}", name)])
        .output();
}

/// A guard that ensures tmux sessions are cleaned up even if a test panics.
/// The session is killed when this guard is dropped.
struct SessionGuard {
    names: Vec<String>,
}

impl SessionGuard {
    fn new(name: impl Into<String>) -> Self {
        Self {
            names: vec![name.into()],
        }
    }

    fn add(&mut self, name: impl Into<String>) {
        self.names.push(name.into());
    }
}

impl Drop for SessionGuard {
    fn drop(&mut self) {
        for name in &self.names {
            kill_session_sync(name);
        }
    }
}

/// Check if tmux is available.
fn tmux_available() -> bool {
    Command::new("tmux").arg("-V").output().is_ok()
}

/// Helper to run async tests with smol.
fn block_on<T>(future: impl std::future::Future<Output = T>) -> T {
    smol::block_on(future)
}

// ============================================================================
// Server Tests
// ============================================================================

mod server_tests {
    use super::*;

    #[test]
    fn test_start_and_kill_session() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("server");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Start a new session
            let result = server::start(&session_name).await;
            assert!(result.is_ok(), "Failed to start session: {:?}", result);

            // Verify the session exists
            let sessions = session::available_sessions().await.unwrap();
            let found = sessions.iter().any(|s| s.name == session_name);
            assert!(found, "Session '{}' should exist", session_name);

            // Kill the session
            let result = server::kill_session(&session_name).await;
            assert!(result.is_ok(), "Failed to kill session: {:?}", result);

            // Verify the session is gone
            let sessions = session::available_sessions().await.unwrap_or_default();
            let found = sessions.iter().any(|s| s.name == session_name);
            assert!(!found, "Session '{}' should be gone", session_name);
        });
    }

    #[test]
    fn test_show_options_global() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("opts");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Ensure server is running
            let _ = server::start(&session_name).await;

            // Get global options
            let options = server::show_options(true).await;
            assert!(options.is_ok(), "Failed to get options: {:?}", options);

            let options = options.unwrap();
            // Should have some common options
            assert!(!options.is_empty(), "Options should not be empty");
        });
    }

    #[test]
    fn test_show_option() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("opt");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Ensure server is running
            let _ = server::start(&session_name).await;

            // Get a specific option that should exist
            let result = server::show_option("status", true).await;
            assert!(result.is_ok(), "Failed to get option: {:?}", result);
        });
    }

    #[test]
    fn test_default_command() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("defcmd");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Ensure server is running
            let _ = server::start(&session_name).await;

            // Get default command
            let result = server::default_command().await;
            assert!(
                result.is_ok(),
                "Failed to get default command: {:?}",
                result
            );

            let cmd = result.unwrap();
            // Should be a non-empty string (typically a shell path)
            assert!(!cmd.is_empty(), "Default command should not be empty");
        });
    }
}

// ============================================================================
// Session Tests
// ============================================================================

mod session_tests {
    use super::*;

    #[test]
    fn test_available_sessions() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("avail");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get available sessions
            let sessions = session::available_sessions().await;
            assert!(sessions.is_ok(), "Failed to get sessions: {:?}", sessions);

            let sessions = sessions.unwrap();
            let found = sessions.iter().find(|s| s.name == session_name);
            assert!(found.is_some(), "Created session should be in list");

            // Verify session has expected fields
            let sess = found.unwrap();
            assert_eq!(sess.name, session_name);
        });
    }

    #[test]
    fn test_new_session() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("new");
        let new_session_name = unique_session_name("created");
        let mut guard = SessionGuard::new(&session_name);
        guard.add(&new_session_name);

        block_on(async {
            // Start initial session to ensure server is running
            let _ = server::start(&session_name).await;

            // Get windows/panes from our session to use as templates
            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            let panes = pane::available_panes().await.unwrap();

            if let Some(window) = our_window
                && let Some(pane) = panes.iter().find(|p| window.pane_ids().contains(&p.id))
            {
                // Create a template session
                let template_session = Session {
                    id: SessionId::from_str("$0").unwrap(),
                    name: new_session_name.clone(),
                    dirpath: pane.dirpath.clone(),
                };

                // Create the new session
                let result = session::new_session(&template_session, window, pane, None).await;
                assert!(result.is_ok(), "Failed to create session: {:?}", result);

                let (sess_id, win_id, pane_id) = result.unwrap();
                // Just verify they were created (IDs are opaque types)
                let _ = sess_id;
                assert!(win_id.as_str().starts_with('@'));
                assert!(pane_id.as_str().starts_with('%'));

                // Verify the session exists
                let sessions = session::available_sessions().await.unwrap();
                let found = sessions.iter().any(|s| s.name == new_session_name);
                assert!(found, "New session should exist");
            }
        });
    }
}

// ============================================================================
// Window Tests
// ============================================================================

mod window_tests {
    use super::*;

    #[test]
    fn test_available_windows() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("win");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session (which creates a window)
            let _ = server::start(&session_name).await;

            // Get available windows
            let windows = window::available_windows().await;
            assert!(windows.is_ok(), "Failed to get windows: {:?}", windows);

            let windows = windows.unwrap();
            assert!(!windows.is_empty(), "Should have at least one window");

            // Check window has expected fields
            let win = &windows[0];
            assert!(win.id.as_str().starts_with('@'));
            assert!(!win.name.is_empty());
            assert!(!win.layout.is_empty());
        });
    }

    #[test]
    fn test_new_window() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("newwin");
        let _guard = SessionGuard::new(&session_name);
        let window_name = "test-window";

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get current session, window, and pane from our session
            let sessions = session::available_sessions().await.unwrap();
            let session = sessions.iter().find(|s| s.name == session_name).unwrap();

            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            let panes = pane::available_panes().await.unwrap();

            if let Some(win) = our_window
                && let Some(pane) = panes.iter().find(|p| win.pane_ids().contains(&p.id))
            {
                // Create a template window
                let template_window = Window {
                    id: WindowId::from_str("@0").unwrap(),
                    index: 0,
                    is_active: false,
                    layout: String::new(),
                    name: window_name.to_string(),
                    sessions: vec![session_name.clone()],
                };

                // Create new window
                let result = window::new_window(session, &template_window, pane, None).await;
                assert!(result.is_ok(), "Failed to create window: {:?}", result);

                let (win_id, pane_id) = result.unwrap();
                assert!(win_id.as_str().starts_with('@'));
                assert!(pane_id.as_str().starts_with('%'));

                // Verify window exists
                let windows = window::available_windows().await.unwrap();
                let found = windows.iter().any(|w| w.name == window_name);
                assert!(found, "New window should exist");
            }
        });
    }

    #[test]
    fn test_select_window() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("selwin");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get windows from our session specifically
            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            if let Some(win) = our_window {
                // Select the window
                let result = window::select_window(&win.id).await;
                assert!(result.is_ok(), "Failed to select window: {:?}", result);
            }
        });
    }

    #[test]
    fn test_set_layout() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("layout");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get windows from our session specifically
            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            if let Some(win) = our_window {
                // Try setting a built-in layout
                let result = window::set_layout("even-horizontal", &win.id).await;
                // This may fail if there's only one pane, which is fine
                // Just verify it doesn't panic
                let _ = result;
            }
        });
    }
}

// ============================================================================
// Pane Tests
// ============================================================================

mod pane_tests {
    use super::*;

    #[test]
    fn test_available_panes() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("pane");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session (which creates a pane)
            let _ = server::start(&session_name).await;

            // Get available panes
            let panes = pane::available_panes().await;
            assert!(panes.is_ok(), "Failed to get panes: {:?}", panes);

            let panes = panes.unwrap();
            assert!(!panes.is_empty(), "Should have at least one pane");

            // Check pane has expected fields
            let p = &panes[0];
            assert!(p.id.as_str().starts_with('%'));
            assert!(!p.command.is_empty());
        });
    }

    #[test]
    fn test_new_pane() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("newpane");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get windows from our session specifically
            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            let panes = pane::available_panes().await.unwrap();

            if let Some(win) = our_window
                && let Some(p) = panes.iter().find(|p| win.pane_ids().contains(&p.id))
            {
                // Create new pane
                let result = pane::new_pane(p, None, &win.id).await;
                assert!(result.is_ok(), "Failed to create pane: {:?}", result);

                let new_pane_id = result.unwrap();
                assert!(new_pane_id.as_str().starts_with('%'));

                // Verify the new pane exists in the pane list
                let panes_after = pane::available_panes().await.unwrap();
                let found = panes_after.iter().any(|p| p.id == new_pane_id);
                assert!(found, "New pane {} should exist", new_pane_id);
            }
        });
    }

    #[test]
    fn test_select_pane() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("selpane");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get windows from our session to find its pane IDs
            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            if let Some(win) = our_window {
                let our_pane_ids = win.pane_ids();
                let panes = pane::available_panes().await.unwrap();

                // Find a pane that belongs to our window
                if let Some(p) = panes.iter().find(|p| our_pane_ids.contains(&p.id)) {
                    // Select the pane
                    let result = pane::select_pane(&p.id).await;
                    assert!(result.is_ok(), "Failed to select pane: {:?}", result);
                }
            }
        });
    }

    #[test]
    fn test_pane_capture() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("capture");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get windows from our session to find its pane IDs
            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            if let Some(win) = our_window {
                let our_pane_ids = win.pane_ids();
                let panes = pane::available_panes().await.unwrap();

                // Find a pane that belongs to our window
                if let Some(p) = panes.iter().find(|p| our_pane_ids.contains(&p.id)) {
                    // Capture pane content
                    let result = p.capture().await;
                    assert!(result.is_ok(), "Failed to capture pane: {:?}", result);

                    // Result is raw bytes, just verify it doesn't error
                    let _content = result.unwrap();
                }
            }
        });
    }
}

// ============================================================================
// Window pane_ids Method Tests
// ============================================================================

mod window_pane_ids_tests {
    use super::*;

    #[test]
    fn test_window_pane_ids_integration() {
        if !tmux_available() {
            eprintln!("Skipping test: tmux not available");
            return;
        }

        let session_name = unique_session_name("paneids");
        let _guard = SessionGuard::new(&session_name);

        block_on(async {
            // Create a session
            let _ = server::start(&session_name).await;

            // Get windows from our session specifically
            let windows = window::available_windows().await.unwrap();
            let our_window = windows
                .iter()
                .find(|w| w.sessions.iter().any(|s| s == &session_name));

            if let Some(win) = our_window {
                // Get pane IDs from window layout
                let pane_ids = win.pane_ids();
                assert!(!pane_ids.is_empty(), "Window should have at least one pane");

                // Verify pane IDs match actual panes
                let panes = pane::available_panes().await.unwrap();
                for pane_id in &pane_ids {
                    let found = panes.iter().any(|p| &p.id == pane_id);
                    assert!(found, "Pane ID {:?} should exist in panes list", pane_id);
                }
            }
        });
    }
}