rustfs-cli 0.1.13

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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
//! event command - Manage bucket notification configuration
//!
//! Add, list, or remove bucket event notification rules.

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

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

const EVENT_AFTER_HELP: &str = "\
Examples:
  rc bucket event list local/my-bucket
  rc bucket event add local/my-bucket arn:aws:sqs:us-east-1:123456789012:jobs --event put
  rc event remove local/my-bucket arn:aws:sns:us-east-1:123456789012:alerts";

const EVENT_ADD_AFTER_HELP: &str = "\
Examples:
  rc bucket event add local/my-bucket arn:aws:sqs:us-east-1:123456789012:jobs --event put
  rc event add local/my-bucket arn:aws:sns:us-east-1:123456789012:alerts --event delete
  rc bucket event add local/my-bucket arn:aws:lambda:us-east-1:123456789012:function:thumbnail --event put,delete";

const EVENT_REMOVE_AFTER_HELP: &str = "\
Examples:
  rc bucket event remove local/my-bucket arn:aws:sqs:us-east-1:123456789012:jobs
  rc event remove local/my-bucket arn:aws:sns:us-east-1:123456789012:alerts";

/// Manage bucket event notifications
#[derive(Args, Debug)]
#[command(after_help = EVENT_AFTER_HELP)]
pub struct EventArgs {
    #[command(subcommand)]
    pub command: EventCommands,
}

#[derive(Subcommand, Debug)]
pub enum EventCommands {
    /// Add or replace a bucket notification rule for an ARN
    Add(AddArgs),

    /// List bucket notification rules
    List(BucketArg),

    /// Remove bucket notification rules by target ARN
    Remove(RemoveArgs),
}

#[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)]
#[command(after_help = EVENT_ADD_AFTER_HELP)]
pub struct AddArgs {
    /// Path to the bucket (alias/bucket)
    pub path: String,

    /// Target ARN (SQS/SNS/Lambda)
    pub arn: String,

    /// Event pattern (repeatable; comma-separated values are also accepted)
    #[arg(long = "event", value_name = "EVENT", num_args = 1..)]
    pub events: Vec<String>,

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

#[derive(Args, Debug)]
#[command(after_help = EVENT_REMOVE_AFTER_HELP)]
pub struct RemoveArgs {
    /// Path to the bucket (alias/bucket)
    pub path: String,

    /// Target ARN to remove
    pub arn: String,

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

#[derive(Debug, Serialize)]
struct NotificationListOutput {
    bucket: String,
    notifications: Vec<BucketNotification>,
}

#[derive(Debug, Serialize)]
struct NotificationOperationOutput {
    bucket: String,
    arn: String,
    events: Vec<String>,
    action: String,
}

/// Execute the event command
pub async fn execute(args: EventArgs, output_config: OutputConfig) -> ExitCode {
    match args.command {
        EventCommands::Add(args) => execute_add(args, output_config).await,
        EventCommands::List(args) => execute_list(args, output_config).await,
        EventCommands::Remove(args) => execute_remove(args, output_config).await,
    }
}

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

    let (alias_name, bucket) = match parse_bucket_path(&args.path) {
        Ok(parts) => parts,
        Err(error) => {
            return formatter.fail_with_suggestion(
                ExitCode::UsageError,
                &error,
                "Use a bucket path in the form alias/bucket before retrying the event command.",
            );
        }
    };

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

    match client.get_bucket_notifications(&bucket).await {
        Ok(notifications) => {
            if formatter.is_json() {
                formatter.json(&NotificationListOutput {
                    bucket,
                    notifications,
                });
            } else if notifications.is_empty() {
                formatter.println("No notification rules found.");
            } else {
                formatter.println("Bucket notification rules:");
                for item in notifications {
                    let events = item.events.join(", ");
                    formatter.println(&format!(
                        "  [{}] {} -> {}",
                        item.target_string(),
                        item.arn,
                        events
                    ));
                }
            }
            ExitCode::Success
        }
        Err(error) => formatter.fail(
            ExitCode::GeneralError,
            &format!("Failed to list notifications: {error}"),
        ),
    }
}

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

    let (alias_name, bucket) = match parse_bucket_path(&args.path) {
        Ok(parts) => parts,
        Err(error) => {
            return formatter.fail_with_suggestion(
                ExitCode::UsageError,
                &error,
                "Use a bucket path in the form alias/bucket before retrying the event command.",
            );
        }
    };

    let target = match infer_target_from_arn(&args.arn) {
        Ok(target) => target,
        Err(error) => {
            return formatter.fail_with_suggestion(
                ExitCode::UsageError,
                &error,
                "Use an SQS, SNS, or Lambda ARN when adding a bucket notification target.",
            );
        }
    };

    let events = parse_event_list(&args.events);

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

    let mut notifications = match client.get_bucket_notifications(&bucket).await {
        Ok(items) => items,
        Err(error) => {
            return formatter.fail(
                ExitCode::GeneralError,
                &format!("Failed to read current notifications: {error}"),
            );
        }
    };

    upsert_notification(
        &mut notifications,
        BucketNotification {
            id: None,
            target,
            arn: args.arn.clone(),
            events: events.clone(),
            prefix: None,
            suffix: None,
        },
    );

    match client
        .set_bucket_notifications(&bucket, notifications)
        .await
    {
        Ok(()) => {
            if formatter.is_json() {
                formatter.json(&NotificationOperationOutput {
                    bucket,
                    arn: args.arn,
                    events,
                    action: "added".to_string(),
                });
            } else {
                formatter.success("Notification rule added successfully.");
            }
            ExitCode::Success
        }
        Err(error) => formatter.fail(
            ExitCode::GeneralError,
            &format!("Failed to set notification: {error}"),
        ),
    }
}

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

    let (alias_name, bucket) = match parse_bucket_path(&args.path) {
        Ok(parts) => parts,
        Err(error) => {
            return formatter.fail_with_suggestion(
                ExitCode::UsageError,
                &error,
                "Use a bucket path in the form alias/bucket before retrying the event command.",
            );
        }
    };

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

    let mut notifications = match client.get_bucket_notifications(&bucket).await {
        Ok(items) => items,
        Err(error) => {
            return formatter.fail(
                ExitCode::GeneralError,
                &format!("Failed to read current notifications: {error}"),
            );
        }
    };

    let removed = remove_notifications_by_arn(&mut notifications, &args.arn);
    if removed == 0 {
        return formatter.fail_with_suggestion(
            ExitCode::NotFound,
            &format!("Notification target '{}' not found", args.arn),
            "Run `rc bucket event list <alias/bucket>` to inspect the configured notification targets.",
        );
    }

    match client
        .set_bucket_notifications(&bucket, notifications)
        .await
    {
        Ok(()) => {
            if formatter.is_json() {
                formatter.json(&NotificationOperationOutput {
                    bucket,
                    arn: args.arn,
                    events: Vec::new(),
                    action: "removed".to_string(),
                });
            } else {
                formatter.success("Notification rule removed successfully.");
            }
            ExitCode::Success
        }
        Err(error) => formatter.fail(
            ExitCode::GeneralError,
            &format!("Failed to update notifications: {error}"),
        ),
    }
}

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

    let alias = match alias_manager.get(alias_name) {
        Ok(alias) => alias,
        Err(_) => {
            return Err(formatter.fail_with_suggestion(
                ExitCode::NotFound,
                &format!("Alias '{alias_name}' not found"),
                "Run `rc alias list` to inspect configured aliases or add one with `rc alias set ...`.",
            ));
        }
    };

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

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

    if !force && !caps.notifications {
        return Err(formatter.fail_with_suggestion(
            ExitCode::UnsupportedFeature,
            "Backend does not support notifications. Use --force to attempt anyway.",
            "Retry with --force only if you know the backend supports bucket notifications.",
        ));
    }

    match client.bucket_exists(bucket).await {
        Ok(true) => {}
        Ok(false) => {
            return Err(formatter.fail_with_suggestion(
                ExitCode::NotFound,
                &format!("Bucket '{bucket}' does not exist"),
                "Check the bucket path and retry the event command.",
            ));
        }
        Err(error) => {
            return Err(formatter.fail(
                ExitCode::NetworkError,
                &format!("Failed to check bucket: {error}"),
            ));
        }
    }

    Ok(client)
}

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[0].is_empty() || parts[1].is_empty() {
        return Err("Bucket path must be in format alias/bucket".to_string());
    }

    let bucket = parts[1].trim_end_matches('/');
    if bucket.is_empty() || bucket.contains('/') {
        return Err("Bucket path must be in format alias/bucket".to_string());
    }

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

fn parse_event_list(values: &[String]) -> Vec<String> {
    let mut events: Vec<String> = values
        .iter()
        .flat_map(|value| value.split(','))
        .map(str::trim)
        .filter(|value| !value.is_empty())
        .map(normalize_event_name)
        .collect();

    if events.is_empty() {
        events.push("s3:ObjectCreated:*".to_string());
    }

    events.sort();
    events.dedup();
    events
}

fn normalize_event_name(value: &str) -> String {
    match value.to_ascii_lowercase().as_str() {
        "put" | "s3:objectcreated:*" => "s3:ObjectCreated:*".to_string(),
        "get" | "s3:objectaccessed:*" => "s3:ObjectAccessed:*".to_string(),
        "delete" | "s3:objectremoved:*" => "s3:ObjectRemoved:*".to_string(),
        "replica" | "s3:replication:*" => "s3:Replication:*".to_string(),
        "ilm" | "s3:objecttransition:*" => "s3:ObjectTransition:*".to_string(),
        _ => value.to_string(),
    }
}

fn infer_target_from_arn(arn: &str) -> Result<NotificationTarget, String> {
    if arn.contains(":sqs:") {
        Ok(NotificationTarget::Queue)
    } else if arn.contains(":sns:") {
        Ok(NotificationTarget::Topic)
    } else if arn.contains(":lambda:") {
        Ok(NotificationTarget::Lambda)
    } else {
        Err(format!(
            "Unsupported ARN '{}'. Expected SQS/SNS/Lambda ARN",
            arn
        ))
    }
}

fn upsert_notification(notifications: &mut Vec<BucketNotification>, new_rule: BucketNotification) {
    notifications.retain(|item| item.arn != new_rule.arn);
    notifications.push(new_rule);
}

fn remove_notifications_by_arn(notifications: &mut Vec<BucketNotification>, arn: &str) -> usize {
    let before = notifications.len();
    notifications.retain(|item| item.arn != arn);
    before.saturating_sub(notifications.len())
}

trait NotificationTargetDisplay {
    fn target_string(&self) -> &'static str;
}

impl NotificationTargetDisplay for BucketNotification {
    fn target_string(&self) -> &'static str {
        match self.target {
            NotificationTarget::Queue => "queue",
            NotificationTarget::Topic => "topic",
            NotificationTarget::Lambda => "lambda",
        }
    }
}

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

    #[test]
    fn test_parse_bucket_path_success() {
        let (alias, bucket) = parse_bucket_path("local/my-bucket").expect("should parse");
        assert_eq!(alias, "local");
        assert_eq!(bucket, "my-bucket");

        let (alias, bucket) = parse_bucket_path("local/my-bucket/").expect("should parse");
        assert_eq!(alias, "local");
        assert_eq!(bucket, "my-bucket");
    }

    #[test]
    fn test_parse_bucket_path_error() {
        assert!(parse_bucket_path("").is_err());
        assert!(parse_bucket_path("local").is_err());
        assert!(parse_bucket_path("/bucket").is_err());
        assert!(parse_bucket_path("local/my-bucket/prefix").is_err());
        assert!(parse_bucket_path("local///").is_err());
    }

    #[test]
    fn test_parse_event_list_defaults_and_deduplicates() {
        assert_eq!(
            parse_event_list(&[]),
            vec!["s3:ObjectCreated:*".to_string()]
        );

        let events = parse_event_list(&[
            "s3:ObjectCreated:Put,s3:ObjectRemoved:*".to_string(),
            "s3:ObjectCreated:Put".to_string(),
        ]);

        assert_eq!(
            events,
            vec![
                "s3:ObjectCreated:Put".to_string(),
                "s3:ObjectRemoved:*".to_string()
            ]
        );
    }

    #[test]
    fn test_parse_event_list_normalizes_shorthand_names() {
        let events = parse_event_list(&[
            "put,get,delete".to_string(),
            "replica".to_string(),
            "ilm,s3:ObjectCreated:Post".to_string(),
            "PUT".to_string(),
        ]);

        assert_eq!(
            events,
            vec![
                "s3:ObjectAccessed:*".to_string(),
                "s3:ObjectCreated:*".to_string(),
                "s3:ObjectCreated:Post".to_string(),
                "s3:ObjectRemoved:*".to_string(),
                "s3:ObjectTransition:*".to_string(),
                "s3:Replication:*".to_string(),
            ]
        );
    }

    #[test]
    fn test_parse_event_list_defaults_when_inputs_are_blank() {
        let events = parse_event_list(&[" , ,  ".to_string(), "".to_string()]);

        assert_eq!(events, vec!["s3:ObjectCreated:*".to_string()]);
    }

    #[test]
    fn test_upsert_notification_replaces_existing_rule_for_same_arn() {
        let mut rules = vec![BucketNotification {
            id: None,
            target: NotificationTarget::Queue,
            arn: "arn:aws:sqs:us-east-1:123456789012:q1".to_string(),
            events: vec!["s3:ObjectRemoved:*".to_string()],
            prefix: None,
            suffix: None,
        }];

        let normalized_events =
            parse_event_list(&["put,s3:ObjectCreated:*".to_string(), "PUT".to_string()]);

        upsert_notification(
            &mut rules,
            BucketNotification {
                id: None,
                target: NotificationTarget::Queue,
                arn: "arn:aws:sqs:us-east-1:123456789012:q1".to_string(),
                events: normalized_events,
                prefix: None,
                suffix: None,
            },
        );

        assert_eq!(rules.len(), 1);
        assert_eq!(rules[0].events, vec!["s3:ObjectCreated:*".to_string()]);
    }

    #[test]
    fn test_parse_event_list_deduplicates_shorthand_and_canonical_names() {
        let events = parse_event_list(&[
            "put,s3:ObjectCreated:*".to_string(),
            "GET,s3:ObjectAccessed:*".to_string(),
            "delete,s3:ObjectRemoved:*".to_string(),
        ]);

        assert_eq!(
            events,
            vec![
                "s3:ObjectAccessed:*".to_string(),
                "s3:ObjectCreated:*".to_string(),
                "s3:ObjectRemoved:*".to_string(),
            ]
        );
    }

    #[test]
    fn test_parse_event_list_deduplicates_mixed_case_canonical_names() {
        let events = parse_event_list(&[
            "PUT,S3:objectcreated:*".to_string(),
            "delete,S3:OBJECTREMOVED:*".to_string(),
        ]);

        assert_eq!(
            events,
            vec![
                "s3:ObjectCreated:*".to_string(),
                "s3:ObjectRemoved:*".to_string(),
            ]
        );
    }

    #[test]
    fn test_normalize_event_name_preserves_non_shorthand_values() {
        assert_eq!(
            normalize_event_name("s3:ObjectCreated:Post"),
            "s3:ObjectCreated:Post"
        );
        assert_eq!(normalize_event_name("custom:event"), "custom:event");
    }

    #[test]
    fn test_infer_target_from_arn() {
        assert_eq!(
            infer_target_from_arn("arn:aws:sqs:us-east-1:123456789012:queue").expect("queue"),
            NotificationTarget::Queue
        );
        assert_eq!(
            infer_target_from_arn("arn:aws:sns:us-east-1:123456789012:topic").expect("topic"),
            NotificationTarget::Topic
        );
        assert_eq!(
            infer_target_from_arn("arn:aws:lambda:us-east-1:123456789012:function:fn")
                .expect("lambda"),
            NotificationTarget::Lambda
        );
        assert!(infer_target_from_arn("arn:aws:iam::123456789012:role/demo").is_err());
    }

    #[test]
    fn test_upsert_and_remove_notification() {
        let mut rules = vec![BucketNotification {
            id: None,
            target: NotificationTarget::Queue,
            arn: "arn:aws:sqs:us-east-1:123456789012:q1".to_string(),
            events: vec!["s3:ObjectCreated:*".to_string()],
            prefix: None,
            suffix: None,
        }];

        upsert_notification(
            &mut rules,
            BucketNotification {
                id: None,
                target: NotificationTarget::Topic,
                arn: "arn:aws:sns:us-east-1:123456789012:t1".to_string(),
                events: vec!["s3:ObjectRemoved:*".to_string()],
                prefix: None,
                suffix: None,
            },
        );
        assert_eq!(rules.len(), 2);

        let removed =
            remove_notifications_by_arn(&mut rules, "arn:aws:sns:us-east-1:123456789012:t1");
        assert_eq!(removed, 1);
        assert_eq!(rules.len(), 1);
    }
}