Adding tests for update/save-help, and fixing existing help tests for

Linux.
2026-06-08 12:12:50 +00:00 · 2016-11-04 16:39:57 -07:00
parent fea4d883e8
commit 92b0eb336d
42 changed files with 438 additions and 60 deletions
@@ -0,0 +1,78 @@
+Describe 'Online help tests for PowerShell Core Cmdlets' -Tags "CI" {
+
+    # The csv files (V2Cmdlets.csv and V3Cmdlets.csv) contain a list of cmdlets and expected HelpURIs.
+    # The HelpURI is part of the cmdlet metadata, and when the user runs 'get-help <cmdletName> -online'
+    # the browser navigates to the address in the HelpURI. However, if a help file is present, the HelpURI
+    # on the file take precedence over the one in the cmdlet metadata. Therefore, the help content
+    # in the box needs to be deleted before running the tests, because otherwise, the HelpURI
+    # (when calling get-help -online) might not matched the one in the csv file.
+
+    BeforeAll {
+
+        # Enable the test hook
+        [system.management.automation.internal.internaltesthooks]::SetTestHook('BypassOnlineHelpRetrieval', $true)
+
+        # Remove the help content
+        Write-Verbose "Deleting help content for get-help -online tests" -Verbose
+        foreach ($path in @("$pshome\en-US", "$pshome\Modules"))
+        {
+            Get-ChildItem $path -Include "*help.xml" -Recurse -ea SilentlyContinue | Remove-Item -Force -ErrorAction SilentlyContinue
+        }
+    }
+
+    AfterAll {
+
+        # Disable the test hook
+        [system.management.automation.internal.internaltesthooks]::SetTestHook('BypassOnlineHelpRetrieval', $false)
+    }
+
+    foreach ($filePath in @("$PSScriptRoot\assets\HelpURI\V2Cmdlets.csv", "$PSScriptRoot\assets\HelpURI\V3Cmdlets.csv"))
+    {
+        $cmdletList = Import-Csv $filePath -ea Stop
+
+        foreach ($cmdlet in $cmdletList)
+        {
+            # If the cmdlet is not preset in CoreCLR, skip it.
+            if (Get-Command $cmdlet.TopicTitle -ea SilentlyContinue)
+            {
+                # TopicTitle - is the cmdlet name in the csv file
+                # HelpURI - is the expected help URI in the csv file
+
+                It "Validate 'get-help $($cmdlet.TopicTitle) -Online'" {
+                    $actualURI = Get-Help $cmdlet.TopicTitle -Online
+                    $actualURI = $actualURI.Replace("Help URI: ","")
+                    $actualURI | Should Be $cmdlet.HelpURI
+                }
+            }
+        }
+    }
+}
+
+Describe 'Get-Help -Online opens the default web browser and navigates to the cmdlet help content' -Tags "Feature" {
+
+    $skipTest = [System.Management.Automation.Platform]::IsIoT -or
+                [System.Management.Automation.Platform]::IsNanoServer
+
+    It "Get-Help get-process -online" -skip:$skipTest {
+
+        { Get-Help get-process -online } | Should Not Throw
+    }
+}
+
+Describe 'Get-Help -Online is not supported on Nano Server and IoT' -Tags "CI" {
+
+    $skipTest = -not ([System.Management.Automation.Platform]::IsIoT -or [System.Management.Automation.Platform]::IsNanoServer)
+
+    It "Get-help -online <cmdletName> throws InvalidOperation." -skip:$skipTest {
+
+        try
+        {
+            Get-Help Get-Help -Online
+            throw "Execution should not have succeeded"
+        }
+        catch
+        {
+            $_.FullyQualifiedErrorId | Should Be "InvalidOperation,Microsoft.PowerShell.Commands.GetHelpCommand"
+        }
+    }
+}