feat: cache context results in k8

Signed-off-by: Ivo Yankov <[email protected]>

Author: Ivo-Yankov

src/commands/context/tasks.ts

@@ -41,7 +41,7 @@ export class ContextCommandTasks {
       let clusterAliases = Templates.parseClusterAliases(argv[flags.clusterName.name])
       let contextName = argv[flags.context.name]
 
-      const kubeContexts = await this.parent.getK8().getKubeConfig().getContexts()
+      const kubeContexts = await this.parent.getK8().getContexts()
 
       if (isQuiet) {
         const currentCluster = (await this.parent.getK8().getKubeConfig().getCurrentCluster())

src/core/config/local_config_data.ts

@@ -21,10 +21,10 @@ export interface Deployment {
 
 // an alias for the cluster, provided during the configuration
 // of the deployment, must be unique
-export type Deployments = Record<string, Deployment>;
+export type Deployments = Record<string, Deployment>
 
 export interface LocalConfigData {
-    userEmailAddress: string;
-    deployments: Deployments;
-    currentDeploymentName: string;
+    userEmailAddress: string
+    deployments: Deployments
+    currentDeploymentName: string
 }

src/core/k8.ts

@@ -23,7 +23,7 @@ import { flags } from '../commands/index.js'
 import { SoloError, IllegalArgumentError, MissingArgumentError } from './errors.js'
 import * as tar from 'tar'
 import { v4 as uuid4 } from 'uuid'
-import { type V1Lease, V1ObjectMeta, V1Secret, Config } from '@kubernetes/client-node'
+import { type V1Lease, V1ObjectMeta, V1Secret, type Context } from '@kubernetes/client-node'
 import { sleep } from './helpers.js'
 import { type ConfigManager, constants } from './index.js'
 import * as stream from 'node:stream'
@@ -44,6 +44,8 @@ interface TDirectoryData {directory: boolean; owner: string; group: string; size
  * For parallel execution, create separate instances by invoking clone()
  */
 export class K8 {
+  private _cachedContexts: Context[]
+
   static PodReadyCondition = new Map<string, string>()
     .set(constants.POD_CONDITION_READY, constants.POD_CONDITION_STATUS_TRUE)
   private kubeConfig!: k8s.KubeConfig
@@ -320,15 +322,24 @@ export class K8 {
    * Get a list of contexts
    * @returns a list of context names
    */
-  getContexts () {
+  getContextNames () : string[] {
     const contexts: string[] = []
-    for (const context of this.kubeConfig.getContexts()) {
+
+    for (const context of this.getContexts()) {
       contexts.push(context.name)
     }
 
     return contexts
   }
 
+  getContexts () :Context[] {
+    if (!this._cachedContexts) {
+      this._cachedContexts = this.kubeConfig.getContexts()
+    }
+
+    return this._cachedContexts
+  }
+
   /**
    * List files and directories in a container
    *

test/e2e/integration/core/k8_e2e.test.ts

@@ -131,6 +131,11 @@ describe('K8', () => {
     expect(namespaces).to.contain(constants.DEFAULT_NAMESPACE)
   }).timeout(defaultTimeout)
 
+  it('should be able to list context names', () => {
+    const contexts = k8.getContextNames()
+    expect(contexts).not.to.have.lengthOf(0)
+  }).timeout(defaultTimeout)
+
   it('should be able to list contexts', () => {
     const contexts = k8.getContexts()
     expect(contexts).not.to.have.lengthOf(0)

test/unit/commands/context.test.ts

@@ -45,12 +45,12 @@ describe('ContextCommandTasks unit tests', () => {
     const getBaseCommandOpts = () => {
         const loggerStub = sinon.createStubInstance(SoloLogger)
         const k8Stub = sinon.createStubInstance(K8)
-        const kubeConfigStub = sinon.createStubInstance(KubeConfig)
-        kubeConfigStub.getContexts.returns([
+        k8Stub.getContexts.returns([
             { cluster: 'cluster-1', user: 'user-1', name: 'context-1', namespace: 'deployment-1' },
             { cluster: 'cluster-2', user: 'user-2', name: 'context-2', namespace: 'deployment-2' },
             { cluster: 'cluster-3', user: 'user-3', name: 'context-3', namespace: 'deployment-3' },
         ])
+        const kubeConfigStub = sinon.createStubInstance(KubeConfig)
         kubeConfigStub.getCurrentContext.returns('context-3')
         kubeConfigStub.getCurrentContext.returns('context-3')
         kubeConfigStub.getCurrentCluster.returns({