libtmux 0.1.0

Async typed tmux client and object model
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

//! Caller text must reach tmux literally at every sink tmux expands.
//!
//! tmux runs its format machinery over a name, a title and a start directory
//! before it uses them, so `#(command)` in caller text runs a shell. Each test
//! below asks for a value holding one and asserts tmux stored what was asked.
//! The substitution runs `echo`, so an unescaped pass is visible in the stored
//! value rather than only in a side effect: tmux runs `#()` asynchronously, so
//! a marker file checked straight after the call reads absent whether or not
//! the expansion happened, while the stored value is already final.

#![cfg(feature = "test-support")]
#![allow(clippy::expect_used, clippy::panic, clippy::unwrap_used)]

use libtmux::test::TestServer;
use libtmux::{NewSessionOptions, NewWindowOptions, SplitDirection, SplitOptions};
use tempfile::TempDir;

/// Holds a `#()` substitution, and is a legal tmux name.
const HOSTILE: &str = "evil#(echo pwned)";

#[tokio::test]
async fn a_session_name_reaches_tmux_literally() {
    let guard = TestServer::builder().start().await.expect("tmux starts");

    let session = guard
        .server()
        .new_session(HOSTILE)
        .await
        .expect("the session is created");

    assert_eq!(session.name().to_string_lossy(), HOSTILE);

    guard.shutdown().await.expect("the fixture shuts down");
}

/// Creating and then finding by the same name has to agree, or escaping on the
/// way out would have made the name unreachable on the way back.
#[tokio::test]
async fn a_hostile_name_round_trips_through_lookup() {
    let guard = TestServer::builder().start().await.expect("tmux starts");
    let server = guard.server();

    let created = server
        .new_session(HOSTILE)
        .await
        .expect("the session is created");

    assert!(
        server
            .has_session(HOSTILE)
            .await
            .expect("the listing reads")
    );
    let found = server
        .session(HOSTILE)
        .await
        .expect("the listing reads")
        .expect("the session is found by the name it was given");
    assert_eq!(found.id(), created.id());

    guard.shutdown().await.expect("the fixture shuts down");
}

#[tokio::test]
async fn a_renamed_session_reaches_tmux_literally() {
    let guard = TestServer::builder().start().await.expect("tmux starts");

    let mut session = guard
        .server()
        .new_session("work")
        .await
        .expect("the session is created");
    session.rename(HOSTILE).await.expect("the session renames");

    assert_eq!(session.name().to_string_lossy(), HOSTILE);

    guard.shutdown().await.expect("the fixture shuts down");
}

#[tokio::test]
async fn a_window_name_reaches_tmux_literally() {
    let guard = TestServer::builder().start().await.expect("tmux starts");
    let session = guard
        .server()
        .new_session("work")
        .await
        .expect("the session is created");

    let created = session
        .new_window(HOSTILE)
        .await
        .expect("the window is created");
    assert_eq!(created.name().to_string_lossy(), HOSTILE);

    let mut renamed = session
        .new_window("second")
        .await
        .expect("the window is created");
    renamed.rename(HOSTILE).await.expect("the window renames");
    assert_eq!(renamed.name().to_string_lossy(), HOSTILE);

    guard.shutdown().await.expect("the fixture shuts down");
}

#[tokio::test]
async fn a_first_window_name_reaches_tmux_literally() {
    let guard = TestServer::builder().start().await.expect("tmux starts");

    let session = guard
        .server()
        .new_session(NewSessionOptions::new("work").window_name(HOSTILE))
        .await
        .expect("the session is created");

    let window = session
        .active_window()
        .await
        .expect("the window is read")
        .expect("a session has a window");
    assert_eq!(window.name().to_string_lossy(), HOSTILE);

    guard.shutdown().await.expect("the fixture shuts down");
}

#[tokio::test]
async fn a_pane_title_reaches_tmux_literally() {
    let guard = TestServer::builder().start().await.expect("tmux starts");
    let session = guard
        .server()
        .new_session("work")
        .await
        .expect("the session is created");
    let mut pane = session.panes().await.expect("panes list").remove(0);

    pane.set_title(HOSTILE).await.expect("the title is set");

    assert_eq!(pane.title().to_string_lossy(), HOSTILE);

    guard.shutdown().await.expect("the fixture shuts down");
}

#[tokio::test]
async fn a_start_directory_reaches_tmux_literally() {
    let guard = TestServer::builder().start().await.expect("tmux starts");
    let session = guard
        .server()
        .new_session("work")
        .await
        .expect("the session is created");

    // A directory that really holds a `#`, which is also what an unescaped
    // pass would mangle. tmux reports the path it started in.
    let scratch = TempDir::new().expect("a scratch directory");
    let directory = scratch.path().join("dir#(echo pwned)");
    std::fs::create_dir_all(&directory).expect("the directory is created");

    let window = session
        .new_window(NewWindowOptions::new("cwd").start_directory(&directory))
        .await
        .expect("the window is created");
    let pane = window
        .active_pane()
        .await
        .expect("the pane is read")
        .expect("a window has a pane");

    // tmux reports the directory the pane resolved to. On macOS the
    // temporary root arrives as `/var/...` and resolves to
    // `/private/var/...`, so the expectation has to be canonical too or
    // it is only testing Linux.
    let expected = directory.canonicalize().expect("the directory resolves");

    assert_eq!(
        pane.current_path().map(|path| path.to_string_lossy()),
        Some(expected.to_string_lossy()),
    );

    guard.shutdown().await.expect("the fixture shuts down");
}

#[tokio::test]
async fn a_split_start_directory_reaches_tmux_literally() {
    let guard = TestServer::builder().start().await.expect("tmux starts");
    let session = guard
        .server()
        .new_session("work")
        .await
        .expect("the session is created");
    let pane = session.panes().await.expect("panes list").remove(0);

    let scratch = TempDir::new().expect("a scratch directory");
    let directory = scratch.path().join("split#(echo pwned)");
    std::fs::create_dir_all(&directory).expect("the directory is created");

    let split = pane
        .split(SplitOptions::new(SplitDirection::Below).start_directory(&directory))
        .await
        .expect("the pane splits")
        .refreshed()
        .await
        .expect("the pane is read back");

    // tmux reports the directory the pane resolved to. On macOS the
    // temporary root arrives as `/var/...` and resolves to
    // `/private/var/...`, so the expectation has to be canonical too or
    // it is only testing Linux.
    let expected = directory.canonicalize().expect("the directory resolves");

    assert_eq!(
        split.current_path().map(|path| path.to_string_lossy()),
        Some(expected.to_string_lossy()),
    );

    guard.shutdown().await.expect("the fixture shuts down");
}