Migrate command and tests to runWithProgress

Author: kaelemc

src/commands/deploy.ts

@@ -1,6 +1,5 @@
 import { ClabLabTreeNode } from "../treeView/common";
 import { ClabCommand } from "./clabCommand";
-import { SpinnerMsg } from "./command";
 import * as vscode from "vscode";
 import { deployPopularLab } from "./deployPopular";
 import { getSelectedLabNode } from "./utils";
@@ -11,11 +10,7 @@ export async function deploy(node?: ClabLabTreeNode) {
     return;
   }
 
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: "Deploying Lab... ",
-    successMsg: "Lab deployed successfully!"
-  };
-  const deployCmd = new ClabCommand("deploy", node, spinnerMessages);
+  const deployCmd = new ClabCommand("deploy", node);
   deployCmd.run();
 }
 
@@ -40,11 +35,8 @@ export async function deployCleanup(node?: ClabLabTreeNode) {
       await config.update("skipCleanupWarning", true, vscode.ConfigurationTarget.Global);
     }
   }
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: "Deploying Lab (cleanup)... ",
-    successMsg: "Lab deployed (cleanup) successfully!"
-  };
-  const deployCmd = new ClabCommand("deploy", node, spinnerMessages);
+
+  const deployCmd = new ClabCommand("deploy", node);
   deployCmd.run(["-c"]);
 }
 

src/commands/destroy.ts

@@ -1,7 +1,6 @@
 import * as vscode from "vscode";
 import { ClabLabTreeNode } from "../treeView/common";
 import { ClabCommand } from "./clabCommand";
-import { SpinnerMsg } from "./command";
 import { getSelectedLabNode } from "./utils";
 
 export async function destroy(node?: ClabLabTreeNode) {
@@ -10,11 +9,7 @@ export async function destroy(node?: ClabLabTreeNode) {
     return;
   }
 
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: "Destroying Lab... ",
-    successMsg: "Lab destroyed successfully!"
-  };
-  const destroyCmd = new ClabCommand("destroy", node, spinnerMessages);
+  const destroyCmd = new ClabCommand("destroy", node);
   destroyCmd.run();
 }
 
@@ -39,10 +34,7 @@ export async function destroyCleanup(node?: ClabLabTreeNode) {
       await config.update("skipCleanupWarning", true, vscode.ConfigurationTarget.Global);
     }
   }
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: "Destroying Lab (cleanup)... ",
-    successMsg: "Lab destroyed (cleanup) successfully!"
-  };
-  const destroyCmd = new ClabCommand("destroy", node, spinnerMessages);
+
+  const destroyCmd = new ClabCommand("destroy", node);
   destroyCmd.run(["-c"]);
 }

src/commands/edgeshark.ts

@@ -1,4 +1,4 @@
-import { execCommandInTerminal } from "./command";
+import { execCommandInTerminal } from './command';
 
 export const EDGESHARK_INSTALL_CMD = "curl -sL \
 https://github.com/siemens/edgeshark/raw/main/deployments/wget/docker-compose.yaml \

src/commands/graph.ts

@@ -1,7 +1,6 @@
 import * as vscode from "vscode";
 import * as fs from "fs";
 import { ClabCommand } from "./clabCommand";
-import { SpinnerMsg } from "./command";
 import { ClabLabTreeNode } from "../treeView/common";
 
 import { TopoViewer } from "../topoViewer/backend/topoViewerWebUiFacade";
@@ -18,13 +17,7 @@ async function runGraphDrawIO(node: ClabLabTreeNode | undefined, layout: "horizo
     return;
   }
 
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: "Generating DrawIO graph...",
-    successMsg: "DrawIO Graph Completed!",
-    failMsg: "Graph (draw.io) Failed",
-  };
-
-  const graphCmd = new ClabCommand("graph", node, spinnerMessages);
+  const graphCmd = new ClabCommand("graph", node);
 
   // Figure out the .drawio filename
   if (!node.labPath.absolute) {
@@ -71,7 +64,7 @@ export async function graphDrawIOInteractive(node?: ClabLabTreeNode) {
     return;
   }
 
-  const graphCmd = new ClabCommand("graph", node, undefined, true, "Graph - drawio Interactive");
+  const graphCmd = new ClabCommand("graph", node);
 
   graphCmd.run(["--drawio", "--drawio-args", `"-I"`]);
 }

src/commands/redeploy.ts

@@ -1,7 +1,6 @@
 import * as vscode from "vscode";
 import { ClabLabTreeNode } from "../treeView/common";
 import { ClabCommand } from "./clabCommand";
-import { SpinnerMsg } from "./command";
 import { getSelectedLabNode } from "./utils";
 
 export async function redeploy(node?: ClabLabTreeNode) {
@@ -10,11 +9,7 @@ export async function redeploy(node?: ClabLabTreeNode) {
     return;
   }
 
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: "Redeploying Lab... ",
-    successMsg: "Lab redeployed successfully!"
-  };
-  const redeployCmd = new ClabCommand("redeploy", node, spinnerMessages);
+  const redeployCmd = new ClabCommand("redeploy", node);
   redeployCmd.run();
 }
 
@@ -40,10 +35,6 @@ export async function redeployCleanup(node?: ClabLabTreeNode) {
     }
   }
 
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: "Redeploying Lab (cleanup)... ",
-    successMsg: "Lab redeployed (cleanup) successfully!"
-  };
-  const redeployCmd = new ClabCommand("redeploy", node, spinnerMessages);
+  const redeployCmd = new ClabCommand("redeploy", node);
   redeployCmd.run(["-c"]);
 }

src/commands/save.ts

@@ -1,6 +1,5 @@
 // src/commands/save.ts
 import * as vscode from "vscode";
-import { SpinnerMsg } from "./command";
 import { ClabCommand } from "./clabCommand";
 import { ClabLabTreeNode, ClabContainerTreeNode } from "../treeView/common";
 import * as path from "path";
@@ -20,14 +19,8 @@ export async function saveLab(node: ClabLabTreeNode) {
     return;
   }
 
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: `Saving lab configuration for ${node.label}...`,
-    successMsg: `Lab configuration for ${node.label} saved successfully!`,
-    failMsg: `Could not save lab configuration for ${node.label}`
-  };
-
   // Create a ClabCommand for "save" using the lab node.
-  const saveCmd = new ClabCommand("save", node, spinnerMessages);
+  const saveCmd = new ClabCommand("save", node);
   // ClabCommand automatically appends "-t <labPath>".
   saveCmd.run();
 }
@@ -50,12 +43,6 @@ export async function saveNode(node: ClabContainerTreeNode) {
   // Extract the short node name by removing the "clab-{labname}-" prefix
   const shortNodeName = node.name.replace(/^clab-[^-]+-/, '');
 
-  const spinnerMessages: SpinnerMsg = {
-    progressMsg: `Saving configuration for node ${shortNodeName}...`,
-    successMsg: `Configuration for node ${shortNodeName} saved successfully!`,
-    failMsg: `Could not save configuration for node ${shortNodeName}`
-  };
-
   const tempLabNode = new ClabLabTreeNode(
     path.basename(node.labPath.absolute),
     vscode.TreeItemCollapsibleState.None,
@@ -66,7 +53,7 @@ export async function saveNode(node: ClabContainerTreeNode) {
     "containerlabLabDeployed"
   );
 
-  const saveCmd = new ClabCommand("save", tempLabNode, spinnerMessages);
+  const saveCmd = new ClabCommand("save", tempLabNode);
   // Use --node-filter instead of -n and use the short name
   saveCmd.run(["--node-filter", shortNodeName]);
 }

test/unit/commands/clabCommand.test.ts

@@ -61,7 +61,7 @@ describe('ClabCommand', () => {
       vscodeStub.TreeItemCollapsibleState.None,
       { absolute: '/tmp/lab.yml', relative: 'lab.yml' }
     );
-    const clab = new ClabCommand('deploy', node, undefined, true, 'term');
+    const clab = new ClabCommand('deploy', node);
     await clab.run(['--foo']);
 
     expect(cmdStub.instances).to.have.lengthOf(1);