feat: add secrets fluent interface implementation (#1312)

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

Author: nathanklick

src/commands/node/tasks.ts

@@ -854,11 +854,11 @@ export class NodeCommandTasks {
         for (const nodeAlias of ctx.config.nodeAliases) {
           const podRef = ctx.config.podRefs[nodeAlias];
           const containerRef = ContainerRef.of(podRef, constants.ROOT_CONTAINER);
-          self.logger.debug(`Uploading state files to pod ${podRef.podName.name}`);
+          self.logger.debug(`Uploading state files to pod ${podRef.name}`);
           await self.k8.copyTo(containerRef, zipFile, `${constants.HEDERA_HAPI_PATH}/data`);
 
           self.logger.info(
-            `Deleting the previous state files in pod ${podRef.podName.name} directory ${constants.HEDERA_HAPI_PATH}/data/saved`,
+            `Deleting the previous state files in pod ${podRef.name} directory ${constants.HEDERA_HAPI_PATH}/data/saved`,
           );
           await self.k8.execContainer(containerRef, ['rm', '-rf', `${constants.HEDERA_HAPI_PATH}/data/saved/*`]);
           await self.k8.execContainer(containerRef, [
@@ -1023,7 +1023,7 @@ export class NodeCommandTasks {
       'Enable port forwarding for JVM debugger',
       async (ctx: any, task: ListrTaskWrapper<any, any, any>) => {
         const podRef = PodRef.of(ctx.config.namespace, PodName.of(`network-${ctx.config.debugNodeAlias}-0`));
-        this.logger.debug(`Enable port forwarding for JVM debugger on pod ${podRef.podName.name}`);
+        this.logger.debug(`Enable port forwarding for JVM debugger on pod ${podRef.name}`);
         await this.k8.portForward(podRef, constants.JVM_DEBUG_PORT, constants.JVM_DEBUG_PORT);
       },
       (ctx: any) => !ctx.config.debugNodeAlias,

src/core/kube/container_name.ts

@@ -1,19 +1,17 @@
 /**
  * SPDX-License-Identifier: Apache-2.0
  */
-import {isDns1123Label} from './kube_validation.js';
-import {ContainerNameInvalidError} from './errors/namespace_name_invalid_error.js';
+import {ResourceName} from './resource_name.js';
+import {ResourceType} from './resource_type.js';
 
 /**
  * Represents a Kubernetes container name. A Kubernetes container name must be a valid RFC-1123 DNS label.
  *
  * @include DNS_1123_LABEL
  */
-export class ContainerName {
-  private constructor(public readonly name: string) {
-    if (!this.isValid()) {
-      throw new ContainerNameInvalidError(name);
-    }
+export class ContainerName extends ResourceName {
+  private constructor(name: string) {
+    super(ResourceType.CONTAINER, name);
   }
 
   /**
@@ -28,48 +26,4 @@ export class ContainerName {
   public static of(name: string): ContainerName {
     return new ContainerName(name);
   }
-
-  /**
-   * Returns true if the container name is valid.  A Kubernetes container name must be a valid RFC-1123 DNS label.
-   *
-   * @include DNS_1123_LABEL
-   *
-   * @returns true if the container name is valid.
-   * @throws ContainerNameInvalidError if the container name is invalid.
-   */
-  private isValid(): boolean {
-    return isDns1123Label(this.name);
-  }
-
-  /**
-   * Compares this instance with another ContainerName.
-   * @param other The other ContainerName instance.
-   * @returns true if both instances have the same name.
-   */
-  public equals(other: ContainerName): boolean {
-    return other instanceof ContainerName && this.name === other.name;
-  }
-
-  /**
-   * Allows implicit conversion to a string.
-   * @returns The container name as a string.
-   */
-  public toString(): string {
-    return this.name;
-  }
-
-  /**
-   * Allows `ContainerName` to be used as a primitive string in operations.
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  public [Symbol.toPrimitive](hint: string): string {
-    return this.name;
-  }
-
-  /**
-   * Returns the primitive value of the object.
-   */
-  public valueOf(): string {
-    return this.name;
-  }
 }

src/core/kube/container_ref.ts

@@ -3,22 +3,14 @@
  */
 import {type PodRef} from './pod_ref.js';
 import {type ContainerName} from './container_name.js';
-import {MissingContainerNameError, MissingPodRefError} from './errors/namespace_name_invalid_error.js';
+import {NestedResourceRef} from './nested_resource_ref.js';
 
 /**
  * Represents a Kubernetes pod reference which includes the namespace name and pod name.
  */
-export class ContainerRef {
-  private constructor(
-    public readonly podRef: PodRef,
-    public readonly containerName: ContainerName,
-  ) {
-    if (!podRef) {
-      throw new MissingPodRefError();
-    }
-    if (!containerName) {
-      throw new MissingContainerNameError();
-    }
+export class ContainerRef extends NestedResourceRef<PodRef, ContainerName> {
+  private constructor(parentRef: PodRef, name: ContainerName) {
+    super(parentRef, name);
   }
 
   /**
@@ -29,25 +21,4 @@ export class ContainerRef {
   public static of(podRef: PodRef, containerName: ContainerName): ContainerRef {
     return new ContainerRef(podRef, containerName);
   }
-
-  /**
-   * Compares this instance with another ContainerRef.
-   * @param other The other ContainerRef instance.
-   * @returns true if both instances have the same pod ref and container name.
-   */
-  public equals(other: ContainerRef): boolean {
-    return (
-      other instanceof ContainerRef &&
-      this.podRef.equals(other.podRef) &&
-      this.containerName.equals(other.containerName)
-    );
-  }
-
-  /**
-   * Allows implicit conversion to a string.
-   * @returns The container reference as a string.
-   */
-  public toString(): string {
-    return `{podRef: ${this.podRef.toString()}, containerName: ${this.containerName.toString()}}`;
-  }
 }

src/core/kube/errors/invalid_resource_name_error.ts

@@ -0,0 +1,26 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {SoloError} from '../../errors.js';
+import {type ResourceType} from '../resource_type.js';
+
+const RFC_1123_POSTFIX = (prefix: string) => `${prefix} is invalid, must be a valid RFC-1123 DNS label.  \` +
+    "A DNS 1123 label must consist of lower case alphanumeric characters, '-' " +
+    "or '.', and must start and end with an alphanumeric character.`;
+
+export class InvalidResourceNameError extends SoloError {
+  public static RESOURCE_NAME_INVALID = (type: ResourceType, name: string) =>
+    RFC_1123_POSTFIX(`${type} name '${name}'`);
+
+  /**
+   * Instantiates a new error with a message and an optional cause.
+   *
+   * @param name - the invalid pod name.
+   * @param type - the type of the resource.
+   * @param cause - optional underlying cause of the error.
+   * @param meta - optional metadata to be reported.
+   */
+  public constructor(name: string, type: ResourceType, cause: Error | any = {}, meta: any = {}) {
+    super(InvalidResourceNameError.RESOURCE_NAME_INVALID(type, name), cause, meta);
+  }
+}

src/core/kube/errors/missing_namespace_error.ts

@@ -0,0 +1,18 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {SoloError} from '../../errors.js';
+
+export class MissingNamespaceError extends SoloError {
+  public static MISSING_NAMESPACE = 'Namespace is required.';
+
+  /**
+   * Instantiates a new error with a message and an optional cause.
+   *
+   * @param cause - optional underlying cause of the error.
+   * @param meta - optional metadata to be reported.
+   */
+  public constructor(cause?: Error, meta?: object) {
+    super(MissingNamespaceError.MISSING_NAMESPACE, cause, meta);
+  }
+}

src/core/kube/errors/missing_parent_resource_error.ts

@@ -0,0 +1,18 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {SoloError} from '../../errors.js';
+
+export class MissingParentResourceRefError extends SoloError {
+  public static MISSING_PARENT_RESOURCE_REF = 'The parent ResourceRef is required.';
+
+  /**
+   * Instantiates a new error with a message and an optional cause.
+   *
+   * @param cause - optional underlying cause of the error.
+   * @param meta - optional metadata to be reported.
+   */
+  public constructor(cause?: Error, meta?: object) {
+    super(MissingParentResourceRefError.MISSING_PARENT_RESOURCE_REF, cause, meta);
+  }
+}

src/core/kube/errors/missing_resource_name_error.ts

@@ -0,0 +1,18 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import {SoloError} from '../../errors.js';
+
+export class MissingResourceNameError extends SoloError {
+  public static MISSING_RESOURCE_NAME = 'Name is required.';
+
+  /**
+   * Instantiates a new error with a message and an optional cause.
+   *
+   * @param cause - optional underlying cause of the error.
+   * @param meta - optional metadata to be reported.
+   */
+  public constructor(cause?: Error, meta?: object) {
+    super(MissingResourceNameError.MISSING_RESOURCE_NAME, cause, meta);
+  }
+}

src/core/kube/errors/namespace_name_invalid_error.ts

@@ -22,49 +22,6 @@ export class NamespaceNameInvalidError extends SoloError {
   }
 }
 
-export class PodNameInvalidError extends SoloError {
-  public static POD_NAME_INVALID = (name: string) => RFC_1123_POSTFIX(`Pod name '${name}'`);
-
-  /**
-   * Instantiates a new error with a message and an optional cause.
-   *
-   * @param podName - the invalid pod name.
-   * @param cause - optional underlying cause of the error.
-   * @param meta - optional metadata to be reported.
-   */
-  public constructor(podName: string, cause: Error | any = {}, meta: any = {}) {
-    super(PodNameInvalidError.POD_NAME_INVALID(podName), cause, meta);
-  }
-}
-
-export class MissingNamespaceNameError extends SoloError {
-  public static MISSING_NAMESPACE_NAME = 'Namespace name is required.';
-
-  /**
-   * Instantiates a new error with a message and an optional cause.
-   *
-   * @param cause - optional underlying cause of the error.
-   * @param meta - optional metadata to be reported.
-   */
-  public constructor(cause: Error | any = {}, meta: any = {}) {
-    super(MissingNamespaceNameError.MISSING_NAMESPACE_NAME, cause, meta);
-  }
-}
-
-export class MissingPodNameError extends SoloError {
-  public static MISSING_POD_NAME = 'Pod name is required.';
-
-  /**
-   * Instantiates a new error with a message and an optional cause.
-   *
-   * @param cause - optional underlying cause of the error.
-   * @param meta - optional metadata to be reported.
-   */
-  public constructor(cause: Error | any = {}, meta: any = {}) {
-    super(MissingPodNameError.MISSING_POD_NAME, cause, meta);
-  }
-}
-
 export class ContainerNameInvalidError extends SoloError {
   public static CONTAINER_NAME_INVALID = (name: string) => RFC_1123_POSTFIX(`Container name '${name}'`);
 

src/core/kube/k8.ts

@@ -20,6 +20,7 @@ import {type Service} from './service.js';
 import {type Pods} from './pods.js';
 import {type Leases} from './leases.js';
 import {type IngressClasses} from './ingress_classes.js';
+import {type Secrets} from './secrets.js';
 
 export interface K8 {
   /**
@@ -76,6 +77,12 @@ export interface K8 {
    */
   leases(): Leases;
 
+  /**
+   * Fluent accessor for reading and manipulating secrets in the kubernetes cluster.
+   * @returns an object instance providing secret operations
+   */
+  secrets(): Secrets;
+
   /**
    * Fluent accessor for reading and manipulating ingress classes in the kubernetes cluster.
    * @returns an object instance providing ingress class operations