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
279
280
281

use std::path::PathBuf;

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

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

/// Creates a directory in the form
///
/// $TEMP/
/// $TEMP/dir1/
/// $TEMP/dir1/dira/
/// $TEMP/dir1/dirb/
/// $TEMP/dir1/dirb/file1
/// $TEMP/dir1/file1
/// $TEMP/dir1/file2
/// $TEMP/dir2/
/// $TEMP/dir2/dira/
/// $TEMP/dir2/dirb/
/// $TEMP/dir2/dirb/file1
/// $TEMP/dir2/file1
/// $TEMP/dir2/file2
/// $TEMP/file1
/// $TEMP/file2
fn make_directory() -> assert_fs::TempDir {
    let temp = assert_fs::TempDir::new().unwrap();

    // $TEMP/file1
    // $TEMP/file2
    temp.child("file1").touch().unwrap();
    temp.child("file2").touch().unwrap();

    // $TEMP/dir1/
    // $TEMP/dir1/file1
    // $TEMP/dir1/file2
    let dir1 = temp.child("dir1");
    dir1.create_dir_all().unwrap();
    dir1.child("file1").touch().unwrap();
    dir1.child("file2").touch().unwrap();

    // $TEMP/dir1/dira/
    let dir1_dira = dir1.child("dira");
    dir1_dira.create_dir_all().unwrap();

    // $TEMP/dir1/dirb/
    // $TEMP/dir1/dirb/file1
    let dir1_dirb = dir1.child("dirb");
    dir1_dirb.create_dir_all().unwrap();
    dir1_dirb.child("file1").touch().unwrap();

    // $TEMP/dir2/
    // $TEMP/dir2/file1
    // $TEMP/dir2/file2
    let dir2 = temp.child("dir2");
    dir2.create_dir_all().unwrap();
    dir2.child("file1").touch().unwrap();
    dir2.child("file2").touch().unwrap();

    // $TEMP/dir2/dira/
    let dir2_dira = dir2.child("dira");
    dir2_dira.create_dir_all().unwrap();

    // $TEMP/dir2/dirb/
    // $TEMP/dir2/dirb/file1
    let dir2_dirb = dir2.child("dirb");
    dir2_dirb.create_dir_all().unwrap();
    dir2_dirb.child("file1").touch().unwrap();

    temp
}

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

    let temp = make_directory();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "dir_read",
            "path": temp.to_path_buf(),
            "depth": 1,
            "absolute": false,
            "canonicalize": false,
            "include_root": false,
        },
    });

    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": "dir_entries",
            "entries": [
                {"path": PathBuf::from("dir1"), "file_type": "dir", "depth": 1},
                {"path": PathBuf::from("dir2"), "file_type": "dir", "depth": 1},
                {"path": PathBuf::from("file1"), "file_type": "file", "depth": 1},
                {"path": PathBuf::from("file2"), "file_type": "file", "depth": 1},
            ],
            "errors": [],
        }),
        "JSON: {res}"
    );
}

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

    let temp = make_directory();

    // NOTE: Our root path is always canonicalized, so the absolute path
    //       provided is our canonicalized root path prepended
    let root_path = temp.to_path_buf().canonicalize().unwrap();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "dir_read",
            "path": temp.to_path_buf(),
            "depth": 1,
            "absolute": true,
            "canonicalize": false,
            "include_root": false,
        },
    });

    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": "dir_entries",
            "entries": [
                {"path": root_path.join("dir1"), "file_type": "dir", "depth": 1},
                {"path": root_path.join("dir2"), "file_type": "dir", "depth": 1},
                {"path": root_path.join("file1"), "file_type": "file", "depth": 1},
                {"path": root_path.join("file2"), "file_type": "file", "depth": 1},
            ],
            "errors": [],
        }),
        "JSON: {res}"
    );
}

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

    let temp = make_directory();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "dir_read",
            "path": temp.to_path_buf(),
            "depth": 0,
            "absolute": false,
            "canonicalize": false,
            "include_root": false,
        },
    });

    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": "dir_entries",
            "entries": [
                {"path": PathBuf::from("dir1"), "file_type": "dir", "depth": 1},
                {"path": PathBuf::from("dir1").join("dira"), "file_type": "dir", "depth": 2},
                {"path": PathBuf::from("dir1").join("dirb"), "file_type": "dir", "depth": 2},
                {"path": PathBuf::from("dir1").join("dirb").join("file1"), "file_type": "file", "depth": 3},
                {"path": PathBuf::from("dir1").join("file1"), "file_type": "file", "depth": 2},
                {"path": PathBuf::from("dir1").join("file2"), "file_type": "file", "depth": 2},
                {"path": PathBuf::from("dir2"), "file_type": "dir", "depth": 1},
                {"path": PathBuf::from("dir2").join("dira"), "file_type": "dir", "depth": 2},
                {"path": PathBuf::from("dir2").join("dirb"), "file_type": "dir", "depth": 2},
                {"path": PathBuf::from("dir2").join("dirb").join("file1"), "file_type": "file", "depth": 3},
                {"path": PathBuf::from("dir2").join("file1"), "file_type": "file", "depth": 2},
                {"path": PathBuf::from("dir2").join("file2"), "file_type": "file", "depth": 2},
                {"path": PathBuf::from("file1"), "file_type": "file", "depth": 1},
                {"path": PathBuf::from("file2"), "file_type": "file", "depth": 1},
            ],
            "errors": [],
        }),
        "JSON: {res}"
    );
}

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

    let temp = make_directory();

    // NOTE: Our root path is always canonicalized, so yielded entry
    //       is the canonicalized version
    let root_path = temp.to_path_buf().canonicalize().unwrap();

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "dir_read",
            "path": temp.to_path_buf(),
            "depth": 1,
            "absolute": false,
            "canonicalize": false,
            "include_root": 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": "dir_entries",
            "entries": [
                {"path": root_path, "file_type": "dir", "depth": 0},
                {"path": PathBuf::from("dir1"), "file_type": "dir", "depth": 1},
                {"path": PathBuf::from("dir2"), "file_type": "dir", "depth": 1},
                {"path": PathBuf::from("file1"), "file_type": "file", "depth": 1},
                {"path": PathBuf::from("file2"), "file_type": "file", "depth": 1},
            ],
            "errors": [],
        }),
        "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 = make_directory();
    let dir = temp.child("missing-dir");

    let id = rand::random::<u64>().to_string();
    let req = json!({
        "id": id,
        "payload": {
            "type": "dir_read",
            "path": dir.to_path_buf(),
            "depth": 1,
            "absolute": false,
            "canonicalize": false,
            "include_root": false,
        },
    });

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

    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}");
}