kftray-portforward 0.28.0

KFtray library with port forwarding logic
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
use std::collections::{
    HashMap,
    HashSet,
};

use k8s_openapi::api::core::v1::{
    Namespace,
    Service,
    ServiceSpec,
};
use k8s_openapi::apimachinery::pkg::util::intstr::IntOrString;
use kube::api::ListParams;
use kube::config::Kubeconfig;
use kube::{
    Api,
    Client,
};
use log::info;

use super::client::error::{
    KubeClientError,
    KubeResult,
};
use super::client::get_kubeconfig_paths_from_option;
use crate::kube::models::KubeContextInfo;

pub type ServiceInfo = (String, HashMap<String, String>, HashMap<String, i32>);

pub async fn list_all_namespaces(client: Client) -> KubeResult<Vec<String>> {
    let namespaces: Api<Namespace> = Api::all(client);
    let namespace_list = namespaces.list(&ListParams::default()).await?;

    let namespace_names: Vec<String> = namespace_list
        .into_iter()
        .filter_map(|namespace| namespace.metadata.name)
        .collect();

    Ok(namespace_names)
}

pub async fn get_services_with_annotation(
    client: Client, namespace: &str, _: &str,
) -> KubeResult<Vec<ServiceInfo>> {
    let services: Api<Service> = Api::namespaced(client, namespace);
    let lp = ListParams::default();

    let service_list = services.list(&lp).await?;

    let results: Vec<ServiceInfo> = service_list
        .into_iter()
        .filter_map(|service| {
            let service_name = service.metadata.name.clone()?;
            let annotations = service.metadata.annotations.clone()?;
            if annotations
                .get("kftray.app/enabled")
                .is_some_and(|v| v == "true")
            {
                let ports = extract_ports_from_service(&service);
                let annotations_hashmap: HashMap<String, String> =
                    annotations.into_iter().collect();
                Some((service_name, annotations_hashmap, ports))
            } else {
                None
            }
        })
        .collect();

    Ok(results)
}

pub fn extract_ports_from_service(service: &Service) -> HashMap<String, i32> {
    let mut ports = HashMap::new();
    if let Some(spec) = &service.spec {
        for port in spec.ports.as_ref().unwrap_or(&vec![]) {
            let port_number = match port.target_port {
                Some(IntOrString::Int(port)) => port,
                Some(IntOrString::String(ref name)) => {
                    resolve_named_port(spec, name).unwrap_or_default()
                }
                None => continue,
            };
            ports.insert(
                port.name.clone().unwrap_or_else(|| port_number.to_string()),
                port_number,
            );
        }
    }
    ports
}

fn resolve_named_port(spec: &ServiceSpec, name: &str) -> Option<i32> {
    spec.ports.as_ref()?.iter().find_map(|port| {
        if port.name.as_deref() == Some(name) {
            Some(port.port)
        } else {
            None
        }
    })
}

pub fn list_contexts(kubeconfig: &Kubeconfig) -> Vec<String> {
    kubeconfig
        .contexts
        .iter()
        .map(|context| context.name.clone())
        .collect()
}

pub async fn list_kube_contexts(kubeconfig: Option<String>) -> KubeResult<Vec<KubeContextInfo>> {
    info!("list_kube_contexts {}", kubeconfig.as_deref().unwrap_or(""));

    let contexts = tokio::task::spawn_blocking(move || -> anyhow::Result<Vec<String>> {
        let paths = get_kubeconfig_paths_from_option(kubeconfig)?;
        // Each readable kubeconfig contributes its own contexts directly,
        // rather than going through a single merged `Kubeconfig`: a name
        // collision or other merge failure in one file would otherwise drop
        // every context from that file, not just the conflicting one.
        let mut contexts = Vec::new();
        let mut seen = HashSet::new();
        let mut errors = Vec::new();
        for path in &paths {
            match Kubeconfig::read_from(path) {
                Ok(parsed) => {
                    for name in list_contexts(&parsed) {
                        if seen.insert(name.clone()) {
                            contexts.push(name);
                        }
                    }
                }
                Err(e) => errors.push(format!("Failed to read kubeconfig from {path:?}: {e}")),
            }
        }
        if contexts.is_empty() && !errors.is_empty() {
            anyhow::bail!(errors.join("\n"));
        }
        if !errors.is_empty() {
            log::warn!(
                "Some kubeconfig paths failed to load and were skipped: {}",
                errors.join("; ")
            );
        }
        Ok(contexts)
    })
    .await
    .map_err(|err| KubeClientError::config_error(format!("Kubeconfig loading task failed: {err}")))?
    .map_err(|err| {
        KubeClientError::config_error(format!("Failed to read kubeconfig contexts: {err}"))
    })?;

    if contexts.is_empty() {
        return Err(KubeClientError::config_error(
            "No kubeconfig found or no contexts available. Please check your kubeconfig file exists and contains valid contexts",
        ));
    }

    Ok(contexts
        .into_iter()
        .map(|name| KubeContextInfo { name })
        .collect())
}

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

    #[test]
    fn test_extract_ports_from_service() {
        let mut service = k8s_openapi::api::core::v1::Service::default();

        let spec = k8s_openapi::api::core::v1::ServiceSpec {
            ports: Some(vec![
                k8s_openapi::api::core::v1::ServicePort {
                    name: Some("http".to_string()),
                    port: 80,
                    target_port: Some(IntOrString::Int(8080)),
                    ..Default::default()
                },
                k8s_openapi::api::core::v1::ServicePort {
                    name: Some("https".to_string()),
                    port: 443,
                    target_port: Some(IntOrString::Int(8443)),
                    ..Default::default()
                },
                k8s_openapi::api::core::v1::ServicePort {
                    name: Some("named-port".to_string()),
                    port: 9000,
                    target_port: Some(IntOrString::String("web".to_string())),
                    ..Default::default()
                },
                k8s_openapi::api::core::v1::ServicePort {
                    name: None,
                    port: 9090,
                    target_port: Some(IntOrString::Int(9090)),
                    ..Default::default()
                },
                k8s_openapi::api::core::v1::ServicePort {
                    name: Some("no-target".to_string()),
                    port: 8888,
                    target_port: None,
                    ..Default::default()
                },
            ]),
            ..Default::default()
        };

        service.spec = Some(spec.clone());

        let ports = extract_ports_from_service(&service);

        assert_eq!(ports.len(), 4);
        assert_eq!(ports.get("http"), Some(&8080));
        assert_eq!(ports.get("https"), Some(&8443));
        assert_eq!(ports.get("named-port"), Some(&0));
        assert_eq!(ports.get("9090"), Some(&9090));
        assert_eq!(ports.get("no-target"), None);

        service.spec = None;
        let ports = extract_ports_from_service(&service);
        assert!(ports.is_empty());
    }

    #[test]
    fn test_resolve_named_port() {
        let spec = k8s_openapi::api::core::v1::ServiceSpec {
            ports: Some(vec![
                k8s_openapi::api::core::v1::ServicePort {
                    name: Some("http".to_string()),
                    port: 80,
                    ..Default::default()
                },
                k8s_openapi::api::core::v1::ServicePort {
                    name: Some("https".to_string()),
                    port: 443,
                    ..Default::default()
                },
            ]),
            ..Default::default()
        };

        assert_eq!(resolve_named_port(&spec, "http"), Some(80));
        assert_eq!(resolve_named_port(&spec, "https"), Some(443));
        assert_eq!(resolve_named_port(&spec, "nonexistent"), None);

        let empty_spec = k8s_openapi::api::core::v1::ServiceSpec {
            ports: None,
            ..Default::default()
        };
        assert_eq!(resolve_named_port(&empty_spec, "http"), None);

        let spec_no_names = k8s_openapi::api::core::v1::ServiceSpec {
            ports: Some(vec![k8s_openapi::api::core::v1::ServicePort {
                name: None,
                port: 80,
                ..Default::default()
            }]),
            ..Default::default()
        };
        assert_eq!(resolve_named_port(&spec_no_names, "http"), None);
    }

    #[test]
    fn test_get_services_with_annotation_filter() {
        let mut service = k8s_openapi::api::core::v1::Service::default();
        let mut metadata = k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta::default();

        let mut annotations = std::collections::BTreeMap::new();
        annotations.insert("kftray.app/enabled".to_string(), "true".to_string());

        metadata.name = Some("test-service".to_string());
        metadata.annotations = Some(annotations);
        service.metadata = metadata;

        service.spec = Some(k8s_openapi::api::core::v1::ServiceSpec {
            ports: Some(vec![k8s_openapi::api::core::v1::ServicePort {
                name: Some("http".to_string()),
                port: 80,
                target_port: Some(IntOrString::Int(8080)),
                ..Default::default()
            }]),
            ..Default::default()
        });

        let ports = extract_ports_from_service(&service);
        assert_eq!(ports.len(), 1);
        assert_eq!(ports.get("http"), Some(&8080));
    }

    #[test]
    fn test_list_contexts() {
        let kubeconfig = Kubeconfig {
            contexts: vec![
                kube::config::NamedContext {
                    name: "context1".to_string(),
                    context: Some(kube::config::Context::default()),
                    ..Default::default()
                },
                kube::config::NamedContext {
                    name: "context2".to_string(),
                    context: Some(kube::config::Context::default()),
                    ..Default::default()
                },
            ],
            ..Default::default()
        };

        let contexts = list_contexts(&kubeconfig);
        assert_eq!(contexts.len(), 2);
        assert_eq!(contexts[0], "context1");
        assert_eq!(contexts[1], "context2");
    }

    #[tokio::test]
    async fn test_list_kube_contexts_empty() {
        let result = list_kube_contexts(Some("invalid".to_string())).await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_list_kube_contexts_preserves_load_error() {
        use tempfile::TempDir;

        let temp_dir = TempDir::new().unwrap();
        let kubeconfig_path = temp_dir.path().join("kubeconfig");
        std::fs::write(&kubeconfig_path, "not: valid: yaml: [").unwrap();

        let result = list_kube_contexts(Some(kubeconfig_path.to_string_lossy().to_string())).await;

        let err = result
            .err()
            .expect("malformed kubeconfig must fail")
            .to_string();
        assert!(
            err.contains(
                kubeconfig_path
                    .file_name()
                    .and_then(|name| name.to_str())
                    .expect("kubeconfig path must have a file name")
            ),
            "{err}"
        );
    }

    #[tokio::test]
    async fn test_list_kube_contexts_keeps_other_files_contexts_when_one_fails_to_merge() {
        use tempfile::TempDir;

        let temp_dir = TempDir::new().unwrap();
        let path_a = temp_dir.path().join("kubeconfig-a");
        let path_b = temp_dir.path().join("kubeconfig-b");

        std::fs::write(
            &path_a,
            "apiVersion: v1\n\
             kind: Config\n\
             current-context: context-a\n\
             contexts:\n\
             - name: context-a\n  \
               context:\n    \
                 cluster: cluster-a\n    \
                 user: user-a\n\
             clusters:\n\
             - name: cluster-a\n  \
               cluster:\n    \
                 server: https://127.0.0.1:1\n\
             users:\n\
             - name: user-a\n  \
               user: {}\n",
        )
        .unwrap();

        // A different apiVersion makes `Kubeconfig::merge` fail with
        // `ApiVersionMismatch` when combining this file with `path_a`; with
        // the old whole-object merge, that error dropped every context from
        // this file, not just the conflicting field.
        std::fs::write(
            &path_b,
            "apiVersion: v1beta1\n\
             kind: Config\n\
             current-context: context-b\n\
             contexts:\n\
             - name: context-b\n  \
               context:\n    \
                 cluster: cluster-b\n    \
                 user: user-b\n\
             clusters:\n\
             - name: cluster-b\n  \
               cluster:\n    \
                 server: https://127.0.0.1:1\n\
             users:\n\
             - name: user-b\n  \
               user: {}\n",
        )
        .unwrap();

        let separator = if cfg!(windows) { ';' } else { ':' };
        let combined = format!(
            "{}{separator}{}",
            path_a.to_string_lossy(),
            path_b.to_string_lossy()
        );

        let result = list_kube_contexts(Some(combined))
            .await
            .expect("both files parse individually and must contribute their contexts");
        let names: Vec<_> = result.into_iter().map(|ctx| ctx.name).collect();

        assert!(
            names.contains(&"context-a".to_string()),
            "expected context-a in {names:?}"
        );
        assert!(
            names.contains(&"context-b".to_string()),
            "a merge failure between the two files must not hide context-b's own context: \
             {names:?}"
        );
    }
}