Expand help update to all potential pwsh versions

Author: JustinGrote

PowerShellEditorServices.build.ps1

@@ -193,49 +193,84 @@ Task BuildCmdletHelp -After AssembleModule {
 }
 
 Task SetupHelpForTests {
-    # Powershell 7+ ship with help included, but 5.1 does not on Windows Servers and CI. The secure devops pipeline also does not allow internet access, so we must update help from our local repository source.
+    # 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.
-    # This requires admin rights
+    # 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.
+    #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.
 
     $installHelpScript = {
+        $PSVersion = $PSVersionTable.PSVersion
         $ErrorActionPreference = 'Stop'
         if ((Get-Help Invoke-RestMethod).remarks -notlike 'Get-Help cannot find the Help files*') {
-            Write-Host -Fore Green 'Powershell 5.1 Utility Help is already installed'
+            Write-Host -Fore Green "PowerShell $PSVersion Utility Help is already installed"
             return
         }
 
-        # Cant use requires RunAsAdministrator because PS isn't smart enough to know this is a subscript.
-        if (-not [Security.Principal.WindowsPrincipal]::new([Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
-            throw 'Windows PowerShell Update-Help requires admin rights. Please re-run the script in an elevated powershell session.'
+        if ($PSEdition -eq 'Desktop') {
+            # Cant use requires RunAsAdministrator because PS isn't smart enough to know this is a subscript.
+            if (-not [Security.Principal.WindowsPrincipal]::new(
+                    [Security.Principal.WindowsIdentity]::GetCurrent()
+                ).IsInRole(
+                    [Security.Principal.WindowsBuiltInRole]::Administrator
+                )) {
+                throw 'Windows PowerShell Update-Help requires admin rights. Please re-run the script in an elevated powershell session.'
+            }
         }
 
         # We store our local copy of help files here for testing as some pipelines disallow internet access
         $helpPath = '{{HELPPATH}}'
 
-        Write-Host -Fore Magenta "Powershell 5.1 Utility Help is not installed, installing from $helpPath"
+        Write-Host -Fore Magenta "Powershell $PSVersion Utility Help is not installed, installing from $helpPath"
+
+        $updateHelpParams = @{
+            Module     = 'Microsoft.PowerShell.Utility'
+            SourcePath = $helpPath
+            UICulture  = 'en-US'
+            Force      = $true
+            Verbose    = $true
+        }
 
+        #PS7+ does not require admin rights if currentuser is used for scope. 5.1 does not have this option.
+        if ($PSEdition -ne 'Desktop') {
+            $updateHelpParams.'Scope' = 'CurrentUser'
+        }
         #Update the help, and capture verbose output
-        $updateHelpOutput = Update-Help 'Microsoft.PowerShell.Utility' -Verbose -SourcePath $helpPath -Force *>&1
+        Wait-Debugger
+        $updateHelpOutput = Update-Help @updateHelpParams *>&1
 
         if ((Get-Help Invoke-RestMethod).remarks -like 'Get-Help cannot find the Help files*') {
-            throw "Failed to install PowerShell 5.1 Help: $updateHelpOutput"
+            throw "Failed to install PowerShell $PSVersion Help: $updateHelpOutput"
         } else {
-            Write-Host -Fore Green 'Powershell 5.1 Utility Help installed successfully'
+            Write-Host -Fore Green "Powershell $PSVersion Utility Help installed successfully"
         }
     }
 
     #Need this to inject the help file path, since PSScriptRoot won't work inside the script
-    $helpPath = "$PSScriptRoot\test\PowerShellEditorServices.Test.Shared\PSHelp"
+    $helpPath = Resolve-Path "$PSScriptRoot\test\PowerShellEditorServices.Test.Shared\PSHelp" -ErrorAction Stop
+    Write-Host -Fore Magenta "Runner Help located at $helpPath"
     $resolvedScript = $installHelpScript -replace '{{HELPPATH}}', $helpPath
 
-    #We might be running as PS7, so run as separate WinPS process to be sure.
-    powershell.exe -NoProfile -NonInteractive -Command $resolvedScript
-
-    if ($LASTEXITCODE -ne 0) {
-        throw 'Failed to install PowerShell 5.1 Help.'
+    # if ($PSEdition -eq 'Core') {
+    #     Write-Host -Fore Magenta 'Checking Runner Pwsh help'
+    #     & ([ScriptBlock]::Create($resolvedScript))
+    # }
+
+    # if ($PwshDaily -and (Get-Command $PwshDaily -ea 0)) {
+    #     Write-Host -Fore Magenta "Checking PWSH Daily help at $PwshDaily"
+    #     & $PwshDaily -NoProfile -NonInteractive -Command $resolvedScript
+    #     if ($LASTEXITCODE -ne 0) {
+    #         throw 'Failed to install PowerShell Daily Help.'
+    #     }
+    # }
+
+    if (Get-Command powershell -ea 0) {
+        Write-Host -Fore Magenta 'Checking PowerShell 5.1 help'
+        powershell.exe -NoProfile -NonInteractive -Command $resolvedScript
+        if ($LASTEXITCODE -ne 0) {
+            throw 'Failed to install PowerShell 5.1 Help.'
+        }
     }
 }