reduct-rs 1.20.0

ReductStore Client SDK for Rust.
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
use super::{ReductClient, Result};
use crate::http_client::HttpClient;
use reduct_base::msg::lifecycle_api::{
    FullLifecycleInfo, LifecycleInfo, LifecycleList, LifecycleMode, LifecycleModePayload,
    LifecycleSettings, LifecycleType,
};
use reqwest::Method;
use serde_json::Value;
use std::sync::Arc;

/// Lifecycle builder.
pub struct LifecycleBuilder {
    name: String,
    settings: LifecycleSettings,
    http_client: Arc<HttpClient>,
}

impl LifecycleBuilder {
    /// Create a new lifecycle builder.
    pub(super) fn new(name: String, http_client: Arc<HttpClient>) -> Self {
        Self {
            name,
            settings: LifecycleSettings::default(),
            http_client,
        }
    }

    /// Set lifecycle policy type.
    ///
    /// # Arguments
    ///
    /// * `lifecycle_type` - Lifecycle type.
    pub fn lifecycle_type(mut self, lifecycle_type: LifecycleType) -> Self {
        self.settings.lifecycle_type = lifecycle_type;
        self
    }

    /// Set the bucket.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Bucket name.
    pub fn bucket(mut self, bucket: &str) -> Self {
        self.settings.bucket = bucket.to_string();
        self
    }

    /// Set the lifecycle entries.
    ///
    /// # Arguments
    /// * `entries` - Lifecycle entries. If empty, all removable entries are matched. Prefix wildcards are supported.
    pub fn entries(mut self, entries: Vec<String>) -> Self {
        self.settings.entries = entries;
        self
    }

    /// Set the record age threshold.
    ///
    /// # Arguments
    ///
    /// * `older_than` - Age threshold, e.g. "30d", "24h", or "3600s".
    pub fn older_than(mut self, older_than: &str) -> Self {
        self.settings.older_than = older_than.to_string();
        self
    }

    /// Set the interval between lifecycle runs.
    ///
    /// # Arguments
    ///
    /// * `interval` - Interval, e.g. "10m", "1h", or "3600s".
    pub fn interval(mut self, interval: &str) -> Self {
        self.settings.interval = interval.to_string();
        self
    }

    /// Set the lifecycle conditional query.
    ///
    /// # Arguments
    ///
    /// * `when` - Conditional query.
    pub fn when(mut self, when: Value) -> Self {
        self.settings.when = Some(when);
        self
    }

    /// Set lifecycle mode.
    ///
    /// * `mode` - Enabled, Disabled, or DryRun.
    pub fn mode(mut self, mode: LifecycleMode) -> Self {
        self.settings.mode = mode;
        self
    }

    /// Override all the lifecycle settings.
    ///
    /// # Arguments
    ///
    /// * `settings` - Lifecycle settings.
    pub fn set_settings(mut self, settings: LifecycleSettings) -> Self {
        self.settings = settings;
        self
    }

    /// Send request to create a new lifecycle policy.
    pub async fn send(self) -> Result<()> {
        self.http_client
            .send_json(
                Method::POST,
                &format!("/lifecycles/{}", self.name),
                self.settings,
            )
            .await
    }
}

impl ReductClient {
    /// Get list of lifecycle policies
    ///
    /// # Returns
    ///
    /// The list of lifecycle policies or an error
    pub async fn list_lifecycles(&self) -> Result<Vec<LifecycleInfo>> {
        let list = self
            .http_client
            .send_and_receive_json::<(), LifecycleList>(Method::GET, "/lifecycles", None)
            .await?;
        Ok(list.lifecycles)
    }

    /// Get full lifecycle policy info
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the lifecycle policy
    ///
    /// # Returns
    ///
    /// The lifecycle policy info or an error
    pub async fn get_lifecycle(&self, name: &str) -> Result<FullLifecycleInfo> {
        let info = self
            .http_client
            .send_and_receive_json::<(), FullLifecycleInfo>(
                Method::GET,
                &format!("/lifecycles/{}", name),
                None,
            )
            .await?;
        Ok(info)
    }

    /// Create a lifecycle policy
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the lifecycle policy
    ///
    /// # Returns
    ///
    /// a lifecycle builder to set the lifecycle settings
    ///
    /// # Example
    ///
    /// ```no_run
    /// use reduct_rs::{condition, LifecycleMode, LifecycleType, ReductClient};
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let client = ReductClient::builder()
    ///         .url("http://127.0.0.1:8383")
    ///         .api_token("my-api-token")
    ///         .build();
    ///
    ///     client
    ///         .create_lifecycle("test-lifecycle")
    ///         .lifecycle_type(LifecycleType::Delete)
    ///         .bucket("test-bucket-1")
    ///         .entries(vec!["entry-*".to_string()])
    ///         .older_than("1h")
    ///         .interval("10m")
    ///         .when(condition!({"$eq": ["&label", 1]}))
    ///         .mode(LifecycleMode::DryRun)
    ///         .send()
    ///         .await
    ///         .unwrap();
    /// }
    /// ```
    pub fn create_lifecycle(&self, name: &str) -> LifecycleBuilder {
        LifecycleBuilder::new(name.to_string(), Arc::clone(&self.http_client))
    }

    /// Update a lifecycle policy
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the lifecycle policy
    /// * `settings` - The lifecycle policy settings
    ///
    /// # Returns
    ///
    /// Ok if the lifecycle policy was updated, otherwise an error
    pub async fn update_lifecycle(&self, name: &str, settings: LifecycleSettings) -> Result<()> {
        self.http_client
            .send_json(Method::PUT, &format!("/lifecycles/{}", name), settings)
            .await
    }

    /// Update lifecycle mode without changing other settings.
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the lifecycle policy
    /// * `mode` - New lifecycle mode
    pub async fn set_lifecycle_mode(&self, name: &str, mode: LifecycleMode) -> Result<()> {
        self.http_client
            .send_json(
                Method::PATCH,
                &format!("/lifecycles/{}/mode", name),
                LifecycleModePayload { mode },
            )
            .await
    }

    /// Delete a lifecycle policy
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the lifecycle policy
    ///
    /// # Returns
    ///
    /// Ok if the lifecycle policy was deleted, otherwise an error
    pub async fn delete_lifecycle(&self, name: &str) -> Result<()> {
        let request = self
            .http_client
            .request(Method::DELETE, &format!("/lifecycles/{}", name));
        self.http_client.send_request(request).await?;
        Ok(())
    }
}

#[cfg(all(test, feature = "test-api-120"))]
mod tests {
    use super::*;
    use crate::client::tests::client;
    use crate::condition;
    use rstest::{fixture, rstest};

    fn test_lifecycles(lifecycles: Vec<LifecycleInfo>) -> Vec<LifecycleInfo> {
        lifecycles
            .into_iter()
            .filter(|lifecycle| lifecycle.name.starts_with("test-lifecycle"))
            .collect()
    }

    #[rstest]
    #[tokio::test]
    async fn test_list_lifecycles(#[future] client: ReductClient) {
        let lifecycles = test_lifecycles(client.await.list_lifecycles().await.unwrap());
        assert!(lifecycles.is_empty());
    }

    #[rstest]
    #[tokio::test]
    async fn test_create_lifecycle(#[future] client: ReductClient, settings: LifecycleSettings) {
        let client = client.await;
        client
            .create_lifecycle("test-lifecycle")
            .lifecycle_type(LifecycleType::Compress)
            .bucket(settings.bucket.as_str())
            .entries(settings.entries.clone())
            .older_than(settings.older_than.as_str())
            .interval(settings.interval.as_str())
            .mode(settings.mode)
            .send()
            .await
            .unwrap();
        let lifecycles = test_lifecycles(client.list_lifecycles().await.unwrap());
        assert_eq!(lifecycles.len(), 1);
        assert_eq!(lifecycles[0].lifecycle_type, LifecycleType::Compress);
        assert_eq!(lifecycles[0].mode, settings.mode);
        assert!(lifecycles[0].last_run.is_none());
    }

    #[rstest]
    #[tokio::test]
    async fn test_get_lifecycle(#[future] client: ReductClient, settings: LifecycleSettings) {
        let client = client.await;
        client
            .create_lifecycle("test-lifecycle")
            .set_settings(settings.clone())
            .send()
            .await
            .unwrap();

        let lifecycle = client.get_lifecycle("test-lifecycle").await.unwrap();

        assert_eq!(lifecycle.info.name, "test-lifecycle");
        assert_eq!(lifecycle.info.lifecycle_type, settings.lifecycle_type);
        assert_eq!(lifecycle.info.mode, settings.mode);
        assert!(lifecycle.info.last_run.is_none());
        assert_eq!(lifecycle.settings, settings);
    }

    #[rstest]
    #[tokio::test]
    async fn test_update_lifecycle(
        #[future] client: ReductClient,
        mut settings: LifecycleSettings,
    ) {
        let client = client.await;
        client
            .create_lifecycle("test-lifecycle")
            .set_settings(settings.clone())
            .send()
            .await
            .unwrap();

        settings.older_than = "2h".to_string();
        settings.mode = LifecycleMode::Disabled;

        client
            .update_lifecycle("test-lifecycle", settings.clone())
            .await
            .unwrap();

        let lifecycle = client.get_lifecycle("test-lifecycle").await.unwrap();
        assert_eq!(lifecycle.settings, settings);
    }

    #[rstest]
    #[tokio::test]
    async fn test_set_lifecycle_mode(#[future] client: ReductClient, settings: LifecycleSettings) {
        let client = client.await;
        client
            .create_lifecycle("test-lifecycle")
            .set_settings(settings)
            .send()
            .await
            .unwrap();

        client
            .set_lifecycle_mode("test-lifecycle", LifecycleMode::Disabled)
            .await
            .unwrap();

        let lifecycle = client.get_lifecycle("test-lifecycle").await.unwrap();
        assert_eq!(lifecycle.info.mode, LifecycleMode::Disabled);
        assert_eq!(lifecycle.settings.mode, LifecycleMode::Disabled);
    }

    #[rstest]
    #[tokio::test]
    async fn test_set_lifecycle_mode_dry_run(
        #[future] client: ReductClient,
        settings: LifecycleSettings,
    ) {
        let client = client.await;
        client
            .create_lifecycle("test-lifecycle")
            .set_settings(settings)
            .send()
            .await
            .unwrap();

        client
            .set_lifecycle_mode("test-lifecycle", LifecycleMode::DryRun)
            .await
            .unwrap();

        let lifecycle = client.get_lifecycle("test-lifecycle").await.unwrap();
        assert_eq!(lifecycle.info.mode, LifecycleMode::DryRun);
        assert_eq!(lifecycle.settings.mode, LifecycleMode::DryRun);
    }

    #[rstest]
    #[tokio::test]
    async fn test_delete_lifecycle(#[future] client: ReductClient, settings: LifecycleSettings) {
        let client = client.await;
        client
            .create_lifecycle("test-lifecycle")
            .set_settings(settings)
            .send()
            .await
            .unwrap();

        client.delete_lifecycle("test-lifecycle").await.unwrap();

        let lifecycles = test_lifecycles(client.list_lifecycles().await.unwrap());
        assert!(lifecycles.is_empty());
    }

    #[fixture]
    fn settings() -> LifecycleSettings {
        LifecycleSettings {
            lifecycle_type: LifecycleType::Delete,
            bucket: "test-bucket-1".to_string(),
            entries: vec![],
            older_than: "1h".to_string(),
            interval: "10m".to_string(),
            when: Some(condition!({"$eq": ["&label", 1]})),
            mode: LifecycleMode::Enabled,
        }
    }
}