Deprecate WMIC in favor of Get-CimInstance (#8329)

* use `Get-CimInstance` to retrieve processes

* Add unit test

* Fix bugs

* Parse JSON output

Author: eternalphane

Extension/src/Debugger/nativeAttach.ts

@@ -8,6 +8,7 @@ import * as os from 'os';
 import { AttachItemsProvider } from './attachToProcess';
 import { AttachItem } from './attachQuickPick';
 import * as nls from 'vscode-nls';
+import { findPowerShell } from '../common';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
@@ -28,7 +29,8 @@ export class Process {
 export class NativeAttachItemsProviderFactory {
     static Get(): AttachItemsProvider {
         if (os.platform() === 'win32') {
-            return new WmicAttachItemsProvider();
+            const pwsh: string | undefined = findPowerShell();
+            return pwsh ? new CimAttachItemsProvider(pwsh) : new WmicAttachItemsProvider();
         } else {
             return new PsAttachItemsProvider();
         }
@@ -254,3 +256,43 @@ export class WmicProcessParser {
         }
     }
 }
+
+export class CimAttachItemsProvider extends NativeAttachItemsProvider {
+    constructor(private pwsh: string) { super(); }
+
+    // Perf numbers on Win10:
+    // TODO
+
+    protected async getInternalProcessEntries(): Promise<Process[]> {
+        const pwshCommand: string = `${this.pwsh} -NoProfile -Command`;
+        const cimCommand: string = 'Get-CimInstance Win32_Process | Select-Object Name,ProcessId,CommandLine | ConvertTo-JSON';
+        const processes: string = await execChildProcess(`${pwshCommand} "${cimCommand}"`, undefined);
+        return CimProcessParser.ParseProcessFromCim(processes);
+    }
+}
+
+type CimProcessInfo = {
+    Name: string;
+    ProcessId: number;
+    CommandLine: string | null;
+};
+
+export class CimProcessParser {
+    private static get extendedLengthPathPrefix(): string { return '\\\\?\\'; }
+    private static get ntObjectManagerPathPrefix(): string { return '\\??\\'; }
+
+    // Only public for tests.
+    public static ParseProcessFromCim(processes: string): Process[] {
+        const processInfos: CimProcessInfo[] = JSON.parse(processes);
+        return processInfos.map(info => {
+            let cmdline: string | undefined = info.CommandLine || undefined;
+            if (cmdline?.startsWith(this.extendedLengthPathPrefix)) {
+                cmdline = cmdline.slice(this.extendedLengthPathPrefix.length);
+            }
+            if (cmdline?.startsWith(this.ntObjectManagerPathPrefix)) {
+                cmdline = cmdline.slice(this.ntObjectManagerPathPrefix.length);
+            }
+            return new Process(info.Name, `${info.ProcessId}`, cmdline);
+        });
+    }
+}

Extension/src/common.ts

@@ -1327,3 +1327,24 @@ export function normalizeArg(arg: string): string {
     }
 }
 
+/**
+ * Find PowerShell executable from PATH (for Windows only).
+ */
+export function findPowerShell(): string | undefined {
+    const dirs: string[] = (process.env.PATH || '').replace(/"+/g, '').split(';').filter(x => x);
+    const exts: string[] = (process.env.PATHEXT || '').split(';');
+    const names: string[] = ['pwsh', 'powershell'];
+    for (const name of names) {
+        const candidates: string[] = dirs.reduce<string[]>((paths, dir) => [
+            ...paths, ...exts.map(ext => path.join(dir, name + ext))
+        ], []);
+        for (const candidate of candidates) {
+            try {
+                if (fs.statSync(candidate).isFile()) {
+                    return name;
+                }
+            } catch (e) {
+            }
+        }
+    }
+}

Extension/test/unitTests/extension.test.ts

@@ -6,7 +6,7 @@
 import * as assert from 'assert';
 import * as os from 'os';
 import { LinuxDistribution } from '../../src/linuxDistribution';
-import { Process, WmicProcessParser, PsProcessParser } from '../../src/Debugger/nativeAttach';
+import { Process, WmicProcessParser, PsProcessParser, CimProcessParser } from '../../src/Debugger/nativeAttach';
 
 suite("LinuxDistro Tests", () => {
     test("Parse valid os-release file", () => {
@@ -125,4 +125,53 @@ suite("Pick Process Tests", () => {
         assert.equal(process2.name, 'mdworker');
         assert.equal(process2.pid, '15220');
     });
+
+    test('Parse valid CIM output', () => {
+        // output from the command used in CimAttachItemsProvider
+        const cimOutput: string = String.raw`[
+  {
+    "Name": "System Idle Process",
+    "ProcessId": 0,
+    "CommandLine": null
+  },
+  {
+    "Name": "WindowsTerminal.exe",
+    "ProcessId": 5112,
+    "CommandLine": "\"C:\\Program Files\\WindowsApps\\Microsoft.WindowsTerminalPreview_1.12.2931.0_x64__8wekyb3d8bbwe\\WindowsTerminal.exe\""
+  },
+  {
+    "Name": "conhost.exe",
+    "ProcessId": 34560,
+    "CommandLine": "\\\\?\\C:\\WINDOWS\\system32\\conhost.exe --headless --width 80 --height 30 --signal 0x8e0 --server 0x824"
+  },
+  {
+    "Name": "conhost.exe",
+    "ProcessId": 33732,
+    "CommandLine": "\\??\\C:\\WINDOWS\\system32\\conhost.exe 0x4"
+  }
+]`;
+
+        const parsedOutput: Process[] = CimProcessParser.ParseProcessFromCim(cimOutput);
+
+        const process1: Process = parsedOutput[0];
+        const process2: Process = parsedOutput[1];
+        const process3: Process = parsedOutput[2];
+        const process4: Process = parsedOutput[3];
+
+        assert.equal(process1.commandLine, undefined);
+        assert.equal(process1.name, 'System Idle Process');
+        assert.equal(process1.pid, '0');
+
+        assert.equal(process2.commandLine, '"C:\\Program Files\\WindowsApps\\Microsoft.WindowsTerminalPreview_1.12.2931.0_x64__8wekyb3d8bbwe\\WindowsTerminal.exe"');
+        assert.equal(process2.name, 'WindowsTerminal.exe');
+        assert.equal(process2.pid, '5112');
+
+        assert.equal(process3.commandLine, 'C:\\WINDOWS\\system32\\conhost.exe --headless --width 80 --height 30 --signal 0x8e0 --server 0x824');
+        assert.equal(process3.name, 'conhost.exe');
+        assert.equal(process3.pid, '34560');
+
+        assert.equal(process4.commandLine, 'C:\\WINDOWS\\system32\\conhost.exe 0x4');
+        assert.equal(process4.name, 'conhost.exe');
+        assert.equal(process4.pid, '33732');
+    });
 });