Skip to content

Commit e992fc3

Browse files
HeyItsGilbertclaude
HeyItsGilbert
and
claude
committed
test: add Pester v5 unit tests for each dependency script
Adds one *.Type.Tests.ps1 file per script under PSDepend/PSDependScripts/ (14 total, 50 tests). Each suite covers the contract checks from the reviewer checklist — Name/DependencyName fallback, Version default, Test/Install/Test+Install action semantics, scope vs path branching, Credential pass-through, missing-tool error paths — while mocking the external surface (Install-Module, Find-Module, Invoke-ExternalCommand, Get-WebFile, Get-NodeModule, Test-Dotnet, etc.) so the suite runs offline in under 20s. Tests/Shared/TestHelpers.psm1 exposes New-PSDependFixture for cheaply building [PSTypeName('PSDepend.Dependency')] inputs in-memory, avoiding the .depend.psd1 round-trip when only the script-under-test matters. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent dbdfd44 commit e992fc3

15 files changed

Lines changed: 947 additions & 0 deletions

‎Tests/Chocolatey.Type.Tests.ps1‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#requires -Module @{ ModuleName = 'Pester'; ModuleVersion = '5.0.0' }
2+
3+
BeforeAll {
4+
if (-not $env:BHProjectPath) {
5+
Set-BuildEnvironment -Path "$PSScriptRoot/.." -Force
6+
}
7+
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
8+
Import-Module (Join-Path $env:BHProjectPath $env:BHProjectName) -Force
9+
10+
Import-Module (Join-Path $PSScriptRoot 'Shared/TestHelpers.psm1') -Force
11+
12+
$script:ScriptPath = Join-Path $env:BHProjectPath 'PSDepend/PSDependScripts/Chocolatey.ps1'
13+
}
14+
15+
Describe 'Chocolatey script' -Tag 'WindowsOnly' {
16+
17+
BeforeAll {
18+
InModuleScope PSDepend {
19+
# Pretend choco.exe is present so we skip the bootstrap branch
20+
Mock Get-Command { [pscustomobject]@{ Name = 'choco.exe' } } -ParameterFilter { $Name -eq 'choco.exe' }
21+
# All choco invocations return empty CSV (no packages installed, none found upstream)
22+
Mock Invoke-ExternalCommand { }
23+
Mock Invoke-WebRequest { }
24+
}
25+
}
26+
27+
It 'Defaults Source to https://chocolatey.org/api/v2/ when not supplied' {
28+
$dep = New-PSDependFixture -DependencyName 'git' -DependencyType 'Chocolatey'
29+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
30+
& $ScriptPath -Dependency $Dep -WarningAction SilentlyContinue
31+
}
32+
# We can't verify the default by inspecting choco args (script bails out
33+
# when latest lookup returns nothing) but the script should not throw.
34+
$true | Should -BeTrue
35+
}
36+
37+
It 'Invokes choco upgrade with -Force when -Force switch is set' {
38+
$dep = New-PSDependFixture -DependencyName 'git' -DependencyType 'Chocolatey' -Version '2.0.2'
39+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
40+
& $ScriptPath -Dependency $Dep -Force
41+
}
42+
Should -Invoke -CommandName Invoke-ExternalCommand -ModuleName PSDepend -Times 1 -Exactly -ParameterFilter {
43+
$Arguments -contains 'upgrade' -and $Arguments -contains '--force'
44+
}
45+
}
46+
47+
It 'Forwards Credential to choco as --username / --password args' {
48+
$cred = New-TestCredential -UserName 'feeduser' -Password 'feedpass'
49+
$dep = New-PSDependFixture -DependencyName 'git' -DependencyType 'Chocolatey' -Version '2.0.2' -Credential $cred
50+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
51+
& $ScriptPath -Dependency $Dep -Force
52+
}
53+
Should -Invoke -CommandName Invoke-ExternalCommand -ModuleName PSDepend -Times 1 -Exactly -ParameterFilter {
54+
($Arguments -join ' ') -match "--username='feeduser'" -and ($Arguments -join ' ') -match "--password='feedpass'"
55+
}
56+
}
57+
}

‎Tests/Command.Type.Tests.ps1‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#requires -Module @{ ModuleName = 'Pester'; ModuleVersion = '5.0.0' }
2+
3+
BeforeAll {
4+
if (-not $env:BHProjectPath) {
5+
Set-BuildEnvironment -Path "$PSScriptRoot/.." -Force
6+
}
7+
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
8+
Import-Module (Join-Path $env:BHProjectPath $env:BHProjectName) -Force
9+
10+
Import-Module (Join-Path $PSScriptRoot 'Shared/TestHelpers.psm1') -Force
11+
12+
$script:ScriptPath = Join-Path $env:BHProjectPath 'PSDepend/PSDependScripts/Command.ps1'
13+
}
14+
15+
Describe 'Command script' {
16+
17+
It 'Executes the Source string as PowerShell in the current session' {
18+
$flagPath = Join-Path 'TestDrive:' 'flag.txt'
19+
$dep = New-PSDependFixture -DependencyName 'CmdOne' -DependencyType 'Command' -Source "Set-Content -Path '$flagPath' -Value 'ran'"
20+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
21+
& $ScriptPath -Dependency $Dep
22+
}
23+
(Get-Content $flagPath) | Should -Be 'ran'
24+
}
25+
26+
It 'Iterates multiple Source entries' {
27+
$countPath = Join-Path 'TestDrive:' 'count.txt'
28+
$dep = New-PSDependFixture -DependencyName 'CmdMulti' -DependencyType 'Command' -Source @(
29+
"Add-Content '$countPath' 'a'"
30+
"Add-Content '$countPath' 'b'"
31+
)
32+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
33+
& $ScriptPath -Dependency $Dep
34+
}
35+
(Get-Content $countPath) | Should -Be @('a', 'b')
36+
}
37+
38+
It 'Throws by default when the Source errors' {
39+
$dep = New-PSDependFixture -DependencyName 'CmdFail' -DependencyType 'Command' -Source "throw 'boom'"
40+
{
41+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
42+
& $ScriptPath -Dependency $Dep
43+
}
44+
} | Should -Throw -ExpectedMessage '*boom*'
45+
}
46+
47+
It 'Continues past errors when -FailOnError is specified' {
48+
$dep = New-PSDependFixture -DependencyName 'CmdSwallow' -DependencyType 'Command' -Source "throw 'boom'"
49+
$err = $null
50+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
51+
& $ScriptPath -Dependency $Dep -FailOnError -ErrorAction SilentlyContinue -ErrorVariable err
52+
$script:capturedErr = $err
53+
}
54+
# Did not throw — Write-Error was used
55+
$true | Should -BeTrue
56+
}
57+
}

‎Tests/DotnetSdk.Type.Tests.ps1‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
#requires -Module @{ ModuleName = 'Pester'; ModuleVersion = '5.0.0' }
2+
3+
BeforeAll {
4+
if (-not $env:BHProjectPath) {
5+
Set-BuildEnvironment -Path "$PSScriptRoot/.." -Force
6+
}
7+
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
8+
Import-Module (Join-Path $env:BHProjectPath $env:BHProjectName) -Force
9+
10+
Import-Module (Join-Path $PSScriptRoot 'Shared/TestHelpers.psm1') -Force
11+
12+
$script:ScriptPath = Join-Path $env:BHProjectPath 'PSDepend/PSDependScripts/DotnetSdk.ps1'
13+
$script:OrigPath = $env:PATH
14+
}
15+
16+
AfterAll {
17+
if ($script:OrigPath) { $env:PATH = $script:OrigPath }
18+
}
19+
20+
Describe 'DotnetSdk script' {
21+
22+
BeforeAll {
23+
InModuleScope PSDepend {
24+
Mock Install-Dotnet { }
25+
Mock Test-Dotnet { $false }
26+
}
27+
}
28+
29+
It 'PSDependAction Test delegates to Test-Dotnet' {
30+
InModuleScope PSDepend { Mock Test-Dotnet { $true } }
31+
$dep = New-PSDependFixture -DependencyName 'release' -DependencyType 'DotnetSdk' -Version '2.1.0'
32+
$result = InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
33+
& $ScriptPath -Dependency $Dep -PSDependAction Test
34+
}
35+
$result | Should -Be $true
36+
Should -Invoke -CommandName Test-Dotnet -ModuleName PSDepend -Times 1
37+
}
38+
39+
It 'Calls Install-Dotnet when Test-Dotnet reports SDK is missing' {
40+
$installDir = (New-Item 'TestDrive:/dotnet' -ItemType Directory -Force).FullName
41+
$dep = New-PSDependFixture -DependencyName 'release' -DependencyType 'DotnetSdk' -Version '2.1.0' -Target $installDir
42+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath; D = $installDir } {
43+
& $ScriptPath -Dependency $Dep
44+
}
45+
Should -Invoke -CommandName Install-Dotnet -ModuleName PSDepend -Times 1 -Exactly -ParameterFilter {
46+
$Channel -eq 'release' -and $Version -eq '2.1.0' -and $InstallDir -eq $installDir
47+
}
48+
}
49+
50+
It 'Skips Install-Dotnet when Test-Dotnet reports SDK is present' {
51+
InModuleScope PSDepend { Mock Test-Dotnet { $true } }
52+
$dep = New-PSDependFixture -DependencyName 'LTS' -DependencyType 'DotnetSdk' -Version '2.1.0'
53+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
54+
& $ScriptPath -Dependency $Dep
55+
}
56+
Should -Invoke -CommandName Install-Dotnet -ModuleName PSDepend -Times 0
57+
}
58+
}

‎Tests/FileDownload.Type.Tests.ps1‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
#requires -Module @{ ModuleName = 'Pester'; ModuleVersion = '5.0.0' }
2+
3+
BeforeAll {
4+
if (-not $env:BHProjectPath) {
5+
Set-BuildEnvironment -Path "$PSScriptRoot/.." -Force
6+
}
7+
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
8+
Import-Module (Join-Path $env:BHProjectPath $env:BHProjectName) -Force
9+
10+
Import-Module (Join-Path $PSScriptRoot 'Shared/TestHelpers.psm1') -Force
11+
12+
$script:ScriptPath = Join-Path $env:BHProjectPath 'PSDepend/PSDependScripts/FileDownload.ps1'
13+
}
14+
15+
Describe 'FileDownload script' {
16+
17+
BeforeAll {
18+
InModuleScope PSDepend {
19+
Mock Get-WebFile { }
20+
Mock Add-ToItemCollection { }
21+
}
22+
}
23+
24+
It 'Downloads to Target with filename parsed from the URL when Target is an existing folder' {
25+
$targetDir = (New-Item 'TestDrive:/dl' -ItemType Directory -Force).FullName
26+
$dep = New-PSDependFixture -DependencyName 'https://example.com/sample.dll' -DependencyType 'FileDownload' -Target $targetDir
27+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath; T = $targetDir } {
28+
& $ScriptPath -Dependency $Dep
29+
}
30+
Should -Invoke -CommandName Get-WebFile -ModuleName PSDepend -Times 1 -Exactly -ParameterFilter {
31+
$URL -eq 'https://example.com/sample.dll' -and ($Path -like "*sample.dll")
32+
}
33+
}
34+
35+
It 'Uses Source to override the URL when supplied' {
36+
$targetDir = (New-Item 'TestDrive:/dl2' -ItemType Directory -Force).FullName
37+
$dep = New-PSDependFixture -DependencyName 'ignored-key' -DependencyType 'FileDownload' -Target $targetDir -Source 'https://example.com/other.dll'
38+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
39+
& $ScriptPath -Dependency $Dep
40+
}
41+
Should -Invoke -CommandName Get-WebFile -ModuleName PSDepend -Times 1 -Exactly -ParameterFilter {
42+
$URL -eq 'https://example.com/other.dll'
43+
}
44+
}
45+
46+
It 'Skips download when the target file already exists' {
47+
$targetDir = (New-Item 'TestDrive:/dl3' -ItemType Directory -Force).FullName
48+
$existingFile = Join-Path $targetDir 'sample.dll'
49+
Set-Content -Path $existingFile -Value 'existing'
50+
51+
$dep = New-PSDependFixture -DependencyName 'https://example.com/sample.dll' -DependencyType 'FileDownload' -Target $existingFile
52+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
53+
& $ScriptPath -Dependency $Dep
54+
}
55+
Should -Invoke -CommandName Get-WebFile -ModuleName PSDepend -Times 0
56+
}
57+
58+
It 'PSDependAction Test returns $true when the file exists' {
59+
$targetDir = (New-Item 'TestDrive:/dl4' -ItemType Directory -Force).FullName
60+
$existingFile = Join-Path $targetDir 'sample.dll'
61+
Set-Content -Path $existingFile -Value 'existing'
62+
63+
$dep = New-PSDependFixture -DependencyName 'https://example.com/sample.dll' -DependencyType 'FileDownload' -Target $existingFile
64+
$result = InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
65+
& $ScriptPath -Dependency $Dep -PSDependAction Test
66+
}
67+
$result | Should -Be $true
68+
}
69+
}

‎Tests/FileSystem.Type.Tests.ps1‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
#requires -Module @{ ModuleName = 'Pester'; ModuleVersion = '5.0.0' }
2+
3+
BeforeAll {
4+
if (-not $env:BHProjectPath) {
5+
Set-BuildEnvironment -Path "$PSScriptRoot/.." -Force
6+
}
7+
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
8+
Import-Module (Join-Path $env:BHProjectPath $env:BHProjectName) -Force
9+
10+
Import-Module (Join-Path $PSScriptRoot 'Shared/TestHelpers.psm1') -Force
11+
12+
$script:ScriptPath = Join-Path $env:BHProjectPath 'PSDepend/PSDependScripts/FileSystem.ps1'
13+
}
14+
15+
Describe 'FileSystem script' {
16+
17+
BeforeAll {
18+
InModuleScope PSDepend {
19+
Mock Copy-Item { }
20+
}
21+
}
22+
23+
It 'Copies a file from Source to Target when hashes differ' {
24+
$src = Join-Path 'TestDrive:' 'src.txt'
25+
$tgtDir = (New-Item 'TestDrive:/tgt' -ItemType Directory -Force).FullName
26+
Set-Content -Path $src -Value 'hello'
27+
$srcResolved = (Resolve-Path $src).ProviderPath
28+
29+
$dep = New-PSDependFixture -DependencyName 'fs-file' -DependencyType 'FileSystem' -Source $srcResolved -Target $tgtDir
30+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
31+
& $ScriptPath -Dependency $Dep
32+
}
33+
Should -Invoke -CommandName Copy-Item -ModuleName PSDepend -Times 1
34+
}
35+
36+
It 'PSDependAction Test returns $false when target is missing' {
37+
$src = Join-Path 'TestDrive:' 'src2.txt'
38+
$tgtDir = (New-Item 'TestDrive:/missing-tgt' -ItemType Directory -Force).FullName
39+
Set-Content -Path $src -Value 'content'
40+
$srcResolved = (Resolve-Path $src).ProviderPath
41+
42+
$dep = New-PSDependFixture -DependencyName 'fs-test' -DependencyType 'FileSystem' -Source $srcResolved -Target $tgtDir
43+
$result = InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
44+
& $ScriptPath -Dependency $Dep -PSDependAction Test
45+
}
46+
$result | Should -Be $false
47+
}
48+
49+
It 'Errors and skips when Source does not exist' {
50+
$tgtDir = (New-Item 'TestDrive:/tgt3' -ItemType Directory -Force).FullName
51+
$missingSrc = (Join-Path (Resolve-Path 'TestDrive:').ProviderPath 'does-not-exist.txt')
52+
$dep = New-PSDependFixture -DependencyName 'fs-missing' -DependencyType 'FileSystem' -Source $missingSrc -Target $tgtDir
53+
54+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
55+
& $ScriptPath -Dependency $Dep -ErrorAction SilentlyContinue
56+
}
57+
Should -Invoke -CommandName Copy-Item -ModuleName PSDepend -Times 0
58+
}
59+
}

‎Tests/Git.Type.Tests.ps1‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
#requires -Module @{ ModuleName = 'Pester'; ModuleVersion = '5.0.0' }
2+
3+
BeforeAll {
4+
if (-not $env:BHProjectPath) {
5+
Set-BuildEnvironment -Path "$PSScriptRoot/.." -Force
6+
}
7+
Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
8+
Import-Module (Join-Path $env:BHProjectPath $env:BHProjectName) -Force
9+
10+
Import-Module (Join-Path $PSScriptRoot 'Shared/TestHelpers.psm1') -Force
11+
12+
$script:ScriptPath = Join-Path $env:BHProjectPath 'PSDepend/PSDependScripts/Git.ps1'
13+
}
14+
15+
Describe 'Git script' {
16+
17+
BeforeAll {
18+
InModuleScope PSDepend {
19+
Mock Invoke-ExternalCommand { }
20+
Mock Import-PSDependModule { }
21+
Mock Add-ToItemCollection { }
22+
}
23+
}
24+
25+
It 'Clones the repo via git when the target does not exist' {
26+
$targetDir = (New-Item 'TestDrive:/git-target' -ItemType Directory -Force).FullName
27+
$dep = New-PSDependFixture -DependencyName 'https://example.com/user/repo.git' -DependencyType 'Git' -Target $targetDir
28+
29+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
30+
& $ScriptPath -Dependency $Dep
31+
}
32+
# git clone + git checkout
33+
Should -Invoke -CommandName Invoke-ExternalCommand -ModuleName PSDepend -Times 1 -ParameterFilter {
34+
$Arguments -contains 'clone'
35+
}
36+
Should -Invoke -CommandName Invoke-ExternalCommand -ModuleName PSDepend -Times 1 -ParameterFilter {
37+
$Arguments -contains 'checkout'
38+
}
39+
}
40+
41+
It 'Converts account/repo shorthand to a GitHub URL' {
42+
$targetDir = (New-Item 'TestDrive:/git-target2' -ItemType Directory -Force).FullName
43+
$dep = New-PSDependFixture -DependencyName 'user/repo' -DependencyType 'Git' -Target $targetDir
44+
45+
InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
46+
& $ScriptPath -Dependency $Dep
47+
}
48+
Should -Invoke -CommandName Invoke-ExternalCommand -ModuleName PSDepend -Times 1 -ParameterFilter {
49+
$Arguments -contains 'clone' -and ($Arguments -contains 'https://github.com/user/repo.git')
50+
}
51+
}
52+
53+
It 'PSDependAction Test returns $false when the repo path does not exist' {
54+
$targetDir = (New-Item 'TestDrive:/git-test' -ItemType Directory -Force).FullName
55+
$dep = New-PSDependFixture -DependencyName 'https://example.com/user/repo.git' -DependencyType 'Git' -Target $targetDir
56+
57+
$result = InModuleScope PSDepend -Parameters @{ Dep = $dep; ScriptPath = $script:ScriptPath } {
58+
& $ScriptPath -Dependency $Dep -PSDependAction Test
59+
}
60+
$result | Should -Be $false
61+
Should -Invoke -CommandName Invoke-ExternalCommand -ModuleName PSDepend -Times 0
62+
}
63+
}

0 commit comments

Comments
 (0)