refactor: added namespaced fluent interface implementation (#1299)

Signed-off-by: Jeromy Cannon <jeromy@swirldslabs.com>

Author: jeromy-cannon

src/core/kube/k8_client.ts

@@ -17,7 +17,7 @@ import {inject, injectable} from 'tsyringe-neo';
 import {patchInject} from './../container_helper.js';
 import {type K8} from './k8.js';
 import {type Namespaces} from './namespaces.js';
-import {NamespaceName} from './namespace_name.js';
+import {type NamespaceName} from './namespace_name.js';
 import {K8ClientClusters} from './k8_client/k8_client_clusters.js';
 import {type Clusters} from './clusters.js';
 import {type ConfigMaps} from './config_maps.js';
@@ -38,6 +38,7 @@ import {type Pvcs} from './pvcs.js';
 import {K8ClientPvcs} from './k8_client/k8_client_pvcs.js';
 import {type Leases} from './leases.js';
 import {K8ClientLeases} from './k8_client/k8_client_leases.js';
+import {K8ClientNamespaces} from './k8_client/k8_client_namespaces.js';
 
 /**
  * A kubernetes API wrapper class providing custom functionalities required by solo
@@ -63,6 +64,7 @@ export class K8Client extends K8ClientBase implements K8 {
   private k8Contexts: Contexts;
   private k8Services: Services;
   private k8Pvcs: Pvcs;
+  private k8Namespaces: Namespaces;
 
   constructor(
     @inject(ConfigManager) private readonly configManager?: ConfigManager,
@@ -100,46 +102,27 @@ export class K8Client extends K8ClientBase implements K8 {
     this.k8Pods = new K8ClientPods(this.kubeClient, this.kubeConfig);
     this.k8Pvcs = new K8ClientPvcs(this.kubeClient);
     this.k8Leases = new K8ClientLeases(this.coordinationApiClient);
+    this.k8Namespaces = new K8ClientNamespaces(this.kubeClient);
 
     return this; // to enable chaining
   }
 
-  /**
-   * Fluent accessor for reading and manipulating namespaces in the kubernetes cluster.
-   * @returns an object instance providing namespace operations
-   */
   public namespaces(): Namespaces {
-    return null;
+    return this.k8Namespaces;
   }
 
-  /**
-   * Fluent accessor for reading and manipulating cluster information from the kubeconfig file.
-   * @returns an object instance providing cluster operations
-   */
   public clusters(): Clusters {
     return this.k8Clusters;
   }
 
-  /**
-   * Fluent accessor for reading and manipulating config maps in the kubernetes cluster.
-   * @returns an object instance providing config map operations
-   */
   public configMaps(): ConfigMaps {
     return this.k8ConfigMaps;
   }
 
-  /**
-   * Fluent accessor for reading and manipulating containers.
-   * returns an object instance providing container operations
-   */
   public containers(): Containers {
     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;
   }
@@ -173,38 +156,19 @@ export class K8Client extends K8ClientBase implements K8 {
   }
 
   public async createNamespace(namespace: NamespaceName) {
-    const payload = {
-      metadata: {
-        name: namespace.name,
-      },
-    };
-
-    const resp = await this.kubeClient.createNamespace(payload);
-    return resp.response.statusCode === StatusCodes.CREATED;
+    return this.namespaces().create(namespace);
   }
 
   public async deleteNamespace(namespace: NamespaceName) {
-    const resp = await this.kubeClient.deleteNamespace(namespace.name);
-    return resp.response.statusCode === StatusCodes.OK;
+    return this.namespaces().delete(namespace);
   }
 
   public async getNamespaces() {
-    const resp = await this.kubeClient.listNamespace();
-    if (resp.body && resp.body.items) {
-      const namespaces: NamespaceName[] = [];
-      resp.body.items.forEach(item => {
-        namespaces.push(NamespaceName.of(item.metadata!.name));
-      });
-
-      return namespaces;
-    }
-
-    throw new SoloError('incorrect response received from kubernetes API. Unable to list namespaces');
+    return this.namespaces().list();
   }
 
   public async hasNamespace(namespace: NamespaceName) {
-    const namespaces = await this.getNamespaces();
-    return namespaces.some(namespaces => namespaces.equals(namespace));
+    return this.namespaces().has(namespace);
   }
 
   public async getPodByName(podRef: PodRef): Promise<k8s.V1Pod> {

src/core/kube/k8_client/k8_client_namespaces.ts

@@ -0,0 +1,47 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {type Namespaces} from '../namespaces.js';
+import {NamespaceName} from '../namespace_name.js';
+import {type CoreV1Api} from '@kubernetes/client-node';
+import {StatusCodes} from 'http-status-codes';
+import {SoloError} from '../../errors.js';
+
+export class K8ClientNamespaces implements Namespaces {
+  constructor(private readonly kubeClient: CoreV1Api) {}
+
+  public async create(namespace: NamespaceName): Promise<boolean> {
+    const payload = {
+      metadata: {
+        name: namespace.name,
+      },
+    };
+
+    const resp = await this.kubeClient.createNamespace(payload);
+    return resp.response.statusCode === StatusCodes.CREATED;
+  }
+
+  public async delete(namespace: NamespaceName): Promise<boolean> {
+    const resp = await this.kubeClient.deleteNamespace(namespace.name);
+    return resp.response.statusCode === StatusCodes.OK;
+  }
+
+  public async has(namespace: NamespaceName): Promise<boolean> {
+    const namespaces = await this.list();
+    return namespaces.some(namespaces => namespaces.equals(namespace));
+  }
+
+  public async list(): Promise<NamespaceName[]> {
+    const resp = await this.kubeClient.listNamespace();
+    if (resp.body && resp.body.items) {
+      const namespaces: NamespaceName[] = [];
+      resp.body.items.forEach(item => {
+        namespaces.push(NamespaceName.of(item.metadata!.name));
+      });
+
+      return namespaces;
+    }
+
+    throw new SoloError('incorrect response received from kubernetes API. Unable to list namespaces');
+  }
+}

src/core/kube/namespaces.ts

@@ -3,9 +3,6 @@
  */
 import {type NamespaceName} from './namespace_name.js';
 
-/**
- * SPDX-License-Identifier: Apache-2.0
- */
 export interface Namespaces {
   /**
    * Create a new namespace
@@ -22,6 +19,7 @@ export interface Namespaces {
   /**
    * List all namespaces
    * @returns a list of namespace names
+   * @throws SoloError if the response from the kubernetes API is incorrect
    */
   list(): Promise<NamespaceName[]>; // TODO was getNamespaces