spill 0.5.1

Modern torrent client
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

use crate::common::{BIN, Daemon, Temp, WebSeed, metainfo, seed_metainfo};
use serde_json::json;
use std::sync::atomic::Ordering;
use std::time::Duration;

#[tokio::test]
async fn add_download_seed() {
    let root = Temp::new();
    let source = WebSeed::new().await;
    let mut daemon = Daemon::start(&root.0, "web_seeds=true", None).await;
    let id = daemon.add(&metainfo(Some(&source.url)), None).await;
    let row = daemon.state(&id, "seeding").await;
    assert_eq!(row["verified_bytes"], 3);
    assert!(row["transfer"]["trackers"].is_array());
    assert!(row["transfer"]["download_bytes_per_second"].is_number());
    assert!(row["transfer"]["upload_bytes_per_second"].is_number());
    assert_eq!(std::fs::read(root.0.join("downloads/x")).unwrap(), b"abc");
    assert_eq!(source.hits.load(Ordering::Relaxed), 1);
    daemon.stop().await;
}

#[tokio::test]
async fn resuming_a_queued_torrent_does_not_preempt_a_running_download() {
    use tokio::io::{AsyncReadExt, AsyncWriteExt};
    let root = Temp::new();
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
    let url = format!("http://{}/payload", listener.local_addr().unwrap());
    let release = std::sync::Arc::new(tokio::sync::Notify::new());
    let gate = release.clone();
    let seed = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        let mut request = Vec::new();
        while !request.ends_with(b"\r\n\r\n") {
            request.push(stream.read_u8().await.unwrap());
        }
        gate.notified().await;
        stream.write_all(b"HTTP/1.1 206 Partial Content\r\nContent-Length: 3\r\nContent-Range: bytes 0-2/3\r\nConnection: close\r\n\r\nabc").await.unwrap();
    });
    let mut daemon = Daemon::start(&root.0, "web_seeds=true", None).await;
    let a = daemon.add(&seed_metainfo("a", b"abc", None), None).await;
    daemon.state(&a, "downloading").await;
    daemon.call(json!({"op":"pause", "id":a})).await;
    let b = daemon.add(&metainfo(Some(&url)), None).await;
    daemon.state(&b, "downloading").await;
    daemon.call(json!({"op":"resume", "id":a})).await;
    for _ in 0..5 {
        assert_eq!(
            daemon.call(json!({"op":"get", "id":a})).await["state"],
            "queued"
        );
        assert_eq!(
            daemon.call(json!({"op":"get", "id":b})).await["state"],
            "downloading"
        );
        tokio::time::sleep(Duration::from_millis(250)).await;
    }
    release.notify_one();
    daemon.state(&b, "seeding").await;
    daemon.state(&a, "downloading").await;
    daemon.stop().await;
    seed.await.unwrap();
}

#[tokio::test]
async fn ipv6_restart_keeps_torrents_running_when_lazy_dht_fails() {
    let root = Temp::new();
    std::fs::create_dir_all(root.0.join("downloads")).unwrap();
    std::fs::write(root.0.join("downloads/x"), b"abc").unwrap();
    let mut daemon = Daemon::start(&root.0, "dht=true\nweb_seeds=false", None).await;
    let id = daemon.add(&seed_metainfo("x", b"abc", None), None).await;
    daemon.state(&id, "seeding").await;
    daemon.stop().await;
    let config = root.0.join("config.toml");
    let contents = std::fs::read_to_string(&config)
        .unwrap()
        .replace("127.0.0.1:0", "[::1]:0")
        .replace("dht=true", "dht=false");
    std::fs::write(&config, contents).unwrap();
    let log = root.0.join("stderr");
    daemon.child = tokio::process::Command::new(BIN)
        .arg("serve")
        .arg("--config")
        .arg(config)
        .stderr(std::fs::File::create(&log).unwrap())
        .kill_on_drop(true)
        .spawn()
        .unwrap();
    tokio::time::timeout(Duration::from_secs(5), async {
        while tokio::net::UnixStream::connect(&daemon.socket)
            .await
            .is_err()
        {
            assert!(daemon.child.try_wait().unwrap().is_none());
            tokio::time::sleep(Duration::from_millis(10)).await;
        }
    })
    .await
    .unwrap();
    let row = daemon.state(&id, "seeding").await;
    assert_eq!(row["settings"]["dht"], true);
    tokio::time::sleep(Duration::from_secs(2)).await;
    assert!(daemon.child.try_wait().unwrap().is_none());
    assert!(
        daemon.call(json!({"op":"health"})).await["listen"]
            .as_str()
            .unwrap()
            .starts_with("[::1]:")
    );
    daemon.state(&id, "seeding").await;
    daemon.stop().await;
    assert_eq!(
        std::fs::read_to_string(log)
            .unwrap()
            .matches("DHT disabled:")
            .count(),
        1
    );
}

#[tokio::test]
async fn restart_resumes_from_verified_checkpoint_and_rejects_old_catalogs() {
    let root = Temp::new();
    let source = WebSeed::new().await;
    let bytes = metainfo(Some(&source.url));
    let mut daemon = Daemon::start(&root.0, "web_seeds=true", None).await;
    let id = daemon.add(&bytes, None).await;
    daemon.state(&id, "seeding").await;
    daemon.stop().await;
    let db = rusqlite::Connection::open(root.0.join("state/catalog.sqlite")).unwrap();
    assert_eq!(
        db.query_row("PRAGMA user_version", [], |r| r.get::<_, i64>(0))
            .unwrap(),
        3
    );
    let resume: Vec<u8> = db
        .query_row("SELECT resume FROM torrents", [], |r| r.get(0))
        .unwrap();
    assert!(!resume.is_empty());
    let mut daemon = Daemon::start(&root.0, "web_seeds=true", None).await;
    daemon.state(&id, "seeding").await;
    assert_eq!(
        source.hits.load(Ordering::Relaxed),
        1,
        "resume should not download again"
    );
    daemon.stop().await;
    // A supplied resume must still be checked against the reopened files.
    // Same-length damage must invalidate the saved verified bit and be repaired.
    let payload = root.0.join("downloads/x");
    let modified = std::fs::metadata(&payload).unwrap().modified().unwrap();
    std::fs::write(&payload, b"bad").unwrap();
    let modified = modified + Duration::from_nanos(1);
    std::fs::File::options()
        .write(true)
        .open(&payload)
        .unwrap()
        .set_modified(modified)
        .unwrap();
    assert_eq!(
        std::fs::metadata(&payload).unwrap().modified().unwrap(),
        modified
    );
    let mut daemon = Daemon::start(&root.0, "web_seeds=true", None).await;
    daemon.state(&id, "seeding").await;
    assert_eq!(source.hits.load(Ordering::Relaxed), 2);
    assert_eq!(std::fs::read(root.0.join("downloads/x")).unwrap(), b"abc");
    daemon.call(json!({"op":"recheck","id":id})).await;
    daemon.state(&id, "paused").await;
    daemon.stop().await;
    db.execute_batch("PRAGMA user_version=9").unwrap();
    drop(db);
    let status = tokio::process::Command::new(BIN)
        .arg("serve")
        .arg("--config")
        .arg(root.0.join("config.toml"))
        .output()
        .await
        .unwrap();
    assert_eq!(status.status.code(), Some(1));
    assert!(String::from_utf8_lossy(&status.stderr).contains("fresh state directory"));
}

#[tokio::test]
async fn pause_resume_remove_keep_and_delete_payload() {
    let root = Temp::new();
    let source = WebSeed::new().await;
    let mut daemon = Daemon::start(&root.0, "web_seeds=true", None).await;
    let bytes = metainfo(Some(&source.url));
    let id = daemon.add(&bytes, None).await;
    daemon.state(&id, "seeding").await;
    daemon.call(json!({"op":"pause","id":id})).await;
    daemon.state(&id, "paused").await;
    daemon.call(json!({"op":"resume","id":id})).await;
    daemon.state(&id, "seeding").await;
    daemon
        .call(json!({"op":"remove","id":id,"delete_payload":false}))
        .await;
    assert!(root.0.join("downloads/x").exists());
    assert_eq!(daemon.raw(json!({"op":"get","id":id})).await["code"], 3);
    let output = root.0.join("second");
    let id = daemon.add(&bytes, Some(&output)).await;
    daemon.state(&id, "seeding").await;
    daemon
        .call(json!({"op":"remove","id":id,"delete_payload":true}))
        .await;
    assert!(!output.join("x").exists());
    assert!(root.0.join("downloads/x").exists());
    daemon.stop().await;
}

#[tokio::test]
async fn get_set_settings_take_effect_and_cli_uses_the_same_schema() {
    let root = Temp::new();
    let source = WebSeed::new().await;
    let mut daemon = Daemon::start(&root.0, "web_seeds=false", None).await;
    let id = daemon.add(&metainfo(Some(&source.url)), None).await;
    daemon.state(&id, "downloading").await;
    assert_eq!(source.hits.load(Ordering::Relaxed), 0);
    assert_eq!(
        daemon
            .raw(json!({"op":"set","id":id,"values":{"seed_ratio":-1.0}}))
            .await["code"],
        2
    );
    assert_eq!(
        daemon.call(json!({"op":"get","id":id})).await["settings"]["seed_ratio"],
        0.0
    );
    let result = tokio::process::Command::new(BIN)
        .arg("--socket")
        .arg(&daemon.socket)
        .args([
            "set",
            &id,
            "download_limit=100",
            "upload_limit=200",
            "seed_ratio=0",
            "seed_time=1",
            "file_priorities=[\"high\"]",
            "trackers=false",
            "dht=false",
            "pex=false",
            "web_seeds=true",
        ])
        .output()
        .await
        .unwrap();
    assert!(
        result.status.success(),
        "{}",
        String::from_utf8_lossy(&result.stderr)
    );
    let row = daemon.call(json!({"op":"get","id":id})).await;
    assert_eq!(row["settings"]["download_limit"], 100);
    assert_eq!(row["settings"]["file_priorities"], json!(["high"]));
    daemon.state(&id, "seeding").await;
    daemon.state(&id, "paused").await;
    let files = daemon.call(json!({"op":"files","id":id})).await;
    assert_eq!(files["files"][0]["priority"], "high");
    assert_eq!(
        daemon
            .raw(json!({"op":"set","id":id,"values":{"unknown_key":true}}))
            .await["code"],
        2
    );
    let output = tokio::process::Command::new(BIN)
        .arg("--socket")
        .arg(&daemon.socket)
        .args(["list", "--json"])
        .output()
        .await
        .unwrap();
    assert!(output.status.success());
    assert_eq!(
        serde_json::from_slice::<serde_json::Value>(&output.stdout).unwrap()["torrents"][0]["id"],
        id
    );
    daemon.stop().await;
}