k8-client 15.0.1

Core Kubernetes metadata traits
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
use std::collections::HashMap;
use std::sync::Arc;
use core::fmt::Display;

use anyhow::Result;
use async_channel::{Sender, Receiver, bounded};
use async_lock::Mutex;
use async_lock::RwLock;
use tracing::debug;
use futures_util::FutureExt;
use futures_util::StreamExt;
use futures_util::stream::BoxStream;
use serde::Serialize;
use serde::de::DeserializeOwned;
use serde_yaml::Value;

use k8_types::Spec;
use k8_types::ListMetadata;
use k8_types::MetaStatus;
use k8_types::K8Watch;
use k8_types::options::DeleteOptions;
use k8_metadata_client::TokenStreamResult;
use k8_metadata_client::PatchMergeType;
use k8_metadata_client::NameSpace;
use k8_metadata_client::ListArg;
use k8_metadata_client::MetadataClient;
use k8_types::ObjectMeta;
use k8_metadata_client::ObjectKeyNotFound;
use k8_types::UpdateK8ObjStatus;
use k8_types::DeleteStatus;
use k8_types::K8List;
use k8_types::InputK8Obj;
use k8_types::K8Meta;
use k8_types::K8Obj;

/// Store for specific type
/// It is used to store data in memory
/// It also provides the structs used to watch for changes
#[derive(Debug)]
struct SpecStore {
    data: Arc<RwLock<HashMap<String, Value>>>,
    sender: Arc<Sender<Value>>,
    receiver: Receiver<Value>,
}

impl Default for SpecStore {
    fn default() -> Self {
        let (sender, receiver) = bounded(100);

        Self {
            data: Arc::new(RwLock::new(HashMap::new())),
            sender: Arc::new(sender),
            receiver,
        }
    }
}

impl SpecStore {
    async fn get<S>(&self, key: &str) -> anyhow::Result<Option<S>>
    where
        S: DeserializeOwned,
    {
        let lock = self.data.read().await;
        let Some(value) = lock.get(key) else {
            return Ok(None);
        };

        let output = value.clone();
        drop(lock);

        Ok(serde_yaml::from_value(output)?)
    }

    async fn insert<S>(&self, key: String, mut k8_obj: K8Obj<S>) -> anyhow::Result<()>
    where
        S: Serialize + Spec + Clone + std::fmt::Debug,
    {
        let mut lock = self.data.write().await;

        let maybe_old = lock.get(&key);

        let watch: K8Watch<S> = if let Some(old_version) = maybe_old {
            let old_k8_obj: K8Obj<S> = serde_yaml::from_value(old_version.clone())?;
            let old_resource_version = old_k8_obj
                .metadata
                .resource_version
                .parse::<i32>()
                .unwrap_or_default();
            k8_obj.metadata.resource_version = (old_resource_version + 1).to_string();

            K8Watch::MODIFIED(k8_obj.clone())
        } else {
            K8Watch::ADDED(k8_obj.clone())
        };

        let value = serde_yaml::to_value(k8_obj)?;

        lock.insert(key, value);

        drop(lock);

        let watch_value = serde_yaml::to_value(watch)?;

        let _ = self.sender.send(watch_value).await;

        Ok(())
    }

    async fn items<S>(&self) -> anyhow::Result<Vec<K8Obj<S>>>
    where
        S: Spec,
    {
        let lock = self.data.read().await;
        let items: Result<Vec<K8Obj<S>>, _> = lock
            .values()
            .map(|value| serde_yaml::from_value(value.clone()))
            .collect();

        Ok(items?)
    }

    async fn remove<S>(&self, key: &str) -> Result<Option<Value>>
    where
        S: Spec,
    {
        let mut lock = self.data.write().await;
        let Some(value) = lock.remove(key) else {
            return Ok(None);
        };

        drop(lock);

        let k8_obj: K8Obj<S> = serde_yaml::from_value(value.clone())?;

        let watch: K8Watch<S> = K8Watch::DELETED(k8_obj);

        let watch_value = serde_yaml::to_value(watch)?;

        let _ = self.sender.send(watch_value).await;

        Ok(Some(value))
    }

    fn watch_stream<S>(&self) -> BoxStream<'static, TokenStreamResult<S>>
    where
        S: Spec + 'static,
        S::Status: 'static,
        S::Header: 'static,
    {
        self.receiver
            .clone()
            .map(|f| {
                Ok(vec![
                    serde_yaml::from_value::<K8Watch<S>>(f.clone()).map_err(|err| err.into())
                ])
            })
            .boxed()
    }
}

/// In-memory implementation of MetadataClient
/// This is used for testing and in also in contexts where we don't have Kubernetes and
/// there is not need to persist data
#[derive(Debug, Default)]
pub struct MemoryClient {
    data: Mutex<HashMap<String, Arc<SpecStore>>>,
}

impl MemoryClient {
    pub fn new_shared() -> Arc<Self> {
        Arc::new(Self::default())
    }

    async fn get_store<S: Spec>(&self) -> Arc<SpecStore> {
        let kind: String = S::kind();
        let mut stores = self.data.lock().await;
        if let Some(store) = stores.get(&kind) {
            store.clone()
        } else {
            let store = Arc::new(SpecStore::default());
            stores.insert(kind, store.clone());
            store
        }
    }

    pub async fn retrieve_items_inner<S: Spec>(&self) -> Result<K8List<S>> {
        let store = self.get_store::<S>().await;
        let items: Vec<K8Obj<S>> = store.items().await?;
        Ok(K8List {
            api_version: S::api_version(),
            kind: S::kind(),
            metadata: ListMetadata {
                _continue: None,
                resource_version: "0".to_owned(),
            },
            items,
        })
    }
}

#[async_trait::async_trait]
impl MetadataClient for MemoryClient {
    /// retrieval a single item
    async fn retrieve_item<S, M>(&self, metadata: &M) -> Result<Option<K8Obj<S>>>
    where
        S: Spec,
        M: K8Meta + Send + Sync,
    {
        let store = self.get_store::<S>().await;

        let name: String = metadata.name().to_owned();
        store.get::<K8Obj<S>>(&name).await
    }

    async fn retrieve_items_with_option<S, N>(
        &self,
        _namespace: N,
        _option: Option<ListArg>,
    ) -> Result<K8List<S>>
    where
        S: Spec,
        N: Into<NameSpace> + Send + Sync,
    {
        self.retrieve_items_inner().await
    }

    fn retrieve_items_in_chunks<'a, S, N>(
        self: Arc<Self>,
        _namespace: N,
        _limit: u32,
        _option: Option<ListArg>,
    ) -> BoxStream<'a, K8List<S>>
    where
        S: Spec + 'static,
        N: Into<NameSpace> + Send + Sync + 'static,
    {
        futures_util::stream::pending().boxed()
    }

    async fn delete_item_with_option<S, M>(
        &self,
        metadata: &M,
        _option: Option<DeleteOptions>,
    ) -> Result<DeleteStatus<S>>
    where
        S: Spec,
        M: K8Meta + Send + Sync,
    {
        let store = self.get_store::<S>().await;
        let key = metadata.name();

        store.remove::<S>(key).await?;

        Ok(DeleteStatus::Deleted(MetaStatus {
            api_version: S::api_version(),
            code: None,
            details: None,
            kind: S::kind(),
            reason: None,
            status: k8_types::StatusEnum::SUCCESS,
            message: None,
        }))
    }

    /// create new object
    async fn create_item<S>(&self, value: InputK8Obj<S>) -> Result<K8Obj<S>>
    where
        S: Spec,
    {
        let store = self.get_store::<S>().await;
        let key = value.metadata.name.clone();

        let mut k8_obj: K8Obj<S> = K8Obj::new(key.clone(), value.spec);

        let metadata = value.metadata;

        k8_obj.metadata = ObjectMeta {
            name: metadata.name,
            owner_references: metadata.owner_references,
            labels: metadata.labels,
            namespace: metadata.namespace,
            annotations: metadata.annotations,
            finalizers: metadata.finalizers,
            ..Default::default()
        };

        store.insert(key, k8_obj.clone()).await?;

        Ok(k8_obj)
    }

    /// update status
    async fn update_status<S>(&self, value: &UpdateK8ObjStatus<S>) -> Result<K8Obj<S>>
    where
        S: Spec,
    {
        let store = self.get_store::<S>().await;

        let key = value.metadata.name.clone();
        debug!(key,?value.status,"start updating status");

        let k8_value: Option<K8Obj<S>> = store.get(&key).await?;
        let k8_value = k8_value.ok_or(ObjectKeyNotFound::new(key.clone()))?;

        let k8_obj = k8_value.set_status(value.status.clone());
        debug!(key,?value.status,"overwrite set");

        store.insert(key, k8_obj.clone()).await?;

        debug!("done");

        Ok(k8_obj)
    }

    /// patch existing with spec
    async fn patch<S, M>(
        &self,
        _metadata: &M,
        _patch: &serde_json::Value,
        _merge_type: PatchMergeType,
    ) -> Result<K8Obj<S>>
    where
        S: Spec,
        M: K8Meta + Display + Send + Sync,
    {
        // TODO: implement or move to another trait
        unimplemented!()
    }

    /// patch status
    async fn patch_status<S, M>(
        &self,
        _metadata: &M,
        _patch: &serde_json::Value,
        _merge_type: PatchMergeType,
    ) -> Result<K8Obj<S>>
    where
        S: Spec,
        M: K8Meta + Display + Send + Sync,
    {
        // TODO: implement or move to another trait
        unimplemented!()
    }

    async fn patch_subresource<S, M>(
        &self,
        _metadata: &M,
        _subresource: String,
        _patch: &serde_json::Value,
        _merge_type: PatchMergeType,
    ) -> Result<K8Obj<S>>
    where
        S: Spec,
        M: K8Meta + Display + Send + Sync,
    {
        // TODO: implement or move to another trait
        unimplemented!()
    }

    /// stream items since resource versions
    fn watch_stream_since<S, N>(
        &self,
        _namespace: N,
        _resource_version: Option<String>,
    ) -> BoxStream<'_, TokenStreamResult<S>>
    where
        S: Spec + 'static,
        S::Status: 'static,
        S::Header: 'static,
        N: Into<NameSpace>,
    {
        let ft_stream = async move {
            let kind: String = S::kind();

            let mut lock = self.data.lock().await;
            let store = lock.entry(kind).or_default();
            let st2 = store.clone();
            drop(lock);
            st2.watch_stream()
        };

        ft_stream.flatten_stream().boxed()
    }
}

#[cfg(test)]
mod test {
    use k8_metadata_client::MetadataClient;
    use k8_types::{Spec, DefaultHeader, Crd, CrdNames, Status, K8Obj, K8Watch};
    use serde::{Serialize, Deserialize};

    use super::MemoryClient;

    #[derive(Serialize, Deserialize, Default, Debug, Eq, PartialEq, Clone)]
    pub struct MySpec {
        value: i32,
    }

    #[derive(Serialize, Deserialize, Default, Debug, Eq, PartialEq, Clone)]
    pub struct MySpecStatus {
        value: i32,
    }

    impl Status for MySpecStatus {}

    impl Spec for MySpec {
        type Status = MySpecStatus;
        type Header = DefaultHeader;

        fn metadata() -> &'static Crd {
            &Crd {
                group: "test.fluvio",
                version: "v1",
                names: CrdNames {
                    kind: "myspec",
                    plural: "myspecs",
                    singular: "myspec",
                },
            }
        }
    }
    #[fluvio_future::test]
    async fn test_metadata_client_impl() {
        use futures_util::StreamExt;
        let client = MemoryClient::new_shared();

        let mut stream = client.watch_stream_since::<MySpec, String>("".into(), None);

        // test create
        let my_spec = MySpec { value: 10 };
        let value = K8Obj::new("test".to_owned(), my_spec).as_input();
        client.create_item(value).await.expect("failed to create");

        let next_value = stream.next().await;

        let values_diffs = next_value.expect("value added");
        let mut values_diffs = values_diffs.expect("unexpected error");
        assert_eq!(values_diffs.len(), 1, "there must be only one value added");

        let value = values_diffs
            .pop()
            .expect("expected value")
            .expect("expected success");

        let K8Watch::ADDED(k8_obj) = value else {
            panic!("expected added");
        };
        assert_eq!(k8_obj.spec.value, 10);
        assert_eq!(k8_obj.status.value, 0);

        // test update
        let my_spec = MySpec { value: 15 };
        let value = K8Obj::new("test".to_owned(), my_spec).as_input();
        client.create_item(value).await.expect("failed to create");

        let next_value = stream.next().await;
        let values_diffs = next_value.expect("value added");
        let mut values_diffs = values_diffs.expect("unexpected error");
        assert_eq!(values_diffs.len(), 1, "there must be only one value diff");

        let value = values_diffs
            .pop()
            .expect("expected value")
            .expect("expected success");

        let K8Watch::MODIFIED(k8_obj) = value else {
            panic!("expected modified");
        };
        assert_eq!(k8_obj.spec.value, 15);
        assert_eq!(k8_obj.status.value, 0);

        // test update status
        let my_status = MySpecStatus { value: 20 };
        let my_spec = MySpec { value: 15 };
        let value = K8Obj::new("test".to_owned(), my_spec).as_status_update(my_status);
        client
            .update_status(&value)
            .await
            .expect("failed to update status");
        let next_value = stream.next().await;
        let values_diffs = next_value.expect("value added");
        let mut values_diffs = values_diffs.expect("unexpected error");
        assert_eq!(values_diffs.len(), 1, "there must be only one value diff");

        let value = values_diffs
            .pop()
            .expect("expected value")
            .expect("expected success");

        let K8Watch::MODIFIED(k8_obj) = value else {
            panic!("expected modified");
        };
        assert_eq!(k8_obj.spec.value, 15);
        assert_eq!(k8_obj.status.value, 20);

        // test delete
        let meta = k8_obj.metadata.clone();
        client
            .delete_item_with_option::<MySpec, _>(&meta, None)
            .await
            .expect("failed to delete");
        let next_value = stream.next().await;
        let values_diffs = next_value.expect("value added");
        let mut values_diffs = values_diffs.expect("unexpected error");
        assert_eq!(values_diffs.len(), 1, "there must be only one value added");

        let value = values_diffs
            .pop()
            .expect("expected value")
            .expect("expected success");

        let K8Watch::DELETED(_) = value else {
            panic!("expected deleted");
        };
    }
}