refactor: create k8.Container interface, move container methods from Pod to Container, implement K8ClientContainer and implement across codebase (#1294)

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

Author: jeromy-cannon

src/core/kube/container.ts

@@ -0,0 +1,72 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {type TarCreateFilter} from '../../types/aliases.js';
+import {type TDirectoryData} from './t_directory_data.js';
+
+export interface Container {
+  /**
+   * Copy a file from a container
+   *
+   * It overwrites any existing file at the destination directory
+   * @param srcPath - the path to the file to copy
+   * @param destDir - the destination directory
+   */
+  copyFrom(srcPath: string, destDir: string): Promise<unknown>;
+
+  /**
+   * Copy a file into a container
+   *
+   * It overwrites any existing file inside the container at the destination directory
+   * @param srcPath - the path of the local file to copy
+   * @param destDir - the remote destination directory
+   * @param [filter] - the filter to pass to tar to keep or skip files or directories
+   * @returns a Promise that performs the copy operation
+   */
+  copyTo(srcPath: string, destDir: string, filter: TarCreateFilter | undefined): Promise<boolean>;
+
+  /**
+   * Invoke sh command within a container and return the console output as string
+   * @param command - sh commands as an array to be run within the containerName (e.g 'ls -la /opt/hgcapp')
+   * @returns console output as string
+   */
+  execContainer(command: string | string[]): Promise<string>;
+
+  /**
+   * Check if a directory exists in the specified container
+   * @param destPath - the path to the directory inside the container
+   */
+  hasDir(destPath: string): Promise<boolean>;
+
+  /**
+   * Check if a file exists in the specified container
+   * @param destPath - the remote path to the file
+   * @param [filters] - optional filters to apply to the tar stream
+   */
+  hasFile(destPath: string, filters: object): Promise<boolean>;
+
+  /**
+   * List files and directories in a container
+   *
+   * It runs ls -la on the specified path and returns a list of object containing the entries.
+   * For example:
+   * [{
+   *    directory: false,
+   *    owner: hedera,
+   *    group: hedera,
+   *    size: 121,
+   *    modifiedAt: Jan 15 13:50
+   *    name: config.txt
+   * }]
+   * @param destPath - the remote path to the directory
+   * @returns a promise that returns array of directory entries, custom object
+   */
+  listDir(destPath: string): Promise<any[] | TDirectoryData[]>;
+
+  /**
+   * Make a directory in the specified container
+   * @param destPath - the remote path to the directory
+   */
+  mkdir(destPath: string): Promise<string>;
+}

src/core/kube/containers.ts

@@ -0,0 +1,14 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {type ContainerRef} from './container_ref.js';
+import {type Container} from './container.js';
+
+export interface Containers {
+  /**
+   * Get a container by reference for running operations against
+   * @param containerRef - the reference to the container
+   * @returns a container object
+   */
+  readByRef(containerRef: ContainerRef): Container;
+}

src/core/kube/k8.ts

@@ -9,9 +9,9 @@ import {type TDirectoryData} from './t_directory_data.js';
 import {type V1Lease} from '@kubernetes/client-node';
 import {type Namespaces} from './namespaces.js';
 import {type NamespaceName} from './namespace_name.js';
+import {type Containers} from './containers.js';
 import {type Clusters} from './clusters.js';
 import {type ConfigMaps} from './config_maps.js';
-import {type ContainerName} from './container_name.js';
 import {type ContainerRef} from './container_ref.js';
 
 export interface K8 {
@@ -21,6 +21,12 @@ export interface K8 {
    */
   namespaces(): Namespaces;
 
+  /**
+   * Fluent accessor for reading and manipulating containers.
+   * returns an object instance providing container operations
+   */
+  containers(): Containers;
+
   /**
    * Fluent accessor for reading and manipulating cluster information from the kubeconfig file.
    * @returns an object instance providing cluster operations