refactor: introduce parameter object getForwardablePorts

garden-io · Aug 23, 2023 · c7c1256 · c7c1256
1 parent 250ffd0
commit c7c1256
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 32 deletions.
diff --git a/core/src/plugins/kubernetes/helm/deployment.ts b/core/src/plugins/kubernetes/helm/deployment.ts
@@ -148,7 +148,7 @@ export const helmDeploy: DeployActionHandler<"deploy", HelmDeployAction> = async
   })
 
   // Local mode has its own port-forwarding configuration
-  const forwardablePorts = getForwardablePorts(manifests, action, mode)
+  const forwardablePorts = getForwardablePorts({ resources: manifests, parentAction: action, mode })
 
   // Make sure port forwards work after redeployment
   killPortForwards(action, forwardablePorts || [], log)

diff --git a/core/src/plugins/kubernetes/helm/status.ts b/core/src/plugins/kubernetes/helm/status.ts
@@ -78,7 +78,7 @@ export const getHelmDeployStatus: DeployActionHandler<"getStatus", HelmDeployAct
   if (state !== "missing") {
     const deployedResources = await getDeployedChartResources({ ctx: k8sCtx, action, releaseName, log })
 
-    forwardablePorts = getForwardablePorts(deployedResources, action, deployedMode)
+    forwardablePorts = getForwardablePorts({ resources: deployedResources, parentAction: action, mode: deployedMode })
     ingresses = getK8sIngresses(deployedResources)
 
     if (state === "ready") {

diff --git a/core/src/plugins/kubernetes/kubernetes-type/handlers.ts b/core/src/plugins/kubernetes/kubernetes-type/handlers.ts
@@ -248,7 +248,7 @@ export const getKubernetesDeployStatus: DeployActionHandler<"getStatus", Kuberne
 
     if (remoteResources && remoteResources.length > 0) {
       try {
-        forwardablePorts = getForwardablePorts(remoteResources, action, deployedMode)
+        forwardablePorts = getForwardablePorts({ resources: remoteResources, parentAction: action, mode: deployedMode })
       } catch (error) {
         log.debug({ msg: `Unable to extract forwardable ports: ${error.message}`, error })
       }

diff --git a/core/src/plugins/kubernetes/port-forward.ts b/core/src/plugins/kubernetes/port-forward.ts
@@ -221,11 +221,15 @@ function getTargetResourceName(action: SupportedRuntimeAction, targetName?: stri
 /**
  * Returns a list of forwardable ports based on the specified resources.
  */
-export function getForwardablePorts(
-  resources: KubernetesResource[],
-  parentAction: Resolved<KubernetesDeployAction | HelmDeployAction> | undefined,
+export function getForwardablePorts({
+  resources,
+  parentAction,
+  mode,
+}: {
+  resources: KubernetesResource[]
+  parentAction: Resolved<KubernetesDeployAction | HelmDeployAction> | undefined
   mode: ActionMode
-): ForwardablePort[] {
+}): ForwardablePort[] {
   const spec = parentAction?.getSpec()
 
   // Note: Local mode has its own port-forwarding configuration

diff --git a/core/test/unit/src/plugins/kubernetes/port-forward.ts b/core/test/unit/src/plugins/kubernetes/port-forward.ts
@@ -16,8 +16,8 @@ import { ResolvedDeployAction } from "../../../../../src/actions/deploy"
 
 describe("getForwardablePorts", () => {
   it("returns all ports for Service resources", () => {
-    const ports = getForwardablePorts(
-      [
+    const ports = getForwardablePorts({
+      resources: [
         {
           apiVersion: "v1",
           kind: "Service",
@@ -29,9 +29,9 @@ describe("getForwardablePorts", () => {
           },
         },
       ],
-      undefined,
-      "default"
-    )
+      parentAction: undefined,
+      mode: "default",
+    })
 
     expect(ports).to.eql([
       {
@@ -64,8 +64,8 @@ describe("getForwardablePorts", () => {
       },
     }
 
-    const ports = getForwardablePorts(
-      [
+    const ports = getForwardablePorts({
+      resources: [
         {
           apiVersion: "v1",
           kind: "Service",
@@ -77,9 +77,9 @@ describe("getForwardablePorts", () => {
           },
         },
       ],
-      action,
-      "default"
-    )
+      parentAction: action,
+      mode: "default",
+    })
 
     expect(ports).to.eql([
       {
@@ -93,8 +93,8 @@ describe("getForwardablePorts", () => {
   })
 
   it("returns all ports for Deployment resources", () => {
-    const ports = getForwardablePorts(
-      [
+    const ports = getForwardablePorts({
+      resources: [
         {
           apiVersion: "apps/v1",
           kind: "Deployment",
@@ -114,9 +114,9 @@ describe("getForwardablePorts", () => {
           },
         },
       ],
-      undefined,
-      "default"
-    )
+      parentAction: undefined,
+      mode: "default",
+    })
 
     expect(ports).to.eql([
       {
@@ -129,8 +129,8 @@ describe("getForwardablePorts", () => {
   })
 
   it("returns all ports for DaemonSet resources", () => {
-    const ports = getForwardablePorts(
-      [
+    const ports = getForwardablePorts({
+      resources: [
         {
           apiVersion: "apps/v1",
           kind: "DaemonSet",
@@ -150,9 +150,9 @@ describe("getForwardablePorts", () => {
           },
         },
       ],
-      undefined,
-      "default"
-    )
+      parentAction: undefined,
+      mode: "default",
+    })
 
     expect(ports).to.eql([
       {
@@ -165,8 +165,8 @@ describe("getForwardablePorts", () => {
   })
 
   it("omits a Deployment port that is already pointed to by a Service resource", () => {
-    const ports = getForwardablePorts(
-      [
+    const ports = getForwardablePorts({
+      resources: [
         {
           apiVersion: "v1",
           kind: "Service",
@@ -204,9 +204,9 @@ describe("getForwardablePorts", () => {
           },
         },
       ],
-      undefined,
-      "default"
-    )
+      parentAction: undefined,
+      mode: "default",
+    })
 
     expect(ports).to.eql([
       {