firetrap 0.1.0

Modern, safe and extensible FTP server library for Rust
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

extern crate firetrap;
extern crate ftp;
extern crate tempfile;

use std::{thread, time};
use ftp::FtpStream;

// TODO: Replace `unwrap()` in tests with `expect()`, so it's more clear what
// went wrong if a test fails.

macro_rules! start_server {
    ( $addr:expr, $path:expr ) => {
        thread::spawn(move || {
            let server = firetrap::Server::with_root($path);
            server.listen($addr.clone());
        });

        // Give the server some time to start
        thread::sleep(time::Duration::from_millis(100));
    };
    ( $addr:expr ) => {
        let root = std::env::temp_dir();
        start_server!($addr, root)
    };
}

#[test]
fn connect() {
    let addr = "127.0.0.1:1234";
    start_server!(addr);
    let mut _ftp_stream = FtpStream::connect(addr).unwrap();

}

#[test]
fn login() {
    let addr = "127.0.0.1:1235";
    let username = "koen";
    let password = "hoi";

    start_server!(addr);
    let mut ftp_stream = FtpStream::connect(addr).unwrap();
    let _ = ftp_stream.login(username, password).unwrap();
}

#[test]
fn noop() {
    let addr = "127.0.0.1:1236";

    start_server!(addr);
    let mut ftp_stream = FtpStream::connect(addr).unwrap();

    // Make sure we fail if we're not logged in
    let _ = ftp_stream.noop().unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    let _ = ftp_stream.noop().unwrap();
}

#[test]
fn get() {
    extern crate rand;

    use std::io::Write;

    let addr = "127.0.0.1:1237";

    let root = std::env::temp_dir();
    let mut filename = root.clone();
    start_server!(addr, root);

    // Create a temporary file in the FTP root that we'll retrieve
    filename.push("bla.txt");
    let mut f = std::fs::File::create(filename.clone()).unwrap();

    // Write some random data to our file
    let mut data = vec![0; 1024];
    for x in data.iter_mut() {
        *x = rand::random();
    }
    f.write_all(&data).unwrap();

    // Retrieve the remote file
    let mut ftp_stream = FtpStream::connect(addr).unwrap();

    // Make sure we fail if we're not logged in
    let _ = ftp_stream.simple_retr("bla.txt").unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    let remote_file = ftp_stream.simple_retr("bla.txt").unwrap();
    let remote_data = remote_file.into_inner();

    assert_eq!(remote_data, data);
}

#[test]
fn put() {
    use std::io::Cursor;

    let addr = "127.0.0.1:1238";
    start_server!(addr);

    let content = b"Hello from this test!\n";

    let mut ftp_stream = FtpStream::connect(addr).unwrap();
    let mut reader = Cursor::new(content);

    // Make sure we fail if we're not logged in
    ftp_stream.put("greeting.txt", &mut reader).unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    ftp_stream.put("greeting.txt", &mut reader).unwrap();

    // retrieve file back again, and check if we got the same back.
    let remote_data = ftp_stream.simple_retr("greeting.txt").unwrap().into_inner();
    assert_eq!(remote_data, content);
}

#[test]
fn list() {
    let addr = "127.0.0.1:1239";
    let root = std::env::temp_dir();
    let path = root.clone();
    start_server!(addr, path);

    // Create a filename in the ftp root that we will look for in the `LIST` output
    let path = root.join("test.txt");
    {
        let _f = std::fs::File::create(path);
    }

    let mut ftp_stream = FtpStream::connect(addr).unwrap();

    // Make sure we fail if we're not logged in
    let _list = ftp_stream.list(None).unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    let list = ftp_stream.list(None).unwrap();
    let mut found = false;
    for entry in list {
        if entry.contains("test.txt") {
            found = true;
            break;
        }
    }
    assert!(found);
}

#[test]
fn pwd() {
    let addr = "127.0.0.1:1240";
    let root = std::env::temp_dir();
    let path = root.clone();
    start_server!(addr, path);

    let mut ftp_stream = FtpStream::connect(addr).unwrap();

    // Make sure we fail if we're not logged in
    let _pwd = ftp_stream.pwd().unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    let pwd = ftp_stream.pwd().unwrap();
    assert_eq!(&pwd, "/");
}

#[test]
fn cwd() {
    let addr = "127.0.0.1:1241";
    let root = std::env::temp_dir();
    let path = root.clone();
    start_server!(addr, root);

    let mut ftp_stream = FtpStream::connect(addr).unwrap();
    let dir_in_root = tempfile::TempDir::new_in(path).unwrap();
    let basename = dir_in_root.path().file_name().unwrap();

    // Make sure we fail if we're not logged in
    ftp_stream.cwd(basename.to_str().unwrap()).unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    ftp_stream.cwd(basename.to_str().unwrap()).unwrap();
    let pwd = ftp_stream.pwd().unwrap();
    assert_eq!(std::path::Path::new(&pwd), std::path::Path::new("/").join(&basename));
}

#[test]
fn cdup() {
    let addr = "127.0.0.1:1242";
    let root = std::env::temp_dir();
    let path = root.clone();
    start_server!(addr, root);

    let mut ftp_stream = FtpStream::connect(addr).unwrap();
    let dir_in_root = tempfile::TempDir::new_in(path).unwrap();
    let basename = dir_in_root.path().file_name().unwrap();

    // Make sure we fail if we're not logged in
    ftp_stream.cdup().unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    ftp_stream.cwd(basename.to_str().unwrap()).unwrap();
    let pwd = ftp_stream.pwd().unwrap();
    assert_eq!(std::path::Path::new(&pwd), std::path::Path::new("/").join(&basename));

    ftp_stream.cdup().unwrap();
    let pwd = ftp_stream.pwd().unwrap();
    assert_eq!(std::path::Path::new(&pwd), std::path::Path::new("/"));
}

#[test]
fn dele() {
    let addr = "127.0.0.1:1243";
    let root = std::env::temp_dir();
    start_server!(addr, root);

    let mut ftp_stream = FtpStream::connect(addr).unwrap();
    let file_in_root = tempfile::NamedTempFile::new().unwrap();
    let file_name = file_in_root.path().file_name().unwrap().to_str().unwrap();

    // Make sure we fail if we're not logged in
    ftp_stream.rm(file_name).unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    ftp_stream.rm(file_name).unwrap();
    assert_eq!(std::fs::metadata(file_name).unwrap_err().kind(), std::io::ErrorKind::NotFound);
}

#[test]
fn quit() {
    let addr = "127.0.0.1:1244";
    let root = std::env::temp_dir();
    start_server!(addr, root);

    let mut ftp_stream = FtpStream::connect(addr).unwrap();
    ftp_stream.quit().unwrap();
    // Make sure the connection is actually closed
    // This may take some time, so we'll sleep for a bit.
    std::thread::sleep(std::time::Duration::from_millis(10));
    ftp_stream.noop().unwrap_err();
}

#[test]
fn nlst() {
    let addr = "127.0.0.1:1245";
    let root = tempfile::TempDir::new().unwrap().into_path();
    let path = root.clone();
    println!("path: {:?}", root);
    start_server!(addr, root);

    // Create a filename that we wanna see in the `NLST` output
    let path = path.join("test.txt");
    {
        let _f = std::fs::File::create(path);
    }

    let mut ftp_stream = FtpStream::connect(addr).unwrap();

    // Make sure we fail if we're not logged in
    let _list = ftp_stream.nlst(None).unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    let list = ftp_stream.nlst(None).unwrap();
    assert_eq!(list, vec!["test.txt"]);
}

#[test]
fn mkdir() {
    let addr = "127.0.0.1:1246";
    let root = tempfile::TempDir::new().unwrap().into_path();
    let server_root = root.clone();
    start_server!(addr, server_root);

    let mut ftp_stream = FtpStream::connect(addr).unwrap();
    let new_dir_name = "hallo";
    // Make sure we fail if we're not logged in
    ftp_stream.mkdir(new_dir_name).unwrap_err();

    let _ = ftp_stream.login("hoi", "jij").unwrap();
    ftp_stream.mkdir(new_dir_name).unwrap();

    let full_path = root.join(new_dir_name);
    let metadata = std::fs::metadata(full_path).unwrap();
    assert!(metadata.is_dir());
}