distant 0.20.0

Operate on a remote computer through file and process manipulation
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

use std::time::Duration;

use assert_fs::prelude::*;
use rstest::*;
use serde_json::json;
use test_log::test;

use crate::common::fixtures::*;

async fn wait_a_bit() {
    wait_millis(250).await;
}

async fn wait_even_longer() {
    wait_millis(500).await;
}

async fn wait_millis(millis: u64) {
    tokio::time::sleep(Duration::from_millis(millis)).await;
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_watching_single_file(mut api_process: CtxCommand<ApiProcess>) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    let file = temp.child("file");
    file.touch().unwrap();

    // Watch single file for changes
    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "watch",
            "path": file.to_path_buf(),
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(
        res["payload"],
        json!({
            "type": "ok"
        }),
        "JSON: {res}"
    );

    // Make a change to some file
    file.write_str("some text").unwrap();

    // Pause a bit to ensure that the process detected the change and reported it
    wait_even_longer().await;

    // Get the response and verify the change
    // NOTE: Don't bother checking the kind as it can vary by platform
    let res = api_process.read_json_from_stdout().await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "changed", "JSON: {res}");
    assert_eq!(
        res["payload"]["path"],
        json!(file.to_path_buf().canonicalize().unwrap()),
        "JSON: {res}"
    );
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_watching_directory_recursively(
    mut api_process: CtxCommand<ApiProcess>,
) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    let dir = temp.child("dir");
    dir.create_dir_all().unwrap();

    let file = dir.child("file");
    file.touch().unwrap();

    // Watch a directory recursively for changes
    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "watch",
            "path": temp.to_path_buf(),
            "recursive": true,
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(
        res["payload"],
        json!({
            "type": "ok"
        }),
        "JSON: {res}"
    );

    // Make a change to some file
    file.write_str("some text").unwrap();

    // Windows reports a directory change first
    if cfg!(windows) {
        // Pause a bit to ensure that the process detected the change and reported it
        wait_even_longer().await;

        // Get the response and verify the change
        // NOTE: Don't bother checking the kind as it can vary by platform
        let res = api_process.read_json_from_stdout().await.unwrap().unwrap();

        assert_eq!(res["origin_id"], id, "JSON: {res}");
        assert_eq!(res["payload"]["type"], "changed", "JSON: {res}");
        assert_eq!(
            res["payload"]["path"],
            json!(dir.to_path_buf().canonicalize().unwrap()),
            "JSON: {res}"
        );
    }

    // Pause a bit to ensure that the process detected the change and reported it
    wait_even_longer().await;

    // Get the response and verify the change
    // NOTE: Don't bother checking the kind as it can vary by platform
    let res = api_process.read_json_from_stdout().await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "changed", "JSON: {res}");
    assert_eq!(
        res["payload"]["path"],
        json!(file.to_path_buf().canonicalize().unwrap()),
        "JSON: {res}"
    );
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_reporting_changes_using_correct_request_id(
    mut api_process: CtxCommand<ApiProcess>,
) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();

    let file1 = temp.child("file1");
    file1.touch().unwrap();

    let file2 = temp.child("file2");
    file2.touch().unwrap();

    // Watch file1 for changes
    let id_1 = rand::random::<u64>().to_string();
    let req = json!({
        "id": id_1,
        "payload": {
            "type": "watch",
            "path": file1.to_path_buf(),
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id_1, "JSON: {res}");
    assert_eq!(
        res["payload"],
        json!({
            "type": "ok"
        }),
        "JSON: {res}"
    );

    // Watch file2 for changes
    let id_2 = rand::random::<u64>().to_string();
    let req = json!({
        "id": id_2,
        "payload": {
            "type": "watch",
            "path": file2.to_path_buf(),
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id_2, "JSON: {res}");
    assert_eq!(
        res["payload"],
        json!({
            "type": "ok"
        }),
        "JSON: {res}"
    );

    // Make a change to file1
    file1.write_str("some text").unwrap();

    // Pause a bit to ensure that the process detected the change and reported it
    wait_even_longer().await;

    // Get the response and verify the change
    // NOTE: Don't bother checking the kind as it can vary by platform
    let res = api_process.read_json_from_stdout().await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id_1, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "changed", "JSON: {res}");
    assert_eq!(
        res["payload"]["path"],
        json!(file1.to_path_buf().canonicalize().unwrap()),
        "JSON: {res}"
    );

    // Process any extra messages (we might get create, content, and more)
    loop {
        // Sleep a bit to give time to get all changes happening
        wait_a_bit().await;

        if api_process
            .try_read_line_from_stdout()
            .expect("stdout closed unexpectedly")
            .is_none()
        {
            break;
        }
    }

    // Make a change to file2
    file2.write_str("some text").unwrap();

    // Pause a bit to ensure that the process detected the change and reported it
    wait_even_longer().await;

    // Get the response and verify the change
    // NOTE: Don't bother checking the kind as it can vary by platform
    let res = api_process.read_json_from_stdout().await.unwrap().unwrap();

    assert_eq!(res["origin_id"], id_2, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "changed", "JSON: {res}");
    assert_eq!(
        res["payload"]["path"],
        json!(file2.to_path_buf().canonicalize().unwrap()),
        "JSON: {res}"
    );
}

#[rstest]
#[test(tokio::test)]
async fn should_support_json_output_for_error(mut api_process: CtxCommand<ApiProcess>) {
    validate_authentication(&mut api_process).await;

    let temp = assert_fs::TempDir::new().unwrap();
    let path = temp.to_path_buf().join("missing");

    // Watch a missing path for changes
    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "watch",
            "path": path,
        },
    });

    let res = api_process.write_and_read_json(req).await.unwrap().unwrap();

    // Ensure we got an acknowledgement of watching that failed
    assert_eq!(res["origin_id"], id, "JSON: {res}");
    assert_eq!(res["payload"]["type"], "error", "JSON: {res}");
    assert_eq!(res["payload"]["kind"], "not_found", "JSON: {res}");
}