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
//! version command - Manage bucket versioning
//!
//! Enable, disable, or check versioning status for a bucket.

use clap::{Args, Subcommand};
use rc_core::{AliasManager, ObjectStore as _};
use rc_s3::S3Client;
use serde::Serialize;

use crate::exit_code::ExitCode;
use crate::output::{Formatter, OutputConfig};

/// Manage bucket versioning
#[derive(Args, Debug)]
pub struct VersionArgs {
    #[command(subcommand)]
    pub command: VersionCommands,
}

#[derive(Subcommand, Debug)]
pub enum VersionCommands {
    /// Enable versioning for a bucket
    Enable(BucketArg),

    /// Suspend versioning for a bucket
    Suspend(BucketArg),

    /// Get versioning status for a bucket
    Info(BucketArg),

    /// List object versions
    List(ListVersionsArgs),
}

#[derive(Args, Debug)]
pub struct BucketArg {
    /// Path to the bucket (alias/bucket)
    pub path: String,

    /// Force operation even if capability detection fails
    #[arg(long)]
    pub force: bool,
}

#[derive(Args, Debug)]
pub struct ListVersionsArgs {
    /// Path to list versions (alias/bucket[/prefix])
    pub path: String,

    /// Maximum number of versions to show
    #[arg(short = 'n', long, default_value = "100")]
    pub max: i32,

    /// Force operation even if capability detection fails
    #[arg(long)]
    pub force: bool,
}

#[derive(Debug, Serialize)]
struct VersioningStatus {
    bucket: String,
    enabled: Option<bool>,
    status: String,
}

#[derive(Debug, Serialize)]
struct VersionInfo {
    key: String,
    version_id: String,
    is_latest: bool,
    is_delete_marker: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    last_modified: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    size_bytes: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    size_human: Option<String>,
}

/// Execute the version command
pub async fn execute(args: VersionArgs, output_config: OutputConfig) -> ExitCode {
    match args.command {
        VersionCommands::Enable(bucket_arg) => execute_enable(bucket_arg, output_config).await,
        VersionCommands::Suspend(bucket_arg) => execute_suspend(bucket_arg, output_config).await,
        VersionCommands::Info(bucket_arg) => execute_info(bucket_arg, output_config).await,
        VersionCommands::List(list_args) => execute_list(list_args, output_config).await,
    }
}

async fn execute_enable(args: BucketArg, output_config: OutputConfig) -> ExitCode {
    let formatter = Formatter::new(output_config);

    let (alias_name, bucket) = match parse_bucket_path(&args.path) {
        Ok(p) => p,
        Err(e) => {
            formatter.error(&e);
            return ExitCode::UsageError;
        }
    };

    let (client, _caps) = match setup_client(&alias_name, &bucket, args.force, &formatter).await {
        Ok(c) => c,
        Err(code) => return code,
    };

    match client.set_versioning(&bucket, true).await {
        Ok(()) => {
            if formatter.is_json() {
                let output = VersioningStatus {
                    bucket: bucket.clone(),
                    enabled: Some(true),
                    status: "Enabled".to_string(),
                };
                formatter.json(&output);
            } else {
                formatter.println(&format!("Versioning enabled for bucket '{bucket}'"));
            }
            ExitCode::Success
        }
        Err(e) => {
            formatter.error(&format!("Failed to enable versioning: {e}"));
            ExitCode::GeneralError
        }
    }
}

async fn execute_suspend(args: BucketArg, output_config: OutputConfig) -> ExitCode {
    let formatter = Formatter::new(output_config);

    let (alias_name, bucket) = match parse_bucket_path(&args.path) {
        Ok(p) => p,
        Err(e) => {
            formatter.error(&e);
            return ExitCode::UsageError;
        }
    };

    let (client, _caps) = match setup_client(&alias_name, &bucket, args.force, &formatter).await {
        Ok(c) => c,
        Err(code) => return code,
    };

    match client.set_versioning(&bucket, false).await {
        Ok(()) => {
            if formatter.is_json() {
                let output = VersioningStatus {
                    bucket: bucket.clone(),
                    enabled: Some(false),
                    status: "Suspended".to_string(),
                };
                formatter.json(&output);
            } else {
                formatter.println(&format!("Versioning suspended for bucket '{bucket}'"));
            }
            ExitCode::Success
        }
        Err(e) => {
            formatter.error(&format!("Failed to suspend versioning: {e}"));
            ExitCode::GeneralError
        }
    }
}

async fn execute_info(args: BucketArg, output_config: OutputConfig) -> ExitCode {
    let formatter = Formatter::new(output_config);

    let (alias_name, bucket) = match parse_bucket_path(&args.path) {
        Ok(p) => p,
        Err(e) => {
            formatter.error(&e);
            return ExitCode::UsageError;
        }
    };

    let (client, _caps) = match setup_client(&alias_name, &bucket, args.force, &formatter).await {
        Ok(c) => c,
        Err(code) => return code,
    };

    match client.get_versioning(&bucket).await {
        Ok(status) => {
            let (enabled, status_str) = match status {
                Some(true) => (Some(true), "Enabled"),
                Some(false) => (Some(false), "Suspended"),
                None => (None, "Not configured"),
            };

            if formatter.is_json() {
                let output = VersioningStatus {
                    bucket: bucket.clone(),
                    enabled,
                    status: status_str.to_string(),
                };
                formatter.json(&output);
            } else {
                formatter.println(&format!("Bucket: {bucket}"));
                formatter.println(&format!("Versioning: {status_str}"));
            }
            ExitCode::Success
        }
        Err(e) => {
            formatter.error(&format!("Failed to get versioning status: {e}"));
            ExitCode::GeneralError
        }
    }
}

async fn execute_list(args: ListVersionsArgs, output_config: OutputConfig) -> ExitCode {
    let formatter = Formatter::new(output_config);

    let (alias_name, bucket, prefix) = match parse_version_path(&args.path) {
        Ok(p) => p,
        Err(e) => {
            formatter.error(&e);
            return ExitCode::UsageError;
        }
    };

    let (client, _caps) = match setup_client(&alias_name, &bucket, args.force, &formatter).await {
        Ok(c) => c,
        Err(code) => return code,
    };

    let path = rc_core::RemotePath::new(&alias_name, &bucket, prefix.as_deref().unwrap_or(""));

    match client.list_object_versions(&path, Some(args.max)).await {
        Ok(versions) => {
            if formatter.is_json() {
                let output: Vec<VersionInfo> = versions
                    .into_iter()
                    .map(|v| VersionInfo {
                        key: v.key,
                        version_id: v.version_id,
                        is_latest: v.is_latest,
                        is_delete_marker: v.is_delete_marker,
                        last_modified: v.last_modified.map(|t| t.to_string()),
                        size_bytes: v.size_bytes,
                        size_human: v
                            .size_bytes
                            .map(|s| humansize::format_size(s as u64, humansize::BINARY)),
                    })
                    .collect();
                formatter.json(&output);
            } else if versions.is_empty() {
                formatter.println("No versions found.");
            } else {
                for v in &versions {
                    let marker = if v.is_delete_marker { "[DELETE]" } else { "" };
                    let latest = if v.is_latest { "*" } else { " " };
                    let size = v
                        .size_bytes
                        .map(|s| humansize::format_size(s as u64, humansize::BINARY))
                        .unwrap_or_default();

                    formatter.println(&format!(
                        "{latest} {:<40} {:>10} {:>12} {marker}",
                        v.key,
                        v.version_id.chars().take(10).collect::<String>(),
                        size
                    ));
                }
                formatter.println(&format!("\nTotal: {} version(s)", versions.len()));
            }
            ExitCode::Success
        }
        Err(e) => {
            formatter.error(&format!("Failed to list versions: {e}"));
            ExitCode::GeneralError
        }
    }
}

async fn setup_client(
    alias_name: &str,
    bucket: &str,
    force: bool,
    formatter: &Formatter,
) -> Result<(S3Client, rc_core::Capabilities), ExitCode> {
    let alias_manager = match AliasManager::new() {
        Ok(am) => am,
        Err(e) => {
            formatter.error(&format!("Failed to load aliases: {e}"));
            return Err(ExitCode::GeneralError);
        }
    };

    let alias = match alias_manager.get(alias_name) {
        Ok(a) => a,
        Err(_) => {
            formatter.error(&format!("Alias '{alias_name}' not found"));
            return Err(ExitCode::NotFound);
        }
    };

    let client = match S3Client::new(alias).await {
        Ok(c) => c,
        Err(e) => {
            formatter.error(&format!("Failed to create S3 client: {e}"));
            return Err(ExitCode::NetworkError);
        }
    };

    // Check capabilities
    let caps = match client.capabilities().await {
        Ok(c) => c,
        Err(e) => {
            if force {
                rc_core::Capabilities::default()
            } else {
                formatter.error(&format!("Failed to detect capabilities: {e}"));
                return Err(ExitCode::NetworkError);
            }
        }
    };

    if !force && !caps.versioning {
        formatter.error("Backend does not support versioning. Use --force to attempt anyway.");
        return Err(ExitCode::UnsupportedFeature);
    }

    // Check if bucket exists
    match client.bucket_exists(bucket).await {
        Ok(true) => {}
        Ok(false) => {
            formatter.error(&format!("Bucket '{bucket}' does not exist"));
            return Err(ExitCode::NotFound);
        }
        Err(e) => {
            formatter.error(&format!("Failed to check bucket: {e}"));
            return Err(ExitCode::NetworkError);
        }
    }

    Ok((client, caps))
}

fn parse_bucket_path(path: &str) -> Result<(String, String), String> {
    if path.is_empty() {
        return Err("Path cannot be empty".to_string());
    }

    let parts: Vec<&str> = path.splitn(2, '/').collect();

    if parts.len() < 2 || parts[1].is_empty() {
        return Err("Bucket name is required (alias/bucket)".to_string());
    }

    // Remove trailing slash from bucket name
    let bucket = parts[1].trim_end_matches('/');

    Ok((parts[0].to_string(), bucket.to_string()))
}

fn parse_version_path(path: &str) -> Result<(String, String, Option<String>), String> {
    if path.is_empty() {
        return Err("Path cannot be empty".to_string());
    }

    let parts: Vec<&str> = path.splitn(3, '/').collect();

    match parts.len() {
        1 => Err("Bucket name is required".to_string()),
        2 => Ok((parts[0].to_string(), parts[1].to_string(), None)),
        3 => Ok((
            parts[0].to_string(),
            parts[1].to_string(),
            Some(parts[2].to_string()),
        )),
        _ => Err(format!("Invalid path format: '{path}'")),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_bucket_path() {
        let (alias, bucket) = parse_bucket_path("myalias/mybucket").unwrap();
        assert_eq!(alias, "myalias");
        assert_eq!(bucket, "mybucket");

        let (alias, bucket) = parse_bucket_path("myalias/mybucket/").unwrap();
        assert_eq!(alias, "myalias");
        assert_eq!(bucket, "mybucket");
    }

    #[test]
    fn test_parse_bucket_path_errors() {
        assert!(parse_bucket_path("").is_err());
        assert!(parse_bucket_path("myalias").is_err());
        assert!(parse_bucket_path("myalias/").is_err());
    }

    #[test]
    fn test_parse_version_path() {
        let (alias, bucket, prefix) = parse_version_path("myalias/mybucket").unwrap();
        assert_eq!(alias, "myalias");
        assert_eq!(bucket, "mybucket");
        assert!(prefix.is_none());

        let (alias, bucket, prefix) = parse_version_path("myalias/mybucket/path/to").unwrap();
        assert_eq!(alias, "myalias");
        assert_eq!(bucket, "mybucket");
        assert_eq!(prefix, Some("path/to".to_string()));
    }
}