Switch to Microsoft.PowerShell.Archive for help tests for smaller artifact size.

Author: JustinGrote

PowerShellEditorServices.build.ps1

@@ -195,10 +195,10 @@ Task BuildCmdletHelp -After AssembleModule {
 Task SetupHelpForTests {
     # Some CI do not ship with help included, and the secure devops pipeline also does not allow internet access, so we must update help from our local repository source.
 
-    # Only commands in Microsoft.PowerShell.Utility can be tested for help so as to minimize the repository storage.
+    # Only commands in Microsoft.PowerShell.Archive can be tested for help so as to minimize the repository storage.
     # This requires admin rights for PS5.1
 
-    #NOTE: You can run this task once as admin or update help separately, and continue to run tests as non-admin, if for instance developing locally. Also this help is for PS5.1 so tests should be written for that even if PS7. For instance, don't write tests for new Invoke-RestMethod parameters.
+    #NOTE: You can run this task once as admin or update help separately, and continue to run tests as non-admin, if for instance developing locally.
 
     $installHelpScript = {
         param(
@@ -211,8 +211,8 @@ Task SetupHelpForTests {
             $helpPath = Join-Path $helpPath '7'
         }
 
-        if ((Get-Help Invoke-RestMethod).remarks -notlike 'Get-Help cannot find the Help files*') {
-            Write-Host -Fore Green "PowerShell $PSVersion Utility Help is already installed"
+        if ((Get-Help Expand-Archive).remarks -notlike 'Get-Help cannot find the Help files*') {
+            Write-Host -Fore Green "PowerShell $PSVersion Archive Help is already installed"
             return
         }
 
@@ -227,10 +227,10 @@ Task SetupHelpForTests {
             }
         }
 
-        Write-Host -Fore Magenta "Powershell $PSVersion Utility Help is not installed, installing from $helpPath"
+        Write-Host -Fore Magenta "Powershell $PSVersion Archive Help is not installed, installing from $helpPath"
 
         $updateHelpParams = @{
-            Module     = 'Microsoft.PowerShell.Utility'
+            Module     = 'Microsoft.PowerShell.Archive'
             SourcePath = $helpPath
             UICulture  = 'en-US'
             Force      = $true
@@ -244,10 +244,10 @@ Task SetupHelpForTests {
         #Update the help, and capture verbose output
         $updateHelpOutput = Update-Help @updateHelpParams *>&1
 
-        if ((Get-Help Invoke-RestMethod).remarks -like 'Get-Help cannot find the Help files*') {
+        if ((Get-Help Expand-Archive).remarks -like 'Get-Help cannot find the Help files*') {
             throw "Failed to install PowerShell $PSVersion Help: $updateHelpOutput"
         } else {
-            Write-Host -Fore Green "Powershell $PSVersion Utility Help installed successfully"
+            Write-Host -Fore Green "Powershell $PSVersion Archive Help installed successfully"
         }
     }
 

test/PowerShellEditorServices.Test.E2E/LanguageServerProtocolMessageTests.cs

@@ -30,6 +30,8 @@ public class LanguageServerProtocolMessageTests : IClassFixture<LSPTestsFixture>
     {
         private static readonly string s_binDir =
             Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
+        private const string testCommand = "Expand-Archive";
+        private const string testDescription = "Extracts files from a specified archive (zipped) file.";
 
         private readonly ILanguageClient PsesLanguageClient;
         private readonly List<LogMessageParams> Messages;
@@ -1054,32 +1056,54 @@ public async Task CanSendCompletionAndCompletionResolveRequestAsync()
         [Fact]
         public async Task CanSendCompletionResolveWithModulePrefixRequestAsync()
         {
-            string filePath = NewTestFile("Get-TestDate");
+            await PsesLanguageClient
+            .SendRequest(
+                "evaluate",
+                new EvaluateRequestArguments
+                {
+                    Expression = "Import-Module Microsoft.PowerShell.Archive -Prefix Test"
+                })
+            .ReturningVoid(CancellationToken.None);
 
-            CompletionList completionItems = await PsesLanguageClient.TextDocument.RequestCompletion(
+            try
+            {
+                const string command = "Expand-TestArchive";
+
+                CompletionList completionItems = await PsesLanguageClient.TextDocument.RequestCompletion(
                 new CompletionParams
                 {
                     TextDocument = new TextDocumentIdentifier
                     {
-                        Uri = DocumentUri.FromFileSystemPath(filePath)
+                        Uri = DocumentUri.FromFileSystemPath(NewTestFile(command))
                     },
                     Position = new Position(line: 0, character: 12)
                 });
 
-            CompletionItem completionItem = Assert.Single(completionItems,
-                completionItem1 => completionItem1.Label == "Get-TestDate");
+                CompletionItem completionItem = Assert.Single(completionItems,
+                    completionItem1 => completionItem1.Label == command);
 
-            CompletionItem updatedCompletionItem = await PsesLanguageClient.ResolveCompletion(completionItem);
+                CompletionItem updatedCompletionItem = await PsesLanguageClient.ResolveCompletion(completionItem);
 
-            Assert.Contains("Gets the current date and time.", updatedCompletionItem.Documentation.String);
+                Assert.Contains(testDescription, updatedCompletionItem.Documentation.String);
+            }
+            finally
+            {
+                // Reset the Archive module to the non-prefixed version
+                await PsesLanguageClient
+                .SendRequest(
+                    "evaluate",
+                    new EvaluateRequestArguments
+                    {
+                        Expression = "Remove-Module Microsoft.PowerShell.Archive;Import-Module Microsoft.PowerShell.Archive -Force"
+                    })
+                .ReturningVoid(CancellationToken.None);
+            }
         }
 
         [SkippableFact]
         public async Task CanSendHoverRequestAsync()
         {
-            Skip.If(OperatingSystem.IsWindows(),
-                "TODO: Fails in Windows GHA but works locally for some reason.");
-            string filePath = NewTestFile("Write-Host");
+            string filePath = NewTestFile(testCommand);
 
             Hover hover = await PsesLanguageClient.TextDocument.RequestHover(
                 new HoverParams
@@ -1093,11 +1117,11 @@ public async Task CanSendHoverRequestAsync()
 
             Assert.True(hover.Contents.HasMarkedStrings);
             Assert.Collection(hover.Contents.MarkedStrings,
-                str1 => Assert.Equal("Write-Host", str1.Value),
+                str1 => Assert.Equal(testCommand, str1.Value),
                 str2 =>
                 {
                     Assert.Equal("markdown", str2.Language);
-                    Assert.Equal("Writes customized output to a host.", str2.Value);
+                    Assert.Equal(testDescription, str2.Value);
                 });
         }