sulfite-tools 0.0.9

A high-level S3 client built on AWS SDK for Rust for bandwidth saturation (CLI tools)
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
//! LocalStack integration tests for the sulfite CLI.
//!
//! Requires LocalStack running (e.g. `docker run --rm -it -p 4566:4566 localstack/localstack`).
//! Set `LOCALSTACK_ENDPOINT` to override default `http://localhost:4566`.
//!
//! Each test uses a random hex run id so tests are independent. Setup (bucket, put object) uses the
//! sulfite library; assertions run the sulfite CLI and check exit status and output.

use std::process::Command;
use std::sync::Once;

use sulfite::{generate_random_hex, RetryConfig, S3Client, S3ClientConfig};

const DEFAULT_LOCALSTACK_ENDPOINT: &str = "http://localhost:4566";
const TEST_BUCKET: &str = "sulfite-test-bucket";
const RANDOM_HEX_LEN: usize = 32;

static ENV_LOGGER: Once = Once::new();

fn localstack_endpoint() -> String {
    std::env::var("LOCALSTACK_ENDPOINT").unwrap_or_else(|_| DEFAULT_LOCALSTACK_ENDPOINT.into())
}

fn cli_base_args() -> Vec<String> {
    vec![
        "--endpoint-url".into(),
        localstack_endpoint(),
        "--region".into(),
        "us-east-1".into(),
    ]
}

fn run_cli(args: &[&str]) -> (bool, String, String) {
    ENV_LOGGER.call_once(|| {
        let _ = env_logger::builder().is_test(true).try_init();
    });
    let exe = env!("CARGO_BIN_EXE_sulfite");
    let mut cmd = Command::new(exe);
    cmd.env("AWS_ACCESS_KEY_ID", "test");
    cmd.env("AWS_SECRET_ACCESS_KEY", "test");
    cmd.env("AWS_REGION", "us-east-1");
    cmd.args(cli_base_args());
    cmd.args(args);
    let out = cmd.output().expect("run sulfite CLI");
    let stdout = String::from_utf8_lossy(&out.stdout).into_owned();
    let stderr = String::from_utf8_lossy(&out.stderr).into_owned();
    (out.status.success(), stdout, stderr)
}

async fn make_client() -> S3Client {
    let endpoint = localstack_endpoint();
    let config = S3ClientConfig {
        endpoint_url: Some(endpoint),
        region: Some("us-east-1".into()),
        access_secret_session_tuple: Some(("test".into(), "test".into(), None)),
        ..S3ClientConfig::default()
    };
    S3Client::new(config, RetryConfig::default()).await
}

async fn ensure_bucket(client: &S3Client, bucket: &str) {
    let _ = client.create_bucket(bucket).await;
}

// Put object via library, then CLI head
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_head_after_put() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let key = format!("cli-head/{}/obj", run);
    let body = b"hello cli head";

    client
        .put_object(TEST_BUCKET, &key, body, None)
        .await
        .expect("put_object");

    let (ok, stdout, stderr) = run_cli(&["head", "--bucket", TEST_BUCKET, "--key", &key]);
    assert!(ok, "cli head failed: stderr={}", stderr);
    assert!(
        stdout.contains(&key) || stdout.contains("key") || stdout.contains("size"),
        "stdout: {}",
        stdout
    );

    let _ = client.delete_object(TEST_BUCKET, &key).await;
}

// Put object via library, CLI download to file, assert content
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_download_after_put() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let key = format!("cli-download/{}/obj", run);
    let body = b"download me";

    client
        .put_object(TEST_BUCKET, &key, body, None)
        .await
        .expect("put_object");

    let tmp = std::env::temp_dir().join(format!("sulfite_cli_test_{}", run));
    let path = tmp.to_str().unwrap();
    let (ok, _stdout, stderr) = run_cli(&[
        "download",
        "--bucket",
        TEST_BUCKET,
        "--key",
        &key,
        "--local-path",
        path,
    ]);
    assert!(ok, "cli download failed: stderr={}", stderr);
    let got = std::fs::read(&tmp).expect("read downloaded file");
    assert_eq!(got.as_slice(), body);

    let _ = std::fs::remove_file(&tmp);
    let _ = client.delete_object(TEST_BUCKET, &key).await;
}

// Put objects via library, CLI list with prefix, assert count in output
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_list_after_put() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let prefix = format!("cli-list/{}/", run);
    let n = 5u32;

    for i in 0..n {
        let key = format!("{}k{:02}", prefix, i);
        client
            .put_object(TEST_BUCKET, &key, format!("body-{}", i).as_bytes(), None)
            .await
            .expect("put_object");
    }

    let (ok, stdout, stderr) = run_cli(&["list", "--bucket", TEST_BUCKET, "--prefix", &prefix]);
    assert!(ok, "cli list failed: stderr={}", stderr);
    assert!(
        stdout.contains("Found 5 objects") || stdout.contains("5 objects"),
        "stdout: {}",
        stdout
    );

    for i in 0..n {
        let _ = client
            .delete_object(TEST_BUCKET, &format!("{}k{:02}", prefix, i))
            .await;
    }
}

// Create temp file, CLI upload, then head via library
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_upload_then_head() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let key = format!("cli-upload/{}/obj", run);
    let body = b"uploaded via cli";

    let tmp = std::env::temp_dir().join(format!("sulfite_cli_upload_{}", run));
    std::fs::write(&tmp, body).expect("write temp file");
    let path = tmp.to_str().unwrap();

    let (ok, _stdout, stderr) = run_cli(&[
        "upload",
        "--bucket",
        TEST_BUCKET,
        "--key",
        &key,
        "--local-path",
        path,
    ]);
    assert!(ok, "cli upload failed: stderr={}", stderr);

    let info = client
        .head_object(TEST_BUCKET, &key)
        .await
        .expect("head_object");
    assert_eq!(info.key, key);
    assert_eq!(info.size, body.len() as u64);

    let _ = std::fs::remove_file(&tmp);
    let _ = client.delete_object(TEST_BUCKET, &key).await;
}

// Put object via library, CLI copy, head copy via library
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_copy_then_head() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let src_key = format!("cli-copy/{}/src", run);
    let dst_key = format!("cli-copy/{}/dst", run);
    let body = b"copy me";

    client
        .put_object(TEST_BUCKET, &src_key, body, None)
        .await
        .expect("put_object");

    let (ok, _stdout, stderr) = run_cli(&[
        "copy",
        "--src-bucket",
        TEST_BUCKET,
        "--src-key",
        &src_key,
        "--dst-bucket",
        TEST_BUCKET,
        "--dst-key",
        &dst_key,
    ]);
    assert!(ok, "cli copy failed: stderr={}", stderr);

    let info = client
        .head_object(TEST_BUCKET, &dst_key)
        .await
        .expect("head copy");
    assert_eq!(info.key, dst_key);
    assert_eq!(info.size, body.len() as u64);

    let _ = client.delete_object(TEST_BUCKET, &src_key).await;
    let _ = client.delete_object(TEST_BUCKET, &dst_key).await;
}

// Put object via library, CLI delete, head via library must 404
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_delete_then_head_404() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let key = format!("cli-delete/{}/obj", run);
    let body = b"delete me";

    client
        .put_object(TEST_BUCKET, &key, body, None)
        .await
        .expect("put_object");

    let (ok, _stdout, stderr) = run_cli(&["delete", "--bucket", TEST_BUCKET, "--key", &key]);
    assert!(ok, "cli delete failed: stderr={}", stderr);

    let err = client.head_object(TEST_BUCKET, &key).await.unwrap_err();
    if let sulfite::S3Error::AWSS3Error(_, _, _, code) = err {
        assert_eq!(code, 404);
    } else {
        panic!("expected 404, got {:?}", err);
    }
}

// Put in GLACIER via library, CLI download fails, CLI restore, CLI download succeeds (best-effort on LocalStack)
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_glacier_put_restore_get() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let key = format!("cli-glacier/{}/archived", run);
    let body = b"cold storage content";

    client
        .put_object(TEST_BUCKET, &key, body, Some("GLACIER"))
        .await
        .expect("put_object GLACIER");

    let tmp = std::env::temp_dir().join(format!("sulfite_cli_glacier_{}", run));
    let path = tmp.to_str().unwrap();

    let (ok_before, _stdout, stderr_before) = run_cli(&[
        "download",
        "--bucket",
        TEST_BUCKET,
        "--key",
        &key,
        "--local-path",
        path,
    ]);
    assert!(
        !ok_before,
        "download before restore should fail: stderr={}",
        stderr_before
    );

    let (ok_restore, _stdout, stderr_restore) = run_cli(&[
        "restore",
        "--bucket",
        TEST_BUCKET,
        "--key",
        &key,
        "--restore-tier",
        "Expedited",
        "--restore-days",
        "1",
    ]);
    assert!(ok_restore, "cli restore failed: stderr={}", stderr_restore);

    let (ok_after, _stdout, stderr_after) = run_cli(&[
        "download",
        "--bucket",
        TEST_BUCKET,
        "--key",
        &key,
        "--local-path",
        path,
    ]);
    assert!(
        ok_after,
        "download after restore failed: stderr={}",
        stderr_after
    );
    let got = std::fs::read(&tmp).expect("read downloaded file");
    assert_eq!(got.as_slice(), body);

    let _ = std::fs::remove_file(&tmp);
    let _ = client.delete_object(TEST_BUCKET, &key).await;
}

// CSV workflow: put 10 objects via library, list to CSV, csv download to dir, verify 10 files
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_csv_list_then_download() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let prefix = format!("cli-csv-dl/{}/", run);
    let n = 10u32;

    for i in 0..n {
        let key = format!("{}k{:02}", prefix, i);
        let body = format!("body-{}", i);
        client
            .put_object(TEST_BUCKET, &key, body.as_bytes(), None)
            .await
            .expect("put_object");
    }

    let base = std::env::temp_dir().join("sulfite_cli_csv").join(&run);
    let _ = std::fs::create_dir_all(&base).ok();
    let manifest = base.join("manifest.csv");
    let out_dir = base.join("out");
    let _ = std::fs::create_dir_all(&out_dir).ok();
    let manifest_s = manifest.to_str().unwrap();
    let out_dir_s = out_dir.to_str().unwrap();

    let (ok_list, _stdout, stderr_list) = run_cli(&[
        "list",
        "--bucket",
        TEST_BUCKET,
        "--prefix",
        &prefix,
        "--output-path",
        manifest_s,
    ]);
    assert!(ok_list, "cli list failed: stderr={}", stderr_list);

    let (ok_dl, _stdout, stderr_dl) = run_cli(&[
        "csv",
        manifest_s,
        "download",
        "--bucket",
        TEST_BUCKET,
        "--prefix",
        &prefix,
        "--local-dir",
        out_dir_s,
    ]);
    assert!(ok_dl, "cli csv download failed: stderr={}", stderr_dl);

    for i in 0..n {
        let key_file = out_dir.join(format!("k{:02}", i));
        let got = std::fs::read_to_string(&key_file).expect("read downloaded file");
        assert_eq!(got, format!("body-{}", i), "file k{:02}", i);
    }

    for i in 0..n {
        let _ = client
            .delete_object(TEST_BUCKET, &format!("{}k{:02}", prefix, i))
            .await;
    }
    let _ = std::fs::remove_dir_all(&base).ok();
}

// CSV workflow: create 10 local files, write CSV of keys, csv upload, then head each via library
#[tokio::test]
#[ignore = "requires LocalStack (run with: cargo test -p sulfite-tools --test localstack_cli -- --ignored)"]
async fn cli_csv_upload_then_head() {
    let client = make_client().await;
    ensure_bucket(&client, TEST_BUCKET).await;
    let run = generate_random_hex(RANDOM_HEX_LEN);
    let prefix = format!("cli-csv-ul/{}/", run);
    let n = 10u32;

    let base = std::env::temp_dir().join("sulfite_cli_csv_ul").join(&run);
    let _ = std::fs::create_dir_all(&base).ok();
    let mut csv_content = String::from("key\n");
    for i in 0..n {
        let name = format!("k{:02}", i);
        let body = format!("uploaded-{}", i);
        std::fs::write(base.join(&name), &body).expect("write file");
        csv_content.push_str(&name);
        csv_content.push('\n');
    }
    let manifest = base.join("keys.csv");
    std::fs::write(&manifest, &csv_content).expect("write CSV");
    let manifest_s = manifest.to_str().unwrap();
    let base_s = base.to_str().unwrap();

    let (ok_ul, _stdout, stderr_ul) = run_cli(&[
        "csv",
        manifest_s,
        "--has-header",
        "upload",
        "--bucket",
        TEST_BUCKET,
        "--prefix",
        &prefix,
        "--local-dir",
        base_s,
    ]);
    assert!(ok_ul, "cli csv upload failed: stderr={}", stderr_ul);

    for i in 0..n {
        let key = format!("{}k{:02}", prefix, i);
        let info = client
            .head_object(TEST_BUCKET, &key)
            .await
            .expect("head_object");
        assert_eq!(info.key, key);
        assert_eq!(info.size, format!("uploaded-{}", i).len() as u64);
        let _ = client.delete_object(TEST_BUCKET, &key).await;
    }
    let _ = std::fs::remove_dir_all(&base).ok();
}