rc-core 0.1.12

Core library for rustfs-cli S3 CLI 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
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
//! Tier configuration types for remote storage tiering
//!
//! These types match the RustFS admin API JSON format for tier management.
//! Tiers are used by lifecycle transition rules to move objects to
//! remote storage backends.

use serde::{Deserialize, Serialize};
use std::fmt;

/// Supported remote storage tier types
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum TierType {
    #[serde(rename = "s3")]
    S3,
    #[serde(rename = "rustfs")]
    RustFS,
    #[serde(rename = "minio")]
    MinIO,
    #[serde(rename = "aliyun")]
    Aliyun,
    #[serde(rename = "tencent")]
    Tencent,
    #[serde(rename = "huaweicloud")]
    Huaweicloud,
    #[serde(rename = "azure")]
    Azure,
    #[serde(rename = "gcs")]
    GCS,
    #[serde(rename = "r2")]
    R2,
}

impl fmt::Display for TierType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            TierType::S3 => write!(f, "S3"),
            TierType::RustFS => write!(f, "RustFS"),
            TierType::MinIO => write!(f, "MinIO"),
            TierType::Aliyun => write!(f, "Aliyun"),
            TierType::Tencent => write!(f, "Tencent"),
            TierType::Huaweicloud => write!(f, "Huaweicloud"),
            TierType::Azure => write!(f, "Azure"),
            TierType::GCS => write!(f, "GCS"),
            TierType::R2 => write!(f, "R2"),
        }
    }
}

impl std::str::FromStr for TierType {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "s3" => Ok(TierType::S3),
            "rustfs" => Ok(TierType::RustFS),
            "minio" => Ok(TierType::MinIO),
            "aliyun" => Ok(TierType::Aliyun),
            "tencent" => Ok(TierType::Tencent),
            "huaweicloud" => Ok(TierType::Huaweicloud),
            "azure" => Ok(TierType::Azure),
            "gcs" => Ok(TierType::GCS),
            "r2" => Ok(TierType::R2),
            _ => Err(format!(
                "Invalid tier type: {s}. Valid types: s3, rustfs, minio, aliyun, tencent, huaweicloud, azure, gcs, r2"
            )),
        }
    }
}

/// Tier configuration matching the RustFS admin API format.
///
/// The backend uses a polymorphic structure: the `type` field selects which
/// sub-config (s3, rustfs, minio, etc.) is active. The tier name lives
/// inside the sub-config.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct TierConfig {
    #[serde(rename = "type")]
    pub tier_type: TierType,

    /// Tier name — extracted from the active sub-config on the backend side.
    /// Populated by the CLI when building a TierConfig for add operations.
    #[serde(skip)]
    pub name: String,

    #[serde(rename = "s3", skip_serializing_if = "Option::is_none")]
    pub s3: Option<TierS3>,
    #[serde(rename = "rustfs", skip_serializing_if = "Option::is_none")]
    pub rustfs: Option<TierRustFS>,
    #[serde(rename = "minio", skip_serializing_if = "Option::is_none")]
    pub minio: Option<TierMinIO>,
    #[serde(rename = "aliyun", skip_serializing_if = "Option::is_none")]
    pub aliyun: Option<TierAliyun>,
    #[serde(rename = "tencent", skip_serializing_if = "Option::is_none")]
    pub tencent: Option<TierTencent>,
    #[serde(rename = "huaweicloud", skip_serializing_if = "Option::is_none")]
    pub huaweicloud: Option<TierHuaweicloud>,
    #[serde(rename = "azure", skip_serializing_if = "Option::is_none")]
    pub azure: Option<TierAzure>,
    #[serde(rename = "gcs", skip_serializing_if = "Option::is_none")]
    pub gcs: Option<TierGCS>,
    #[serde(rename = "r2", skip_serializing_if = "Option::is_none")]
    pub r2: Option<TierR2>,
}

impl Default for TierConfig {
    fn default() -> Self {
        Self {
            tier_type: TierType::S3,
            name: String::new(),
            s3: None,
            rustfs: None,
            minio: None,
            aliyun: None,
            tencent: None,
            huaweicloud: None,
            azure: None,
            gcs: None,
            r2: None,
        }
    }
}

impl TierConfig {
    /// Get the tier name from the active sub-config
    pub fn tier_name(&self) -> &str {
        if !self.name.is_empty() {
            return &self.name;
        }
        match self.tier_type {
            TierType::S3 => self.s3.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
            TierType::RustFS => self.rustfs.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
            TierType::MinIO => self.minio.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
            TierType::Aliyun => self.aliyun.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
            TierType::Tencent => self.tencent.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
            TierType::Huaweicloud => self
                .huaweicloud
                .as_ref()
                .map(|c| c.name.as_str())
                .unwrap_or(""),
            TierType::Azure => self.azure.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
            TierType::GCS => self.gcs.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
            TierType::R2 => self.r2.as_ref().map(|c| c.name.as_str()).unwrap_or(""),
        }
    }

    /// Get the endpoint from the active sub-config
    pub fn endpoint(&self) -> &str {
        match self.tier_type {
            TierType::S3 => self.s3.as_ref().map(|c| c.endpoint.as_str()).unwrap_or(""),
            TierType::RustFS => self
                .rustfs
                .as_ref()
                .map(|c| c.endpoint.as_str())
                .unwrap_or(""),
            TierType::MinIO => self
                .minio
                .as_ref()
                .map(|c| c.endpoint.as_str())
                .unwrap_or(""),
            TierType::Aliyun => self
                .aliyun
                .as_ref()
                .map(|c| c.endpoint.as_str())
                .unwrap_or(""),
            TierType::Tencent => self
                .tencent
                .as_ref()
                .map(|c| c.endpoint.as_str())
                .unwrap_or(""),
            TierType::Huaweicloud => self
                .huaweicloud
                .as_ref()
                .map(|c| c.endpoint.as_str())
                .unwrap_or(""),
            TierType::Azure => self
                .azure
                .as_ref()
                .map(|c| c.endpoint.as_str())
                .unwrap_or(""),
            TierType::GCS => self.gcs.as_ref().map(|c| c.endpoint.as_str()).unwrap_or(""),
            TierType::R2 => self.r2.as_ref().map(|c| c.endpoint.as_str()).unwrap_or(""),
        }
    }

    /// Get the bucket from the active sub-config
    pub fn bucket(&self) -> &str {
        match self.tier_type {
            TierType::S3 => self.s3.as_ref().map(|c| c.bucket.as_str()).unwrap_or(""),
            TierType::RustFS => self
                .rustfs
                .as_ref()
                .map(|c| c.bucket.as_str())
                .unwrap_or(""),
            TierType::MinIO => self.minio.as_ref().map(|c| c.bucket.as_str()).unwrap_or(""),
            TierType::Aliyun => self
                .aliyun
                .as_ref()
                .map(|c| c.bucket.as_str())
                .unwrap_or(""),
            TierType::Tencent => self
                .tencent
                .as_ref()
                .map(|c| c.bucket.as_str())
                .unwrap_or(""),
            TierType::Huaweicloud => self
                .huaweicloud
                .as_ref()
                .map(|c| c.bucket.as_str())
                .unwrap_or(""),
            TierType::Azure => self.azure.as_ref().map(|c| c.bucket.as_str()).unwrap_or(""),
            TierType::GCS => self.gcs.as_ref().map(|c| c.bucket.as_str()).unwrap_or(""),
            TierType::R2 => self.r2.as_ref().map(|c| c.bucket.as_str()).unwrap_or(""),
        }
    }

    /// Get the prefix from the active sub-config
    pub fn prefix(&self) -> &str {
        match self.tier_type {
            TierType::S3 => self.s3.as_ref().map(|c| c.prefix.as_str()).unwrap_or(""),
            TierType::RustFS => self
                .rustfs
                .as_ref()
                .map(|c| c.prefix.as_str())
                .unwrap_or(""),
            TierType::MinIO => self.minio.as_ref().map(|c| c.prefix.as_str()).unwrap_or(""),
            TierType::Aliyun => self
                .aliyun
                .as_ref()
                .map(|c| c.prefix.as_str())
                .unwrap_or(""),
            TierType::Tencent => self
                .tencent
                .as_ref()
                .map(|c| c.prefix.as_str())
                .unwrap_or(""),
            TierType::Huaweicloud => self
                .huaweicloud
                .as_ref()
                .map(|c| c.prefix.as_str())
                .unwrap_or(""),
            TierType::Azure => self.azure.as_ref().map(|c| c.prefix.as_str()).unwrap_or(""),
            TierType::GCS => self.gcs.as_ref().map(|c| c.prefix.as_str()).unwrap_or(""),
            TierType::R2 => self.r2.as_ref().map(|c| c.prefix.as_str()).unwrap_or(""),
        }
    }

    /// Get the region from the active sub-config
    pub fn region(&self) -> &str {
        match self.tier_type {
            TierType::S3 => self.s3.as_ref().map(|c| c.region.as_str()).unwrap_or(""),
            TierType::RustFS => self
                .rustfs
                .as_ref()
                .map(|c| c.region.as_str())
                .unwrap_or(""),
            TierType::MinIO => self.minio.as_ref().map(|c| c.region.as_str()).unwrap_or(""),
            TierType::Aliyun => self
                .aliyun
                .as_ref()
                .map(|c| c.region.as_str())
                .unwrap_or(""),
            TierType::Tencent => self
                .tencent
                .as_ref()
                .map(|c| c.region.as_str())
                .unwrap_or(""),
            TierType::Huaweicloud => self
                .huaweicloud
                .as_ref()
                .map(|c| c.region.as_str())
                .unwrap_or(""),
            TierType::Azure => self.azure.as_ref().map(|c| c.region.as_str()).unwrap_or(""),
            TierType::GCS => self.gcs.as_ref().map(|c| c.region.as_str()).unwrap_or(""),
            TierType::R2 => self.r2.as_ref().map(|c| c.region.as_str()).unwrap_or(""),
        }
    }
}

/// Credentials for updating a tier
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct TierCreds {
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
}

// ==================== Per-type sub-configs ====================
// These match the RustFS backend JSON format exactly.

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierS3 {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
    #[serde(rename = "storageClass")]
    pub storage_class: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierRustFS {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
    #[serde(rename = "storageClass")]
    pub storage_class: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierMinIO {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierAliyun {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierTencent {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierHuaweicloud {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierAzure {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
    #[serde(rename = "storageClass")]
    pub storage_class: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierGCS {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "creds")]
    pub creds: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
    #[serde(rename = "storageClass")]
    pub storage_class: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct TierR2 {
    pub name: String,
    pub endpoint: String,
    #[serde(rename = "accessKey")]
    pub access_key: String,
    #[serde(rename = "secretKey")]
    pub secret_key: String,
    pub bucket: String,
    pub prefix: String,
    pub region: String,
}

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

    #[test]
    fn test_tier_type_display() {
        assert_eq!(TierType::S3.to_string(), "S3");
        assert_eq!(TierType::RustFS.to_string(), "RustFS");
        assert_eq!(TierType::MinIO.to_string(), "MinIO");
        assert_eq!(TierType::Azure.to_string(), "Azure");
        assert_eq!(TierType::GCS.to_string(), "GCS");
        assert_eq!(TierType::R2.to_string(), "R2");
    }

    #[test]
    fn test_tier_type_from_str() {
        assert_eq!("s3".parse::<TierType>().unwrap(), TierType::S3);
        assert_eq!("rustfs".parse::<TierType>().unwrap(), TierType::RustFS);
        assert_eq!("MINIO".parse::<TierType>().unwrap(), TierType::MinIO);
        assert_eq!("Azure".parse::<TierType>().unwrap(), TierType::Azure);
        assert!("invalid".parse::<TierType>().is_err());
    }

    #[test]
    fn test_tier_config_serialization_s3() {
        let config = TierConfig {
            tier_type: TierType::S3,
            name: "WARM".to_string(),
            s3: Some(TierS3 {
                name: "WARM".to_string(),
                endpoint: "https://s3.amazonaws.com".to_string(),
                access_key: "AKID".to_string(),
                secret_key: "REDACTED".to_string(),
                bucket: "warm-bucket".to_string(),
                prefix: "tier/".to_string(),
                region: "us-east-1".to_string(),
                storage_class: "STANDARD_IA".to_string(),
            }),
            ..Default::default()
        };

        let json = serde_json::to_string(&config).unwrap();
        assert!(json.contains(r#""type":"s3""#));
        assert!(json.contains("warm-bucket"));

        let decoded: TierConfig = serde_json::from_str(&json).unwrap();
        assert_eq!(decoded.tier_type, TierType::S3);
        assert_eq!(decoded.tier_name(), "WARM");
        assert_eq!(decoded.bucket(), "warm-bucket");
    }

    #[test]
    fn test_tier_config_deserialization_from_backend() {
        // Simulates the JSON format returned by the RustFS admin API
        let json = r#"{"type":"rustfs","rustfs":{"name":"ARCHIVE","endpoint":"http://remote:9000","accessKey":"admin","secretKey":"REDACTED","bucket":"archive","prefix":"","region":""}}"#;
        let config: TierConfig = serde_json::from_str(json).unwrap();
        assert_eq!(config.tier_type, TierType::RustFS);
        assert_eq!(config.tier_name(), "ARCHIVE");
        assert_eq!(config.endpoint(), "http://remote:9000");
        assert_eq!(config.bucket(), "archive");
    }

    #[test]
    fn test_tier_creds_serialization() {
        let creds = TierCreds {
            access_key: "newkey".to_string(),
            secret_key: "newsecret".to_string(),
        };

        let json = serde_json::to_string(&creds).unwrap();
        assert!(json.contains("accessKey"));
        assert!(json.contains("secretKey"));

        let decoded: TierCreds = serde_json::from_str(&json).unwrap();
        assert_eq!(decoded.access_key, "newkey");
    }
}