rustfs-cli 0.1.12

A Rust S3 CLI client for S3-compatible object storage
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
//! Golden tests for verifying JSON output format stability
//!
//! These tests ensure that the JSON output format remains stable
//! and matches the schema defined in `schemas/output_v1.json`.
//!
//! Run with: `cargo test --features golden`

#![cfg(feature = "golden")]

use std::process::Command;

/// Get the path to the rc binary
fn rc_binary() -> String {
    // Use cargo to build and get the binary path
    let output = Command::new("cargo")
        .args(["build", "--release", "-p", "rustfs-cli"])
        .output()
        .expect("Failed to build rc binary");

    if !output.status.success() {
        panic!(
            "Failed to build rc binary: {}",
            String::from_utf8_lossy(&output.stderr)
        );
    }

    // Return path to binary
    env!("CARGO_MANIFEST_DIR").to_string() + "/../../target/release/rc"
}

mod alias_tests {
    use super::*;
    use tempfile::TempDir;

    /// Set up a temporary config directory for isolated testing
    fn setup_test_env() -> TempDir {
        let temp_dir = TempDir::new().expect("Failed to create temp dir");
        temp_dir
    }

    #[test]
    fn test_alias_list_empty_json() {
        let temp_dir = setup_test_env();
        let config_dir = temp_dir.path().to_str().unwrap();

        let output = Command::new(rc_binary())
            .args(["alias", "list", "--json"])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "Command should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        // Verify structure matches schema
        insta::assert_json_snapshot!("alias_list_empty", json);
    }

    #[test]
    fn test_alias_set_json() {
        let temp_dir = setup_test_env();
        let config_dir = temp_dir.path().to_str().unwrap();

        let output = Command::new(rc_binary())
            .args([
                "alias",
                "set",
                "test-alias",
                "http://localhost:9000",
                "accesskey",
                "secretkey",
                "--json",
            ])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "Command should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        // Verify structure matches schema
        insta::assert_json_snapshot!("alias_set_success", json);
    }

    #[test]
    fn test_alias_list_with_aliases_json() {
        let temp_dir = setup_test_env();
        let config_dir = temp_dir.path().to_str().unwrap();

        // First, set up some aliases
        Command::new(rc_binary())
            .args([
                "alias",
                "set",
                "local",
                "http://localhost:9000",
                "accesskey",
                "secretkey",
                "--json",
            ])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to set alias");

        Command::new(rc_binary())
            .args([
                "alias",
                "set",
                "s3",
                "https://s3.amazonaws.com",
                "awskey",
                "awssecret",
                "--region",
                "us-west-2",
                "--json",
            ])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to set alias");

        // Now list them
        let output = Command::new(rc_binary())
            .args(["alias", "list", "--json"])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "Command should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        // Verify structure - aliases should be sorted by name for consistent snapshots
        assert!(json["aliases"].is_array());
        assert_eq!(json["aliases"].as_array().unwrap().len(), 2);

        insta::assert_json_snapshot!("alias_list_with_aliases", json);
    }

    #[test]
    fn test_alias_remove_json() {
        let temp_dir = setup_test_env();
        let config_dir = temp_dir.path().to_str().unwrap();

        // First, set up an alias
        Command::new(rc_binary())
            .args([
                "alias",
                "set",
                "to-remove",
                "http://localhost:9000",
                "accesskey",
                "secretkey",
                "--json",
            ])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to set alias");

        // Now remove it
        let output = Command::new(rc_binary())
            .args(["alias", "remove", "to-remove", "--json"])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "Command should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        insta::assert_json_snapshot!("alias_remove_success", json);
    }

    #[test]
    fn test_alias_remove_not_found_json() {
        let temp_dir = setup_test_env();
        let config_dir = temp_dir.path().to_str().unwrap();

        let output = Command::new(rc_binary())
            .args(["alias", "remove", "nonexistent", "--json"])
            .env("RC_CONFIG_DIR", config_dir)
            .output()
            .expect("Failed to execute rc");

        // Should fail with NOT_FOUND exit code (5)
        assert!(!output.status.success(), "Command should fail");
        assert_eq!(
            output.status.code(),
            Some(5),
            "Exit code should be 5 (NOT_FOUND)"
        );

        let stderr = String::from_utf8_lossy(&output.stderr);
        let json: serde_json::Value =
            serde_json::from_str(&stderr).expect("Output should be valid JSON");

        insta::assert_json_snapshot!("alias_remove_not_found", json);
    }
}

/// Integration tests that require a running S3-compatible server (RustFS)
/// These tests use the TEST_S3_* environment variables
#[cfg(feature = "integration")]
mod s3_tests {
    use super::*;
    use std::time::{SystemTime, UNIX_EPOCH};
    use tempfile::TempDir;

    fn get_s3_env() -> Option<(String, String, String)> {
        let endpoint = std::env::var("TEST_S3_ENDPOINT").ok()?;
        let access_key = std::env::var("TEST_S3_ACCESS_KEY").ok()?;
        let secret_key = std::env::var("TEST_S3_SECRET_KEY").ok()?;
        Some((endpoint, access_key, secret_key))
    }

    fn setup_test_env_with_alias() -> Option<(TempDir, String)> {
        let (endpoint, access_key, secret_key) = get_s3_env()?;
        let temp_dir = TempDir::new().expect("Failed to create temp dir");
        let config_dir = temp_dir.path().to_str().unwrap().to_string();

        // Set up the test alias
        let output = Command::new(rc_binary())
            .args([
                "alias",
                "set",
                "test",
                &endpoint,
                &access_key,
                &secret_key,
                "--json",
            ])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to set alias");

        if !output.status.success() {
            eprintln!(
                "Failed to set alias: {}",
                String::from_utf8_lossy(&output.stderr)
            );
            return None;
        }

        Some((temp_dir, config_dir))
    }

    fn unique_bucket_name() -> String {
        let ts = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_millis();
        format!("test-bucket-{}", ts)
    }

    #[test]
    fn test_mb_json() {
        let Some((temp_dir, config_dir)) = setup_test_env_with_alias() else {
            eprintln!("Skipping test: S3 environment not configured");
            return;
        };

        let bucket = unique_bucket_name();
        let output = Command::new(rc_binary())
            .args(["mb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "mb should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        assert_eq!(json["success"], true);
        assert!(json["bucket"].as_str().unwrap().contains("test-bucket"));

        // Cleanup: remove the bucket
        Command::new(rc_binary())
            .args(["rb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .ok();

        drop(temp_dir);
    }

    #[test]
    fn test_rb_json() {
        let Some((temp_dir, config_dir)) = setup_test_env_with_alias() else {
            eprintln!("Skipping test: S3 environment not configured");
            return;
        };

        let bucket = unique_bucket_name();

        // First create the bucket
        Command::new(rc_binary())
            .args(["mb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to create bucket");

        // Now remove it
        let output = Command::new(rc_binary())
            .args(["rb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "rb should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        assert_eq!(json["success"], true);

        drop(temp_dir);
    }

    #[test]
    fn test_ls_empty_bucket_json() {
        let Some((temp_dir, config_dir)) = setup_test_env_with_alias() else {
            eprintln!("Skipping test: S3 environment not configured");
            return;
        };

        let bucket = unique_bucket_name();

        // Create bucket
        Command::new(rc_binary())
            .args(["mb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to create bucket");

        // List empty bucket
        let output = Command::new(rc_binary())
            .args(["ls", &format!("test/{}/", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "ls should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        assert!(json["items"].is_array());
        assert_eq!(json["truncated"], false);

        // Cleanup
        Command::new(rc_binary())
            .args(["rb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .ok();

        drop(temp_dir);
    }

    #[test]
    fn test_ls_with_objects_json() {
        let Some((temp_dir, config_dir)) = setup_test_env_with_alias() else {
            eprintln!("Skipping test: S3 environment not configured");
            return;
        };

        let bucket = unique_bucket_name();

        // Create bucket
        Command::new(rc_binary())
            .args(["mb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to create bucket");

        // Upload a test file using pipe
        let output = Command::new(rc_binary())
            .args(["pipe", &format!("test/{}/test-file.txt", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .stdin(std::process::Stdio::piped())
            .stdout(std::process::Stdio::piped())
            .stderr(std::process::Stdio::piped())
            .spawn()
            .and_then(|mut child| {
                use std::io::Write;
                if let Some(ref mut stdin) = child.stdin {
                    stdin.write_all(b"Hello, World!").ok();
                }
                child.wait_with_output()
            });

        if output.is_err() {
            // Cleanup and skip
            Command::new(rc_binary())
                .args(["rb", &format!("test/{}", bucket), "--force", "--json"])
                .env("RC_CONFIG_DIR", &config_dir)
                .output()
                .ok();
            eprintln!("Skipping test: pipe command failed");
            return;
        }

        // List bucket with object
        let output = Command::new(rc_binary())
            .args(["ls", &format!("test/{}/", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to execute rc");

        assert!(output.status.success(), "ls should succeed");

        let stdout = String::from_utf8_lossy(&output.stdout);
        let json: serde_json::Value =
            serde_json::from_str(&stdout).expect("Output should be valid JSON");

        assert!(json["items"].is_array());
        let items = json["items"].as_array().unwrap();
        assert!(!items.is_empty(), "Should have at least one item");

        // Cleanup: remove object and bucket
        Command::new(rc_binary())
            .args(["rm", &format!("test/{}/test-file.txt", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .ok();

        Command::new(rc_binary())
            .args(["rb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .ok();

        drop(temp_dir);
    }

    #[test]
    fn test_stat_json() {
        let Some((temp_dir, config_dir)) = setup_test_env_with_alias() else {
            eprintln!("Skipping test: S3 environment not configured");
            return;
        };

        let bucket = unique_bucket_name();

        // Create bucket
        Command::new(rc_binary())
            .args(["mb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to create bucket");

        // Upload a test file
        let upload = Command::new(rc_binary())
            .args(["pipe", &format!("test/{}/stat-test.txt", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .stdin(std::process::Stdio::piped())
            .stdout(std::process::Stdio::piped())
            .stderr(std::process::Stdio::piped())
            .spawn()
            .and_then(|mut child| {
                use std::io::Write;
                if let Some(ref mut stdin) = child.stdin {
                    stdin.write_all(b"Test content for stat").ok();
                }
                child.wait_with_output()
            });

        if upload.is_err() {
            Command::new(rc_binary())
                .args(["rb", &format!("test/{}", bucket), "--force", "--json"])
                .env("RC_CONFIG_DIR", &config_dir)
                .output()
                .ok();
            eprintln!("Skipping test: pipe command failed");
            return;
        }

        // Get stat
        let output = Command::new(rc_binary())
            .args(["stat", &format!("test/{}/stat-test.txt", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .expect("Failed to execute rc");

        if output.status.success() {
            let stdout = String::from_utf8_lossy(&output.stdout);
            let json: serde_json::Value =
                serde_json::from_str(&stdout).expect("Output should be valid JSON");

            assert!(json["key"].is_string());
            assert!(json["size_bytes"].is_number());
        }

        // Cleanup
        Command::new(rc_binary())
            .args(["rm", &format!("test/{}/stat-test.txt", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .ok();

        Command::new(rc_binary())
            .args(["rb", &format!("test/{}", bucket), "--json"])
            .env("RC_CONFIG_DIR", &config_dir)
            .output()
            .ok();

        drop(temp_dir);
    }
}