Skip to content

Commit

Permalink
(#3566) Add Pester tests for Credential Provider
Browse files Browse the repository at this point in the history
Add Pester tests to ensure we don't inadvertently bleed configured
credentials into scenarios where they should not be used.
  • Loading branch information
corbob committed Nov 25, 2024
1 parent bafa7eb commit d22a10d
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 7 deletions.
6 changes: 2 additions & 4 deletions tests/helpers/common/Chocolatey/Disable-ChocolateySource.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ function Disable-ChocolateySource {
[Parameter()]
[switch]$All
)
# Significantly weird behaviour with piping this source list by property name.
$CurrentSources = (Invoke-Choco source list -r).Lines | ConvertFrom-ChocolateyOutput -Command SourceList | Where-Object {
$_.Name -like $Name
}

$CurrentSources = Get-ChocolateySource -Name $Name
foreach ($Source in $CurrentSources) {
$null = Invoke-Choco source disable --name $Source.Name
}
Expand Down
4 changes: 1 addition & 3 deletions tests/helpers/common/Chocolatey/Enable-ChocolateySource.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ function Enable-ChocolateySource {
[switch]$All
)
# Significantly weird behaviour with piping this source list by property name.
$CurrentSources = (Invoke-Choco source list -r).Lines | ConvertFrom-ChocolateyOutput -Command SourceList | Where-Object {
$_.Name -like $Name
}
$CurrentSources = Get-ChocolateySource -Name $Name
foreach ($Source in $CurrentSources) {
$null = Invoke-Choco source enable --name $Source.Name
}
Expand Down
14 changes: 14 additions & 0 deletions tests/helpers/common/Chocolatey/Get-ChocolateySource.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
function Get-ChocolateySource {
[CmdletBinding()]
param(
[Parameter()]
[string]$Name = "*",

[Parameter()]
[switch]$All
)
# Significantly weird behaviour with piping this source list by property name.
(Invoke-Choco source list -r).Lines | ConvertFrom-ChocolateyOutput -Command SourceList | Where-Object {
$_.Name -like $Name
}
}
66 changes: 66 additions & 0 deletions tests/pester-tests/features/CredentialProvider.Tests.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
Describe 'Ensuring credentials do not bleed from configured sources' -Tag CredentialProvider -ForEach @(
@{
Command = 'info'
ExitCode = 0
}
@{
Command = 'install'
ExitCode = 1
}
@{
Command = 'outdated'
ExitCode = 0
}
@{
Command = 'search'
ExitCode = 0
}
@{
Command = 'upgrade'
ExitCode = 1
}
@{
Command = 'download'
ExitCode = 1
}
) {
BeforeDiscovery {
$HasLicensedExtension = Test-PackageIsEqualOrHigher -PackageName 'chocolatey.extension' -Version '5.0.0'
}

BeforeAll {
Initialize-ChocolateyTestInstall
Disable-ChocolateySource -All
Enable-ChocolateySource -Name 'hermes'
$SetupSource = Get-ChocolateySource -Name 'hermes-setup'
Remove-Item download -force -recurse
}

# Skip the download command if chocolatey.extension is not installed.
Context 'Command (<Command>)' -Skip:($Command -eq 'download' -and -not $HasLicensedExtension) {
BeforeAll {
# Picked a package that is on `hermes-setup` but not on `hermes`.
$PackageUnderTest = 'chocolatey-compatibility.extension'
Restore-ChocolateyInstallSnapshot
# Chocolatey will prompt for credentials, we need to force something in there, and this will do that.
$Output = 'n' | Invoke-Choco $Command $PackageUnderTest --confirm --source="'$($SetupSource.Url)'"
}

AfterAll {
Remove-ChocolateyInstallSnapshot
}

It 'Exits Correctly (<ExitCode>)' {
$Output.ExitCode | Should -Be $ExitCode -Because $Output.String
}

It 'Outputs error message' {
if ($Command -eq 'search') {
$Output.Lines | Should -Contain "[NuGet] Not able to contact source '$($SetupSource.Url)'. Error was The remote server returned an error: (401) Unauthorized." -Because $Output.String
} else {
$Output.Lines | Should -Contain "Error retrieving packages from source '$($SetupSource.Url)':" -Because $Output.String
$Output.Lines | Should -Contain "The remote server returned an error: (401) Unauthorized." -Because $Output.String
}
}
}
}

0 comments on commit d22a10d

Please sign in to comment.