Support Run/Debug tests in PSKoans files (#1988)

Code Lens feature only depends on Pester symbols,
so we only need to make sure they appear for `*.koans.ps1` files

Author: fflaten

module/PowerShellEditorServices/InvokePesterStub.ps1

@@ -59,10 +59,24 @@ param(
     [string] $OutputPath
 )
 
-$pesterModule = Microsoft.PowerShell.Core\Get-Module Pester
 # add one line, so the subsequent output is not shifted to the side
 Write-Output ''
 
+# checking and importing PSKoans first as it will import the required Pester-version (v4 vs v5)
+if ($ScriptPath -match '\.Koans\.ps1$') {
+    $psKoansModule = Microsoft.PowerShell.Core\Get-Module PSKoans
+    if (!$psKoansModule) {
+        Write-Output "Importing PSKoans module..."
+        $psKoansModule = Microsoft.PowerShell.Core\Import-Module PSKoans -ErrorAction Ignore -PassThru
+    }
+
+    if (!$psKoansModule) {
+        Write-Warning "Failed to import PSKoans. You must install PSKoans module to run or debug tests in *.Koans.ps1 files."
+        return
+    }
+}
+
+$pesterModule = Microsoft.PowerShell.Core\Get-Module Pester
 if (!$pesterModule) {
     Write-Output "Importing Pester module..."
     if ($MinimumVersion5) {

src/PowerShellEditorServices/Services/Symbols/PesterDocumentSymbolProvider.cs

@@ -20,9 +20,8 @@ internal class PesterDocumentSymbolProvider : IDocumentSymbolProvider
         IEnumerable<SymbolReference> IDocumentSymbolProvider.ProvideDocumentSymbols(
             ScriptFile scriptFile)
         {
-            if (!scriptFile.FilePath.EndsWith(
-                    "tests.ps1",
-                    StringComparison.OrdinalIgnoreCase))
+            if (!scriptFile.FilePath.EndsWith(".tests.ps1", StringComparison.OrdinalIgnoreCase) &&
+                !scriptFile.FilePath.EndsWith(".Koans.ps1", StringComparison.OrdinalIgnoreCase))
             {
                 return Enumerable.Empty<SymbolReference>();
             }

test/PowerShellEditorServices.Test.Shared/Symbols/FindSymbolsInPSKoansFile.cs

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.PowerShell.EditorServices.Services.TextDocument;
+
+namespace Microsoft.PowerShell.EditorServices.Test.Shared.Symbols
+{
+    public static class FindSymbolsInPSKoansFile
+    {
+        public static readonly ScriptRegion SourceDetails =
+            new(
+                file: TestUtilities.NormalizePath("Symbols/PesterFile.Koans.ps1"),
+                text: string.Empty,
+                startLineNumber: 0,
+                startColumnNumber: 0,
+                startOffset: 0,
+                endLineNumber: 0,
+                endColumnNumber: 0,
+                endOffset: 0);
+    }
+}

test/PowerShellEditorServices.Test.Shared/Symbols/PesterFile.Koans.ps1

@@ -0,0 +1,23 @@
+Describe "Testing Pester symbols in a PSKoans-file" {
+    Context "Simple demo" {
+        BeforeAll {
+
+        }
+
+        BeforeEach {
+
+        }
+
+        It "Should return Pester symbols" {
+
+        }
+
+        AfterEach {
+
+        }
+    }
+
+    AfterAll {
+
+    }
+}

test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs

@@ -890,6 +890,15 @@ public void FindsSymbolsInPesterFile()
             Assert.Equal(5, symbol.ScriptRegion.StartColumnNumber);
         }
 
+        [Fact]
+        public void FindsSymbolsInPSKoansFile()
+        {
+            IEnumerable<PesterSymbolReference> symbols = FindSymbolsInFile(FindSymbolsInPSKoansFile.SourceDetails).OfType<PesterSymbolReference>();
+
+            // Pester symbols are properly tested in FindsSymbolsInPesterFile so only counting to make sure they appear
+            Assert.Equal(7, symbols.Count(i => i.Type == SymbolType.Function));
+        }
+
         [Fact]
         public void FindsSymbolsInPSDFile()
         {