(#2591) Fix broken Pester tests

We found an issue when trying to pass multiple arguments through to
Invoke-Choco. After a few different attempts to get things working, we
settled on explicitly creating an array of arguments, which eant a minor
change in Invoke-Choco itself to handle this correctly.

The logic for skipping the `choco license` test was simplified to only
include that command _when_ licensed is in play, rather than trying to
skip that test when license is in play.

Also added the required setup to allow execution of the required
commands, i.e. install an older version of a package to allow `choco
outdated` to work, and setting an apikey so the headers appear when
doing `choco apikey`.

Took the opportunity to fix a spelling mistake that was in nother file
as well:

encryped -> encrypted

Author: gep13

tests/helpers/common/Chocolatey/Invoke-Choco.ps1

@@ -18,7 +18,7 @@
     )
     begin {
         $chocoPath = Get-ChocoPath
-        $firstArgument, [string[]]$remainingArguments = $Arguments
+        $firstArgument, [string[]]$remainingArguments = $Arguments.ForEach{$_}
         $arguments = @(
             $firstArgument
             '--allow-unofficial'

tests/pester-tests/commands/choco-apikey.Tests.ps1

@@ -119,7 +119,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
             $key = $Key
             $config = $apiKeys.Where{ $_.source -eq "https://test.com/api/$key" }
             $config | Should -HaveCount 1
-            $config.key | Should -Not -BeNullOrEmpty # The key is encryped, so we don't test the value
+            $config.key | Should -Not -BeNullOrEmpty # The key is encrypted, so we don't test the value
         }
     }
 
@@ -163,7 +163,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
             $key = $Key
             $config = $apiKeys.Where{ $_.source -eq "https://test.com/api/add/$key" }
             $config | Should -HaveCount 1
-            $config.key | Should -Not -BeNullOrEmpty # The key is encryped, so we don't test the value
+            $config.key | Should -Not -BeNullOrEmpty # The key is encrypted, so we don't test the value
         }
     }
 
@@ -211,7 +211,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
             $key = $Key
             $config = $apiKeys.Where{ $_.source -eq "https://test.com/api/$key" }
             $config | Should -HaveCount 1
-            $config.key | Should -Not -BeNullOrEmpty # The key is encryped, so we don't test the value
+            $config.key | Should -Not -BeNullOrEmpty # The key is encrypted, so we don't test the value
         }
     }
 
@@ -259,7 +259,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
             $key = $Key
             $config = $apiKeys.Where{ $_.source -eq "https://test.com/api/add/$key" }
             $config | Should -HaveCount 1
-            $config.key | Should -Not -BeNullOrEmpty # The key is encryped, so we don't test the value
+            $config.key | Should -Not -BeNullOrEmpty # The key is encrypted, so we don't test the value
         }
     }
 

tests/pester-tests/features/Headers.Tests.ps1

@@ -6,100 +6,85 @@ Describe "choco headers tests" -Tag Chocolatey, HeadersFeature {
 
         $Commands = @(
             @{
-                Command = 'apikey'
-                CommandLine = 'list'
+                CommandArguments = 'apikey', 'list'
                 ExpectedHeaders = 'Source|ApiKey'
-                SkipTest = $false
             }
             @{
-                Command = 'config'
-                CommandLine = 'list'
+                CommandArguments = 'config', 'list'
                 ExpectedHeaders = 'Name|Value|Description'
-                SkipTest = $false
             }
             @{
-                Command = 'feature'
-                CommandLine = 'list'
+                CommandArguments = 'feature', 'list'
                 ExpectedHeaders = 'Name|Enabled|Description'
-                SkipTest = $false
             }
             @{
-                Command = 'info'
-                CommandLine = "chocolatey", "--local-only"
+                CommandArguments = 'info', 'chocolatey', '--local-only', '--pre'
                 ExpectedHeaders = 'Id|Version'
-                SkipTest = $false
             }
             @{
-                Command = 'license'
-                CommandLine = 'info'
-                ExpectedHeaders = 'Name|Type|ExpirationDate|NodeCount'
-                SkipTest = $isLicensed
-            }
-            @{
-                Command = 'list'
+                CommandArguments = 'list'
                 ExpectedHeaders = 'Id|Version'
-                SkipTest = $false
             }
             @{
-                Command = 'outdated'
+                CommandArguments = 'outdated', '--ignore-unfound', '--ignore-pinned'
                 ExpectedHeaders = 'Id|Version|AvailableVersion|Pinned'
-                SkipTest = $false
             }
             @{
-                # Needs to pin something...
-                Command = 'pin'
-                CommandLine = 'list'
+                CommandArguments = 'pin', 'list'
                 ExpectedHeaders = 'Id|Version'
-                SkipTest = $false
             }
             @{
-                Command = 'rule'
-                CommandLine = 'list'
+                CommandArguments = 'rule', 'list'
                 ExpectedHeaders = 'Severity|Id|Summary|HelpUrl'
-                SkipTest = $false
             }
             @{
-                Command = 'search'
-                CommandLine = 'windirstat'
+                CommandArguments = 'search', 'windirstat'
                 ExpectedHeaders = 'Id|Version'
-                SkipTest = $false
             }
             @{
-                Command = 'source'
-                CommandLine = 'list'
+                CommandArguments = 'source', 'list'
                 ExpectedHeaders = 'Name|Source|Disabled|UserName|Certificate|Priority|BypassProxy|AllowSelfService|AdminOnly'
-                SkipTest = $false
             }
             @{
-                Command = 'template'
-                CommandLine = 'list'
+                CommandArguments = 'template', 'list'
                 ExpectedHeaders = 'Name|Version'
-                SkipTest = $false
             }
         )
+
+        if ($isLicensed) {
+            $Commands += @{
+                CommandArguments = 'license', 'info'
+                ExpectedHeaders = 'Name|Type|ExpirationDate|NodeCount'
+            }
+        }
     }
     BeforeAll {
         Initialize-ChocolateyTestInstall
 
-        New-ChocolateyInstallSnapshot
-
         # These are needed in order to test the choco pin list execution
         # as well as the choco apikey list as the headers will only be shown
-        # when there is a pinned package
+        # when there is a pinned package. Finally, we need to install an
+        # outdated package, so that the headers show in the choco outdated
+        # command.
         $null = Invoke-Choco pin add --name="chocolatey"
 
-        $null = Invoke-Choco apikey add --source "https://community.chocolatey.org/api/v2" --api-key "bob"
+        $null = Invoke-Choco apikey add --source "https://test.com/api/add/" --api-key "test-api-key"
+
+        $null = Invoke-Choco install upgradepackage --version 1.0.0 --confirm
+
+        New-ChocolateyInstallSnapshot
     }
 
     AfterAll {
         Remove-ChocolateyTestInstall
     }
 
-    Context "Outputs headers for <Command> when '--include-headers' provided configured" -ForEach $Commands -Skip:($SkipTest) {
+    Context "Outputs headers for <CommandArguments> when '--include-headers' provided configured" -ForEach $Commands {
         BeforeAll {
             Restore-ChocolateyInstallSnapshot -NoSnapshotCopy
 
-            $Output = Invoke-Choco $Command @CommandLine --limit-output --include-headers
+            [string[]]$chocoArgs = @($CommandArguments) + @('--limit-output', '--include-headers')
+            $Output = Invoke-Choco @chocoArgs
         }
 
         It 'Exits success (0)' {
@@ -117,11 +102,12 @@ Describe "choco headers tests" -Tag Chocolatey, HeadersFeature {
         }
     }
 
-    Context "Does not output headers for <Command> by default" -ForEach $Commands -Skip:($SkipTest) {
+    Context "Does not output headers for <CommandArguments> by default" -ForEach $Commands {
         BeforeAll {
             Restore-ChocolateyInstallSnapshot -NoSnapshotCopy
 
-            $Output = Invoke-Choco $Command @CommandLine --limit-output
+            [string[]]$chocoArgs = @($CommandArguments) + @('--limit-output')
+            $Output = Invoke-Choco @chocoArgs
         }
 
         It 'Exits success (0)' {
@@ -139,16 +125,17 @@ Describe "choco headers tests" -Tag Chocolatey, HeadersFeature {
         }
     }
 
-    Context "Includes headers when feature enabled" -Skip:($SkipTest) {
+    Context "Includes headers when feature enabled" {
         BeforeAll {
             Restore-ChocolateyInstallSnapshot
 
             Enable-ChocolateyFeature -Name AlwaysIncludeHeaders
         }
 
-        Context "Includes headers for <Command>" -ForEach $Commands {
+        Context "Includes headers for <CommandArguments>" -ForEach $Commands {
             BeforeAll {
-                $Output = Invoke-Choco $Command @CommandLine --limit-output
+                [string[]]$chocoArgs = @($CommandArguments) + @('--limit-output')
+                $Output = Invoke-Choco @chocoArgs
             }
 
             It 'Exits success (0)' {