feat: add contexts fluent interface implementation (#1297)

Signed-off-by: Nathan Klick <[email protected]>

Author: nathanklick

src/core/kube/contexts.ts

@@ -1,3 +1,8 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {type NamespaceName} from './namespace_name.js';
+
 /**
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -6,25 +11,25 @@ export interface Contexts {
    * List all contexts in the kubeconfig
    * @returns a list of context names
    */
-  list(): Promise<string[]>; // TODO was getContextNames
+  list(): string[]; // TODO was getContextNames
 
   /**
    * Read the current context in the kubeconfig
    * @returns the current context name
    */
-  readCurrent(): Promise<string>; // TODO was getCurrentContext
+  readCurrent(): string; // TODO was getCurrentContext
 
   /**
    * Read the current namespace in the kubeconfig
    * @returns the current namespace name
    */
-  readCurrentNamespace(): Promise<string>; // TODO was getCurrentContextNamespace
+  readCurrentNamespace(): NamespaceName; // TODO was getCurrentContextNamespace
 
   /**
    * Set the current context in the kubeconfig
    * @param context - the context name to set
    */
-  updateCurrent(context: string): Promise<void>; // TODO delete this once we are instantiating multiple K8 instances, was setCurrentContext
+  updateCurrent(context: string): void; // TODO delete this once we are instantiating multiple K8 instances, was setCurrentContext
 
   /**
    * Test the connection to a context

src/core/kube/k8.ts

@@ -13,6 +13,7 @@ import {type Containers} from './containers.js';
 import {type Clusters} from './clusters.js';
 import {type ConfigMaps} from './config_maps.js';
 import {type ContainerRef} from './container_ref.js';
+import {type Contexts} from './contexts.js';
 
 export interface K8 {
   /**
@@ -39,6 +40,12 @@ export interface K8 {
    */
   configMaps(): ConfigMaps;
 
+  /**
+   * Fluent accessor for reading and manipulating contexts in the kubeconfig file.
+   * @returns an object instance providing context operations
+   */
+  contexts(): Contexts;
+
   /**
    * Create a new namespace
    * @param namespace - the namespace to create

src/core/kube/k8_client.ts

@@ -8,7 +8,6 @@ import net from 'net';
 import path from 'path';
 import {Flags as flags} from '../../commands/flags.js';
 import {MissingArgumentError, SoloError} from './../errors.js';
-import type * as http from 'node:http';
 import {getReasonPhrase, StatusCodes} from 'http-status-codes';
 import {sleep} from './../helpers.js';
 import * as constants from './../constants.js';
@@ -32,6 +31,9 @@ import {PodRef} from './pod_ref.js';
 import {ContainerRef} from './container_ref.js';
 import {K8ClientContainers} from './k8_client/k8_client_containers.js';
 import {type Containers} from './containers.js';
+import {type Contexts} from './contexts.js';
+import type http from 'node:http';
+import K8ClientContexts from './k8_client/k8_client_contexts.js';
 
 /**
  * A kubernetes API wrapper class providing custom functionalities required by solo
@@ -42,8 +44,6 @@ import {type Containers} from './containers.js';
 // TODO rename to K8Client and move to kube folder
 @injectable()
 export class K8Client implements K8 {
-  private cachedContexts: Context[];
-
   static PodReadyCondition = new Map<string, string>().set(
     constants.POD_CONDITION_READY,
     constants.POD_CONDITION_STATUS_TRUE,
@@ -56,8 +56,8 @@ export class K8Client implements K8 {
 
   private k8Clusters: K8ClientClusters;
   private k8ConfigMaps: K8ClientConfigMaps;
-
   private k8Containers: K8ClientContainers;
+  private k8Contexts: K8ClientContexts;
 
   constructor(
     @inject(ConfigManager) private readonly configManager?: ConfigManager,
@@ -89,6 +89,7 @@ export class K8Client implements K8 {
     this.k8Clusters = new K8ClientClusters(this.kubeConfig);
     this.k8ConfigMaps = new K8ClientConfigMaps(this.kubeClient);
     this.k8Containers = new K8ClientContainers(this.kubeConfig);
+    this.k8Contexts = new K8ClientContexts(this.kubeConfig);
 
     return this; // to enable chaining
   }
@@ -122,6 +123,14 @@ export class K8Client implements K8 {
     return this.k8Containers;
   }
 
+  /**
+   * Fluent accessor for reading and manipulating contexts in the kubeconfig file.
+   * @returns an object instance providing context operations
+   */
+  public contexts(): Contexts {
+    return this.k8Contexts;
+  }
+
   /**
    * Apply filters to metadata
    * @param items - list of items
@@ -288,21 +297,7 @@ export class K8Client implements K8 {
   }
 
   public getContextNames(): string[] {
-    const contexts: string[] = [];
-
-    for (const context of this.getContexts()) {
-      contexts.push(context.name);
-    }
-
-    return contexts;
-  }
-
-  private getContexts(): Context[] {
-    if (!this.cachedContexts) {
-      this.cachedContexts = this.kubeConfig.getContexts();
-    }
-
-    return this.cachedContexts;
+    return this.contexts().list();
   }
 
   public async listDir(containerRef: ContainerRef, destPath: string) {
@@ -1096,11 +1091,11 @@ export class K8Client implements K8 {
   }
 
   public getCurrentContext(): string {
-    return this.kubeConfig.getCurrentContext();
+    return this.contexts().readCurrent();
   }
 
   public getCurrentContextNamespace(): NamespaceName {
-    return NamespaceName.of(this.kubeConfig.getContextObject(this.getCurrentContext())?.namespace);
+    return this.contexts().readCurrentNamespace();
   }
 
   public getCurrentClusterName(): string {

src/core/kube/k8_client/k8_client_clusters.ts

@@ -12,7 +12,7 @@ export default class K8ClientClusters implements Clusters {
     }
   }
 
-  list(): string[] {
+  public list(): string[] {
     const clusters: string[] = [];
     for (const cluster of this.kubeConfig.getClusters()) {
       clusters.push(cluster.name);
@@ -21,7 +21,7 @@ export default class K8ClientClusters implements Clusters {
     return clusters;
   }
 
-  readCurrent(): string {
+  public readCurrent(): string {
     const currentCluster = this.kubeConfig.getCurrentCluster();
     return !currentCluster ? '' : currentCluster.name;
   }

src/core/kube/k8_client/k8_client_config_maps.ts

@@ -1,8 +1,7 @@
 /**
  * SPDX-License-Identifier: Apache-2.0
  */
-import * as k8s from '@kubernetes/client-node';
-import {type V1ConfigMap} from '@kubernetes/client-node';
+import {type CoreV1Api, V1ConfigMap, V1ObjectMeta} from '@kubernetes/client-node';
 import {type ConfigMaps} from '../config_maps.js';
 import {type NamespaceName} from '../namespace_name.js';
 import {
@@ -16,9 +15,9 @@ import {ResourceOperation} from '../resource_operation.js';
 import {KubeApiResponse} from '../kube_api_response.js';
 
 export default class K8ClientConfigMaps implements ConfigMaps {
-  constructor(private readonly kubeClient: k8s.CoreV1Api) {}
+  public constructor(private readonly kubeClient: CoreV1Api) {}
 
-  async create(
+  public async create(
     namespace: NamespaceName,
     name: string,
     labels: Record<string, string>,
@@ -27,7 +26,7 @@ export default class K8ClientConfigMaps implements ConfigMaps {
     return this.createOrReplaceWithForce(namespace, name, labels, data, false, true);
   }
 
-  async createOrReplace(
+  public async createOrReplace(
     namespace: NamespaceName,
     name: string,
     labels: Record<string, string>,
@@ -36,7 +35,7 @@ export default class K8ClientConfigMaps implements ConfigMaps {
     return this.createOrReplaceWithForce(namespace, name, labels, data, false, false);
   }
 
-  async delete(namespace: NamespaceName, name: string): Promise<boolean> {
+  public async delete(namespace: NamespaceName, name: string): Promise<boolean> {
     try {
       const resp = await this.kubeClient.deleteNamespacedConfigMap(name, namespace.name);
       return KubeApiResponse.isFailingStatus(resp.response);
@@ -45,13 +44,13 @@ export default class K8ClientConfigMaps implements ConfigMaps {
     }
   }
 
-  async read(namespace: NamespaceName, name: string): Promise<V1ConfigMap> {
+  public async read(namespace: NamespaceName, name: string): Promise<V1ConfigMap> {
     const {response, body} = await this.kubeClient.readNamespacedConfigMap(name, namespace.name).catch(e => e);
     KubeApiResponse.check(response, ResourceOperation.READ, ResourceType.CONFIG_MAP, namespace, name);
-    return body as k8s.V1ConfigMap;
+    return body as V1ConfigMap;
   }
 
-  async replace(
+  public async replace(
     namespace: NamespaceName,
     name: string,
     labels: Record<string, string>,
@@ -60,7 +59,7 @@ export default class K8ClientConfigMaps implements ConfigMaps {
     return this.createOrReplaceWithForce(namespace, name, labels, data, true, false);
   }
 
-  async exists(namespace: NamespaceName, name: string): Promise<boolean> {
+  public async exists(namespace: NamespaceName, name: string): Promise<boolean> {
     try {
       const cm = await this.read(namespace, name);
       return !!cm;
@@ -82,10 +81,10 @@ export default class K8ClientConfigMaps implements ConfigMaps {
     forceCreate?: boolean,
   ): Promise<boolean> {
     const replace = await this.shouldReplace(namespace, name, forceReplace, forceCreate);
-    const configMap = new k8s.V1ConfigMap();
+    const configMap = new V1ConfigMap();
     configMap.data = data;
 
-    const metadata = new k8s.V1ObjectMeta();
+    const metadata = new V1ObjectMeta();
     metadata.name = name;
     metadata.namespace = namespace.name;
     metadata.labels = labels;

src/core/kube/k8_client/k8_client_container.ts

@@ -31,7 +31,7 @@ export class K8ClientContainer implements Container {
     this.k8 = container.resolve('K8') as K8;
   }
 
-  async copyFrom(srcPath: string, destDir: string): Promise<unknown> {
+  public async copyFrom(srcPath: string, destDir: string): Promise<unknown> {
     const self = this;
     const namespace = this.containerRef.podRef.namespaceName;
     const guid = uuid4();
@@ -165,7 +165,7 @@ export class K8ClientContainer implements Container {
     }
   }
 
-  async copyTo(srcPath: string, destDir: string, filter: TarCreateFilter | undefined): Promise<boolean> {
+  public async copyTo(srcPath: string, destDir: string, filter: TarCreateFilter | undefined): Promise<boolean> {
     const self = this;
     const namespace = this.containerRef.podRef.namespaceName;
     const guid = uuid4();
@@ -250,7 +250,7 @@ export class K8ClientContainer implements Container {
     }
   }
 
-  async execContainer(command: string | string[]): Promise<string> {
+  public async execContainer(command: string | string[]): Promise<string> {
     const self = this;
     const namespace = this.containerRef.podRef.namespaceName;
     const guid = uuid4();
@@ -330,14 +330,14 @@ export class K8ClientContainer implements Container {
     });
   }
 
-  async hasDir(destPath: string): Promise<boolean> {
+  public async hasDir(destPath: string): Promise<boolean> {
     return (
       (await this.execContainer(['bash', '-c', '[[ -d "' + destPath + '" ]] && echo -n "true" || echo -n "false"'])) ===
       'true'
     );
   }
 
-  async hasFile(destPath: string, filters: object): Promise<boolean> {
+  public async hasFile(destPath: string, filters: object): Promise<boolean> {
     const parentDir = path.dirname(destPath);
     const fileName = path.basename(destPath);
     const filterMap = new Map(Object.entries(filters));
@@ -385,7 +385,7 @@ export class K8ClientContainer implements Container {
     return false;
   }
 
-  async listDir(destPath: string): Promise<any[] | TDirectoryData[]> {
+  public async listDir(destPath: string): Promise<any[] | TDirectoryData[]> {
     // TODO future, return the following
     // return this.pods.byName(podName).listDir(containerName, destPath);
     // byName(podName) can use an underlying cache to avoid multiple calls to the API
@@ -447,7 +447,7 @@ export class K8ClientContainer implements Container {
     }
   }
 
-  async mkdir(destPath: string): Promise<string> {
+  public async mkdir(destPath: string): Promise<string> {
     return this.execContainer(['bash', '-c', 'mkdir -p "' + destPath + '"']);
   }
 

src/core/kube/k8_client/k8_client_containers.ts

@@ -11,9 +11,9 @@ import {type KubeConfig} from '@kubernetes/client-node';
  * SPDX-License-Identifier: Apache-2.0
  */
 export class K8ClientContainers implements Containers {
-  constructor(private readonly kubeConfig: KubeConfig) {}
+  public constructor(private readonly kubeConfig: KubeConfig) {}
 
-  readByRef(containerRef: ContainerRef): Container {
+  public readByRef(containerRef: ContainerRef): Container {
     return new K8ClientContainer(this.kubeConfig, containerRef);
   }
 }

src/core/kube/k8_client/k8_client_contexts.ts

@@ -0,0 +1,49 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {type Contexts} from '../contexts.js';
+import {type KubeConfig, CoreV1Api} from '@kubernetes/client-node';
+import {NamespaceName} from '../namespace_name.js';
+
+export default class K8ClientContexts implements Contexts {
+  public constructor(private readonly kubeConfig: KubeConfig) {}
+
+  public list(): string[] {
+    const contexts: string[] = [];
+
+    for (const context of this.kubeConfig.getContexts()) {
+      contexts.push(context.name);
+    }
+
+    return contexts;
+  }
+
+  public readCurrent(): string {
+    return this.kubeConfig.getCurrentContext();
+  }
+
+  public readCurrentNamespace(): NamespaceName {
+    return NamespaceName.of(this.kubeConfig.getContextObject(this.readCurrent())?.namespace);
+  }
+
+  public updateCurrent(context: string): void {
+    this.kubeConfig.setCurrentContext(context);
+  }
+
+  public async testContextConnection(context: string): Promise<boolean> {
+    const originalCtxName = this.readCurrent();
+    this.kubeConfig.setCurrentContext(context);
+
+    const tempKubeClient = this.kubeConfig.makeApiClient(CoreV1Api);
+    return await tempKubeClient
+      .listNamespace()
+      .then(() => {
+        this.kubeConfig.setCurrentContext(originalCtxName);
+        return true;
+      })
+      .catch(() => {
+        this.kubeConfig.setCurrentContext(originalCtxName);
+        return false;
+      });
+  }
+}