migrate containerlab calls to custom bin path

Author: kaelemc

src/commands/clabCommand.ts

@@ -1,6 +1,7 @@
 import * as vscode from "vscode";
 import * as cmd from './command';
 import { ClabLabTreeNode } from "../treeView/common";
+import { containerlabBinaryPath } from "../extension";
 /**
  * A helper class to build a 'containerlab' command (with optional sudo, etc.)
  * and run it either in the Output channel or in a Terminal.
@@ -22,13 +23,13 @@ export class ClabCommand extends cmd.Command {
         let options: cmd.CmdOptions;
         if (useTerminal) {
             options = {
-                command: "containerlab",
+                command: containerlabBinaryPath,
                 useSpinner: false,
                 terminalName: terminalName || "Containerlab",
             };
         } else {
             options = {
-                command: "containerlab",
+                command: containerlabBinaryPath,
                 useSpinner: true,
                 spinnerMsg: spinnerMsg || {
                     progressMsg: `Running ${action}...`,

src/commands/gottyShare.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 import { ClabLabTreeNode } from "../treeView/common";
-import { outputChannel, gottySessions, runningLabsProvider, refreshGottySessions } from "../extension";
+import { outputChannel, gottySessions, runningLabsProvider, refreshGottySessions, containerlabBinaryPath } from "../extension";
 import { getHostname } from "./capture";
 import { runWithSudo } from "../helpers/utils";
 
@@ -56,7 +56,7 @@ async function gottyStart(action: "attach" | "reattach", node: ClabLabTreeNode)
   }
   try {
     const port = vscode.workspace.getConfiguration('containerlab').get<number>('gotty.port', 8080);
-    const out = await runWithSudo(`containerlab tools gotty ${action} -l ${node.name} --port ${port}`, `GoTTY ${action}`, outputChannel, 'containerlab', true, true) as string;
+    const out = await runWithSudo(`${containerlabBinaryPath} tools gotty ${action} -l ${node.name} --port ${port}`, `GoTTY ${action}`, outputChannel, 'containerlab', true, true) as string;
     const link = await parseGottyLink(out || '');
     if (link) {
       gottySessions.set(node.name, link);
@@ -90,7 +90,7 @@ export async function gottyDetach(node: ClabLabTreeNode) {
     return;
   }
   try {
-    await runWithSudo(`containerlab tools gotty detach -l ${node.name}`, 'GoTTY detach', outputChannel, 'containerlab');
+    await runWithSudo(`${containerlabBinaryPath} tools gotty detach -l ${node.name}`, 'GoTTY detach', outputChannel, 'containerlab');
     gottySessions.delete(node.name);
     vscode.window.showInformationMessage('GoTTY session detached');
   } catch (err: any) {

src/commands/impairments.ts

@@ -3,6 +3,7 @@ import * as vscode from "vscode";
 import * as utils from "../helpers/utils";
 import { ClabInterfaceTreeNode } from "../treeView/common";
 import { execCommandInOutput } from "./command";
+import { containerlabBinaryPath } from "../extension";
 
 // Common validation messages and patterns
 const ERR_EMPTY = 'Input should not be empty';
@@ -23,7 +24,7 @@ async function setImpairment(node: ClabInterfaceTreeNode, impairment?: string, v
   }
   const impairmentFlag = impairment ? `--${impairment}` : undefined;
   if (impairment && !value) { return; }
-  const cmd = `${utils.getSudo()}containerlab tools netem set --node ${node.parentName} --interface ${node.name} ${impairmentFlag} ${value}`;
+  const cmd = `${utils.getSudo()}${containerlabBinaryPath} tools netem set --node ${node.parentName} --interface ${node.name} ${impairmentFlag} ${value}`;
   const msg = `set ${impairment} to ${value} for ${node.name} on ${node.parentName}.`;
   vscode.window.showInformationMessage(`Attempting to ${msg}`);
   execCommandInOutput(cmd, false,

src/commands/nodeImpairments.ts

@@ -2,7 +2,7 @@ import * as vscode from "vscode";
 import { ClabContainerTreeNode } from "../treeView/common";
 import { getNodeImpairmentsHtml } from "../webview/nodeImpairmentsHtml";
 import { runWithSudo } from "../helpers/utils";
-import { outputChannel } from "../extension";
+import { outputChannel, containerlabBinaryPath } from "../extension";
 
 type NetemFields = {
   delay: string;
@@ -74,7 +74,7 @@ function ensureDefaults(map: Record<string, NetemFields>, node: ClabContainerTre
 async function refreshNetemSettings(node: ClabContainerTreeNode): Promise<Record<string, NetemFields>> {
   const config = vscode.workspace.getConfiguration("containerlab");
   const runtime = config.get<string>("runtime", "docker");
-  const showCmd = `containerlab tools -r ${runtime} netem show -n ${node.name} --format json`;
+  const showCmd = `${containerlabBinaryPath} tools -r ${runtime} netem show -n ${node.name} --format json`;
   let netemMap: Record<string, NetemFields> = {};
 
   try {
@@ -143,7 +143,7 @@ async function applyNetem(
   for (const [intfName, fields] of Object.entries(netemData)) {
     const netemArgs = buildNetemArgs(fields as Record<string, string>);
     if (netemArgs.length > 0) {
-      const cmd = `containerlab tools netem set -n ${node.name} -i ${intfName} ${netemArgs.join(" ")} > /dev/null 2>&1`;
+      const cmd = `${containerlabBinaryPath} tools netem set -n ${node.name} -i ${intfName} ${netemArgs.join(" ")} > /dev/null 2>&1`;
       ops.push(
         runWithSudo(
           cmd,
@@ -179,7 +179,7 @@ async function clearNetem(
       continue;
     }
     const cmd =
-      `containerlab tools netem set -n ${node.name} -i ${norm} --delay 0s --jitter 0s --loss 0 --rate 0 --corruption 0.0000000000000001 > /dev/null 2>&1`;
+      `${containerlabBinaryPath} tools netem set -n ${node.name} -i ${norm} --delay 0s --jitter 0s --loss 0 --rate 0 --corruption 0.0000000000000001 > /dev/null 2>&1`;
     ops.push(
       runWithSudo(
         cmd,

src/commands/sshxShare.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 import { ClabLabTreeNode } from "../treeView/common";
-import { outputChannel, sshxSessions, runningLabsProvider, refreshSshxSessions } from "../extension";
+import { outputChannel, sshxSessions, runningLabsProvider, refreshSshxSessions, containerlabBinaryPath } from "../extension";
 import { runWithSudo } from "../helpers/utils";
 
 function parseLink(output: string): string | undefined {
@@ -15,7 +15,7 @@ async function sshxStart(action: "attach" | "reattach", node: ClabLabTreeNode) {
     return;
   }
   try {
-    const out = await runWithSudo(`containerlab tools sshx ${action} -l ${node.name}`, `SSHX ${action}`, outputChannel, 'containerlab', true, true) as string;
+    const out = await runWithSudo(`${containerlabBinaryPath} tools sshx ${action} -l ${node.name}`, `SSHX ${action}`, outputChannel, 'containerlab', true, true) as string;
     const link = parseLink(out || '');
     if (link) {
       sshxSessions.set(node.name, link);
@@ -49,7 +49,7 @@ export async function sshxDetach(node: ClabLabTreeNode) {
     return;
   }
   try {
-    await runWithSudo(`containerlab tools sshx detach -l ${node.name}`, 'SSHX detach', outputChannel);
+    await runWithSudo(`${containerlabBinaryPath} tools sshx detach -l ${node.name}`, 'SSHX detach', outputChannel);
     sshxSessions.delete(node.name);
     vscode.window.showInformationMessage('SSHX session detached');
   } catch (err: any) {

src/extension.ts

@@ -392,6 +392,7 @@ function setClabBinPath(): boolean {
   // if empty fall back to resolving from PATH
   if (!configPath || configPath.trim() === '') {
     try {
+      // eslint-disable-next-line sonarjs/no-os-command-from-path
       const stdout = execSync('which containerlab', { encoding: 'utf-8' });
       const resolvedPath = stdout.trim();
       if (resolvedPath) {
@@ -400,7 +401,7 @@ function setClabBinPath(): boolean {
         return true;
       }
     } catch (err) {
-      outputChannel.warn('Could not resolve containerlab bin path from sys PATH');
+      outputChannel.warn(`Could not resolve containerlab bin path from sys PATH: ${err}`);
     }
     containerlabBinaryPath = 'containerlab';
     return true;
@@ -414,7 +415,7 @@ function setClabBinPath(): boolean {
     return true;
   } catch (err) {
     // Path is invalid or not executable - try to resolve from PATH as fallback
-    outputChannel.error(`Invalid containerlab.binaryPath setting: "${configPath}" is not a valid executable.`);
+    outputChannel.error(`Invalid containerlab.binaryPath "${configPath}": ${err}`);
     vscode.window.showErrorMessage(
       `Configured containerlab binary path "${configPath}" is invalid or not executable.`
     );

src/helpers/utils.ts

@@ -6,6 +6,7 @@ import { exec } from "child_process";
 import * as net from "net";
 import { promisify } from "util";
 import { ClabLabTreeNode } from "../treeView/common";
+import { containerlabBinaryPath } from "../extension";
 
 const execAsync = promisify(exec);
 
@@ -207,7 +208,7 @@ async function tryRunAsGroupMember(
 async function hasPasswordlessSudo(checkType: 'generic' | 'containerlab' | 'docker'): Promise<boolean> {
   let checkCommand: string;
   if (checkType === 'containerlab') {
-    checkCommand = "sudo -n containerlab version >/dev/null 2>&1 && echo true || echo false";
+    checkCommand = `sudo -n ${containerlabBinaryPath} version >/dev/null 2>&1 && echo true || echo false`;
   } else if (checkType === 'docker') {
     checkCommand = "sudo -n docker ps >/dev/null 2>&1 && echo true || echo false";
   } else {
@@ -410,10 +411,10 @@ export async function checkAndUpdateClabIfNeeded(
   context: vscode.ExtensionContext
 ): Promise<void> {
   try {
-    log('Running "containerlab version check".', outputChannel);
+    log(`Running "${containerlabBinaryPath} version check".`, outputChannel);
     // Run the version check via runWithSudo and capture output.
     const versionOutputRaw = await runWithSudo(
-      'containerlab version check',
+      `${containerlabBinaryPath} version check`,
       'containerlab version check',
       outputChannel,
       'containerlab',
@@ -436,7 +437,7 @@ export async function checkAndUpdateClabIfNeeded(
       context.subscriptions.push(
         vscode.commands.registerCommand(updateCommandId, async () => {
           try {
-            await runWithSudo('containerlab version upgrade', 'Upgrading containerlab', outputChannel, 'generic');
+            await runWithSudo(`${containerlabBinaryPath} version upgrade`, 'Upgrading containerlab', outputChannel, 'generic');
             vscode.window.showInformationMessage('Containerlab updated successfully!');
             log('Containerlab updated successfully.', outputChannel);
           } catch (err: any) {

src/services/containerlabEvents.ts

@@ -1,9 +1,9 @@
 import { spawn, ChildProcess } from "child_process";
-import * as fs from "fs";
 import * as readline from "readline";
 import * as utils from "../helpers/utils";
 import type { ClabDetailedJSON } from "../treeView/common";
 import type { ClabInterfaceSnapshot, ClabInterfaceSnapshotEntry } from "../types/containerlab";
+import { containerlabBinaryPath } from "../extension";
 
 interface ContainerlabEvent {
     timestamp?: string;
@@ -249,25 +249,6 @@ function scheduleDataChanged(): void {
     }, DATA_NOTIFY_DELAY_MS);
 }
 
-function findContainerlabBinary(): string {
-    const candidateBins = [
-        "/usr/bin/containerlab",
-        "/usr/local/bin/containerlab",
-        "/bin/containerlab",
-    ];
-
-    for (const candidate of candidateBins) {
-        try {
-            if (fs.existsSync(candidate)) {
-                return candidate;
-            }
-        } catch {
-            // ignore filesystem errors and continue searching
-        }
-    }
-    return "containerlab";
-}
-
 function scheduleInitialResolution(): void {
     if (initialLoadComplete) {
         return;
@@ -963,7 +944,7 @@ function startProcess(runtime: string): void {
     });
 
     const sudo = utils.getSudo().trim();
-    const containerlabBinary = findContainerlabBinary();
+    const containerlabBinary = containerlabBinaryPath
     const baseArgs = ["events", "--format", "json", "--initial-state"];
     if (runtime) {
         baseArgs.splice(1, 0, "-r", runtime);