Migrate Pester version detection into an InovkePester stub script

Author: rkeithhill

InvokePesterStub.ps1

@@ -0,0 +1,62 @@
+#!/usr/bin/env pwsh
+
+<#
+.SYNOPSIS
+    Stub around Invoke-Pester command used by VSCode PowerShell extension.
+.DESCRIPTION
+    Stub around Invoke-Pester command used by VSCode PowerShell extension.
+    The stub checks the version of Pester and if >= 4.6.0, invokes Pester
+    using the LineNumber parameter (if specified). Otherwise, it invokes
+    using the TestName parameter (if specified).
+.EXAMPLE
+    PS C:\> .\InvokePesterStub.ps1 ~\project\test\foo.tests.ps1 -LineNumber 14
+    Invokes a specific test by line number in the specified file.
+.EXAMPLE
+    PS C:\> .\InvokePesterStub.ps1 ~\project\test\foo.tests.ps1 -TestName 'Foo Tests'
+    Invokes a specific test by test name in the specified file.
+.EXAMPLE
+    PS C:\> .\InvokePesterStub.ps1 ~\project\test\foo.tests.ps1
+    Invokes all tests in the specified file.
+.INPUTS
+    None
+.OUTPUTS
+    None
+#>
+param(
+    # Specifies the path to the test script.
+    [Parameter(Position=0, Mandatory)]
+    [ValidateNotNullOrEmpty()]
+    [string]
+    $ScriptPath,
+
+    # Specifies the name of the test taken from the Describe block's name.
+    [Parameter()]
+    [string]
+    $TestName,
+
+    # Specifies the starting line number of the DescribeBlock.  This feature requires
+    # Pester 4.6.0 or higher.
+    [Parameter()]
+    [ValidatePattern('\d*')]
+    [string]
+    $LineNumber
+)
+
+try {
+    $pesterVersion = (Microsoft.PowerShell.Core\Get-Command Invoke-Pester -ErrorAction Stop).Version
+    if (($pesterVersion -ge '4.6.0') -and ($LineNumber -match '\d+')) {
+        $pesterOption = New-PesterOption -ScriptBlockFilter @(
+            @{ IncludeVSCodeMarker=$true; Line=$LineNumber; Path=$ScriptPath } )
+        Invoke-Pester -Script $ScriptPath -PesterOption $pesterOption
+    }
+    elseif ($TestName) {
+        Invoke-Pester -Script $ScriptPath -PesterOption @{ IncludeVSCodeMarker=$true } -TestName $TestName
+    }
+    else {
+        Invoke-Pester -Script $ScriptPath -PesterOption @{IncludeVSCodeMarker=$true}
+    }
+}
+catch [System.Management.Automation.CommandNotFoundException] {
+    Write-Warning "You must install Pester to run or debug Pester Tests. You can install Pester by executing:"
+    Write-Warning "Install-Module Pester -Scope CurrentUser -Force"
+}

src/features/PesterTests.ts

@@ -18,8 +18,11 @@ export class PesterTestsFeature implements IFeature {
 
     private command: vscode.Disposable;
     private languageClient: LanguageClient;
+    private invokePesterStubScriptPath: string;
 
     constructor(private sessionManager: SessionManager) {
+        this.invokePesterStubScriptPath = path.resolve(__dirname, "../../../InvokePesterStub.ps1");
+
         // File context-menu command - Run Pester Tests
         this.command = vscode.commands.registerCommand(
             "PowerShell.RunPesterTestsFromFile",
@@ -35,8 +38,8 @@ export class PesterTestsFeature implements IFeature {
         // This command is provided for usage by PowerShellEditorServices (PSES) only
         this.command = vscode.commands.registerCommand(
             "PowerShell.RunPesterTests",
-            (uriString, runInDebugger, describeBlockName?) => {
-                this.launchTests(uriString, runInDebugger, describeBlockName);
+            (uriString, runInDebugger, describeBlockName?, describeBlockLineNumber?) => {
+                this.launchTests(uriString, runInDebugger, describeBlockName, describeBlockLineNumber);
             });
     }
 
@@ -54,7 +57,7 @@ export class PesterTestsFeature implements IFeature {
         this.launch(launchConfig);
     }
 
-    private async launchTests(uriString: string, runInDebugger: boolean, describeBlockName?: string) {
+    private async launchTests(uriString: string, runInDebugger: boolean, describeBlockName?: string, lineNum?: number) {
         // PSES passes null for the describeBlockName to signal that it can't evaluate the TestName.
         if (!describeBlockName) {
             const answer = await vscode.window.showErrorMessage(
@@ -68,21 +71,11 @@ export class PesterTestsFeature implements IFeature {
         }
 
         const launchType = runInDebugger ? LaunchType.Debug : LaunchType.Run;
-        const launchConfig = this.createLaunchConfig(uriString, launchType);
-
-        if (describeBlockName) {
-            launchConfig.args.push("-TestName");
-            // Escape single quotes inside double quotes by doubling them up
-            if (describeBlockName.includes("'")) {
-                describeBlockName = describeBlockName.replace(/'/g, "''");
-            }
-            launchConfig.args.push(`'${describeBlockName}'`);
-        }
-
+        const launchConfig = this.createLaunchConfig(uriString, launchType, describeBlockName, lineNum);
         this.launch(launchConfig);
     }
 
-    private createLaunchConfig(uriString: string, launchType: LaunchType) {
+    private createLaunchConfig(uriString: string, launchType: LaunchType, testName?: string, lineNum?: number) {
         const uri = vscode.Uri.parse(uriString);
         const currentDocument = vscode.window.activeTextEditor.document;
         const settings = Settings.load();
@@ -95,12 +88,10 @@ export class PesterTestsFeature implements IFeature {
             request: "launch",
             type: "PowerShell",
             name: "PowerShell Launch Pester Tests",
-            script: "Invoke-Pester",
+            script: this.invokePesterStubScriptPath,
             args: [
-                "-Script",
+                "-ScriptPath",
                 `'${scriptPath}'`,
-                "-PesterOption",
-                "@{IncludeVSCodeMarker=$true}",
             ],
             internalConsoleOptions: "neverOpen",
             noDebug: (launchType === LaunchType.Run),
@@ -111,6 +102,19 @@ export class PesterTestsFeature implements IFeature {
                     : path.dirname(currentDocument.fileName),
         };
 
+        if (lineNum) {
+            launchConfig.args.push("-LineNumber", `${lineNum}`);
+        }
+
+        if (testName) {
+            // Escape single quotes inside double quotes by doubling them up
+            if (testName.includes("'")) {
+                testName = testName.replace(/'/g, "''");
+            }
+
+            launchConfig.args.push("-TestName", `'${testName}'`);
+        }
+
         return launchConfig;
     }