Merge pull request #3372 from corbob/fix-support-tests

(#2712) Normalize ExitCode pester test on Support Branch
chocolatey · Dec 20, 2023 · a425c67 · a425c67
2 parents 809e847 + 89b3eef
commit a425c67
Show file tree

Hide file tree

Showing 20 changed files with 179 additions and 176 deletions.
diff --git a/tests/pester-tests/chocolatey.Tests.ps1 b/tests/pester-tests/chocolatey.Tests.ps1
@@ -77,7 +77,7 @@ Describe "Ensuring Chocolatey is correctly installed" -Tag Environment, Chocolat
         It "Outputs the version when run with --version" {
             $Output = Invoke-Choco --version
             $script:CurrentVersion = $Output.String
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
             $LastExitCode | Should -Be 0
             ($Output.String -split '-' | Select-Object -First 1) -as [version] | Should -BeTrue
         }
@@ -333,7 +333,7 @@ exit $error.count
         }
 
         It 'should exit Success (0)' {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It 'should <removal> shim <_> on upgrade' -ForEach $RemovedShims {
@@ -356,7 +356,7 @@ exit $error.count
         }
 
         It 'Exits with Success (0)' {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It 'Should remove the invalid configuration file' {

diff --git a/tests/pester-tests/commands/choco-apikey.Tests.ps1 b/tests/pester-tests/commands/choco-apikey.Tests.ps1
@@ -27,7 +27,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Only displays chocolatey name with version" {
@@ -44,7 +44,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Only displays chocolatey name with version" {
@@ -59,7 +59,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Only displays chocolatey name with version" {
@@ -75,7 +75,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Only displays chocolatey name with version" {
@@ -108,7 +108,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -155,7 +155,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -190,7 +190,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -219,7 +219,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -237,7 +237,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Failure (1)" {
-            $Output.ExitCode | Should -Be 1
+            $Output.ExitCode | Should -Be 1 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -257,7 +257,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -280,7 +280,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, ApiKeyCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {

diff --git a/tests/pester-tests/commands/choco-config.Tests.ps1 b/tests/pester-tests/commands/choco-config.Tests.ps1
@@ -91,7 +91,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -173,7 +173,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -191,7 +191,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -209,7 +209,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with failure (1)" {
-            $Output.ExitCode | Should -Be 1
+            $Output.ExitCode | Should -Be 1 -Because $Output.String
         }
 
         It "Outputs an error indicating that there's no config by that name" {
@@ -226,7 +226,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -253,7 +253,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -280,7 +280,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -310,7 +310,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {
@@ -337,7 +337,7 @@ Describe "choco config" -Tag Chocolatey, ConfigCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays chocolatey name with version" {

diff --git a/tests/pester-tests/commands/choco-deprecated.Tests.ps1 b/tests/pester-tests/commands/choco-deprecated.Tests.ps1
@@ -76,7 +76,7 @@ Describe "Deprecated Chocolatey Helper Commands" -Skip:(-not (Test-ChocolateyVer
     }
 
     It 'should exit success (0)' {
-        $Output.ExitCode | Should -Be 0
+        $Output.ExitCode | Should -Be 0 -Because $Output.String
     }
 
     It 'should warn that Get-BinRoot is deprecated' {

diff --git a/tests/pester-tests/commands/choco-export.Tests.ps1 b/tests/pester-tests/commands/choco-export.Tests.ps1
@@ -76,7 +76,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Displays description of command" {
@@ -133,7 +133,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         # NOTE: There is no output other than the header, and possibly the unofficial statement
@@ -184,7 +184,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         # NOTE: There is no output other than the header, and possibly the unofficial statement
@@ -226,7 +226,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         # NOTE: There is no output other than the header, and possibly the unofficial statement
@@ -277,7 +277,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         # NOTE: There is no output other than the header, and possibly the unofficial statement
@@ -319,7 +319,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         # NOTE: There is no output other than the header, and possibly the unofficial statement
@@ -387,7 +387,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         # NOTE: There is no output other than the header, and possibly the unofficial statement
@@ -415,7 +415,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with Failure (1)" {
-            $Output.ExitCode | Should -Be 1
+            $Output.ExitCode | Should -Be 1 -Because $Output.String
         }
 
         It "Reports unable to export packages" {
@@ -439,7 +439,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with Failure (1)" {
-            $Output.ExitCode | Should -Be 1
+            $Output.ExitCode | Should -Be 1 -Because $Output.String
         }
 
         It "Reports unable to export packages" {
@@ -459,7 +459,7 @@ Describe "choco export" -Tag Chocolatey, ExportCommand {
         }
 
         It "Exits with Failure (1)" {
-            $Output.ExitCode | Should -Be 1
+            $Output.ExitCode | Should -Be 1 -Because $Output.String
         }
 
         It "Displays help page" {

diff --git a/tests/pester-tests/commands/choco-feature.Tests.ps1 b/tests/pester-tests/commands/choco-feature.Tests.ps1
@@ -34,7 +34,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, FeatureCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Lists available features" {
@@ -121,7 +121,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, FeatureCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Outputs a message indicating that it disabled the feature" {
@@ -145,7 +145,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, FeatureCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Outputs a message indicating that it enabled the feature" {
@@ -169,7 +169,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, FeatureCommand {
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Outputs a message indicating that it disabled the feature" {
@@ -189,7 +189,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, FeatureCommand {
         }
 
         It "Exits with Failure (1)" {
-            $Output.ExitCode | Should -Be 1
+            $Output.ExitCode | Should -Be 1 -Because $Output.String
         }
 
         It "Outputs a message indicating it didn't find the feature in question" {
@@ -206,7 +206,7 @@ Describe "choco <_>" -ForEach $Command -Tag Chocolatey, FeatureCommand {
         }
 
         It "Exits with Failure (1)" {
-            $Output.ExitCode | Should -Be 1
+            $Output.ExitCode | Should -Be 1 -Because $Output.String
         }
 
         It "Outputs a message indicating it didn't find the feature in question" {

diff --git a/tests/pester-tests/commands/choco-help.Tests.ps1 b/tests/pester-tests/commands/choco-help.Tests.ps1
@@ -45,7 +45,7 @@ Describe "choco help sections with option <_>" -ForEach $HelpOptions -Tag Chocol
         }
 
         It "Exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Outputs the Top-Level Help" {
@@ -70,7 +70,7 @@ Describe "choco help sections with option <_>" -ForEach $HelpOptions -Tag Chocol
         }
 
         It "'choco <_> $helpArgument' exits with Success (0)" {
-            $Output.ExitCode | Should -Be 0
+            $Output.ExitCode | Should -Be 0 -Because $Output.String
         }
 
         It "Outputs help for <_>" {