gsadmin/PSProxmoxVE
1
0
Fork 0
mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-09-04 11:15:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: make the offline Pester suite able to fail (#153) (#205)

Browse Source 
Skip-IfMissing skipped a test whenever the cmdlet under test was absent
from the build, including the test asserting it exists. Every cmdlet
compiles into one assembly, so there is no partial-build case for it to
serve; all it did was hide a missing cmdlet. Delete the 37 copies and
every call site, and drop the residual conditional skips in the same
family (CmdExists probes, an attribute-presence skip in SdnCmdlets, a
lifecycle helper skipping on a cmdlet-name collision fixed long ago).

894 It blocks only reflected [Cmdlet] and [Parameter] attributes back at
the compiler: existence, CommandType -eq 'Cmdlet', Parameters.ContainsKey,
IsMandatory reflection, and per-file CmdletsToExport asserts for whichever
names an author remembered. Nothing reflected over the built assembly, so
a new cmdlet missing from the manifest shipped invisible. One data-driven
file replaces them: it diffs CmdletsToExport against the assembly's cmdlet
types in both directions and asserts the conventions reflection can see.

Behavioural tests are untouched: no-session errors, binding rejections,
ShouldProcess and -WhatIf, ConfirmImpact, ValidateSet and ValidateRange
values, parameter types, positions and pipeline binding.

The generated help covered 169 of 194 cmdlets. Regenerated with the repo's
own generate-help.ps1: 25 new markdown stubs, 13 existing docs picking up
parameters added in earlier waves, and a rebuilt MAML.

Co-authored-by: goodolclint-claude[bot] <323206664+goodolclint-claude[bot]@users.noreply.github.com>
This commit is contained in:
goodolclint-claude[bot]
2026-09-03 00:54:02 +00:00
committed by GitHub
parent 1f1c414632
commit 109dca657a
91 changed files with 9809 additions and 7330 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/PSProxmoxVE.Tests/Users/UserCmdlets.Tests.ps1
+7 -231
View File
@@ -7,7 +7,6 @@
Get-PvePermission, Set-PvePermission.
All tests are fully offline — no live Proxmox VE target is required.
If a cmdlet is not yet compiled the test is marked Skipped.
#>
BeforeAll {
@@ -18,93 +17,16 @@ BeforeAll {
'Get-PveRole', 'New-PveRole', 'Remove-PveRole',
'Get-PvePermission', 'Set-PvePermission'
)
$script:Availability = @{}
foreach ($name in $allNames) {
$script:Availability[$name] = $null -ne (Get-Command $name -ErrorAction SilentlyContinue)
}
function Skip-IfMissing([string]$Name) {
if (-not $script:Availability[$Name]) {
Set-ItResult -Skipped -Because "$Name is not yet implemented in this build"
}
}
}
# ---------------------------------------------------------------------------
# Manifest contract
# ---------------------------------------------------------------------------
Describe 'User / Role / Permission cmdlets — manifest declarations' {
BeforeAll {
$manifestPath = Join-Path (Get-Module PSProxmoxVE).ModuleBase 'PSProxmoxVE.psd1'
$script:Manifest = if (Test-Path $manifestPath) { Import-PowerShellDataFile $manifestPath } else { $null }
}
It "<cmdName> should be declared in CmdletsToExport" -TestCases @(
@{ cmdName = 'Get-PveUser' }
@{ cmdName = 'New-PveUser' }
@{ cmdName = 'Remove-PveUser' }
@{ cmdName = 'Set-PveUser' }
@{ cmdName = 'Get-PveRole' }
@{ cmdName = 'New-PveRole' }
@{ cmdName = 'Remove-PveRole' }
@{ cmdName = 'Get-PvePermission' }
@{ cmdName = 'Set-PvePermission' }
) {
if ($null -eq $script:Manifest) { Set-ItResult -Skipped -Because 'Manifest not found'; return }
$script:Manifest.CmdletsToExport | Should -Contain $cmdName
}
}
# ---------------------------------------------------------------------------
# Get-PveUser
# ---------------------------------------------------------------------------
Describe 'Get-PveUser' {
BeforeAll { $script:Cmd = Get-Command 'Get-PveUser' -ErrorAction SilentlyContinue }
Context 'Command existence' {
It 'Should be available after module import' {
Skip-IfMissing 'Get-PveUser'
$script:Cmd | Should -Not -BeNullOrEmpty
}
It 'Should be a CmdletInfo (binary cmdlet)' {
Skip-IfMissing 'Get-PveUser'
$script:Cmd.CommandType | Should -Be 'Cmdlet'
}
}
Context 'Parameter metadata' {
It 'Should have UserId parameter (optional filter)' {
Skip-IfMissing 'Get-PveUser'
$script:Cmd.Parameters.ContainsKey('UserId') | Should -BeTrue
}
It 'UserId should not be Mandatory' {
Skip-IfMissing 'Get-PveUser'
$isMandatory = $script:Cmd.Parameters['UserId'].ParameterSets.Values |
Where-Object { $_.IsMandatory }
$isMandatory | Should -BeNullOrEmpty
}
It 'Should have Enabled switch or parameter to filter by enabled state' {
Skip-IfMissing 'Get-PveUser'
# Either an 'Enabled' switch or a filter parameter is expected.
$hasEnabled = $script:Cmd.Parameters.ContainsKey('Enabled') -or
$script:Cmd.Parameters.ContainsKey('EnabledOnly')
$hasEnabled | Should -BeTrue
}
It 'Should have Session parameter' {
Skip-IfMissing 'Get-PveUser'
$script:Cmd.Parameters.ContainsKey('Session') | Should -BeTrue
}
}
BeforeAll { $script:Cmd = Get-Command 'Get-PveUser' }
Context 'Without active session' {
It 'Should throw when no session is active' {
Skip-IfMissing 'Get-PveUser'
{ Get-PveUser -ErrorAction Stop } |
Should -Throw '*No active Proxmox VE session*'
}
@@ -115,151 +37,56 @@ Describe 'Get-PveUser' {
# New-PveUser
# ---------------------------------------------------------------------------
Describe 'New-PveUser' {
BeforeAll { $script:Cmd = Get-Command 'New-PveUser' -ErrorAction SilentlyContinue }
Context 'Command existence' {
It 'Should be available after module import' {
Skip-IfMissing 'New-PveUser'
$script:Cmd | Should -Not -BeNullOrEmpty
}
}
BeforeAll { $script:Cmd = Get-Command 'New-PveUser' }
Context 'ShouldProcess support' {
It 'Should support WhatIf' {
Skip-IfMissing 'New-PveUser'
$script:Cmd.Parameters.ContainsKey('WhatIf') | Should -BeTrue
}
}
Context 'Required parameters' {
It 'UserId should be Mandatory (must include realm, e.g. user@pam)' {
Skip-IfMissing 'New-PveUser'
$isMandatory = $script:Cmd.Parameters['UserId'].ParameterSets.Values |
Where-Object { $_.IsMandatory }
$isMandatory | Should -Not -BeNullOrEmpty
}
}
Context 'Optional parameters' {
It 'Should have Password parameter' {
Skip-IfMissing 'New-PveUser'
$hasPassword = $script:Cmd.Parameters.ContainsKey('Password') -or
$script:Cmd.Parameters.ContainsKey('Credential')
$hasPassword | Should -BeTrue
}
It 'Should have Email parameter' {
Skip-IfMissing 'New-PveUser'
$script:Cmd.Parameters.ContainsKey('Email') | Should -BeTrue
}
It 'Should have Groups parameter' {
Skip-IfMissing 'New-PveUser'
$script:Cmd.Parameters.ContainsKey('Groups') | Should -BeTrue
}
}
}
# ---------------------------------------------------------------------------
# Remove-PveUser
# ---------------------------------------------------------------------------
Describe 'Remove-PveUser' {
BeforeAll { $script:Cmd = Get-Command 'Remove-PveUser' -ErrorAction SilentlyContinue }
Context 'Command existence' {
It 'Should be available after module import' {
Skip-IfMissing 'Remove-PveUser'
$script:Cmd | Should -Not -BeNullOrEmpty
}
}
BeforeAll { $script:Cmd = Get-Command 'Remove-PveUser' }
Context 'ShouldProcess / ConfirmImpact' {
It 'Should support WhatIf' {
Skip-IfMissing 'Remove-PveUser'
$script:Cmd.Parameters.ContainsKey('WhatIf') | Should -BeTrue
}
It 'Should declare ConfirmImpact High' {
Skip-IfMissing 'Remove-PveUser'
$attr = $script:Cmd.ImplementingType.GetCustomAttributes(
[System.Management.Automation.CmdletAttribute], $false) |
Select-Object -First 1
$attr.ConfirmImpact | Should -Be ([System.Management.Automation.ConfirmImpact]::High)
}
}
Context 'Required parameters' {
It 'UserId should be Mandatory' {
Skip-IfMissing 'Remove-PveUser'
$isMandatory = $script:Cmd.Parameters['UserId'].ParameterSets.Values |
Where-Object { $_.IsMandatory }
$isMandatory | Should -Not -BeNullOrEmpty
}
}
}
# ---------------------------------------------------------------------------
# Set-PveUser
# ---------------------------------------------------------------------------
Describe 'Set-PveUser' {
BeforeAll { $script:Cmd = Get-Command 'Set-PveUser' -ErrorAction SilentlyContinue }
Context 'Command existence' {
It 'Should be available after module import' {
Skip-IfMissing 'Set-PveUser'
$script:Cmd | Should -Not -BeNullOrEmpty
}
}
BeforeAll { $script:Cmd = Get-Command 'Set-PveUser' }
Context 'ShouldProcess support' {
It 'Should support WhatIf' {
Skip-IfMissing 'Set-PveUser'
$script:Cmd.Parameters.ContainsKey('WhatIf') | Should -BeTrue
}
}
Context 'Required parameters' {
It 'UserId should be Mandatory' {
Skip-IfMissing 'Set-PveUser'
$isMandatory = $script:Cmd.Parameters['UserId'].ParameterSets.Values |
Where-Object { $_.IsMandatory }
$isMandatory | Should -Not -BeNullOrEmpty
}
}
}
# ---------------------------------------------------------------------------
# Get-PveRole
# ---------------------------------------------------------------------------
Describe 'Get-PveRole' {
BeforeAll { $script:Cmd = Get-Command 'Get-PveRole' -ErrorAction SilentlyContinue }
Context 'Command existence' {
It 'Should be available after module import' {
Skip-IfMissing 'Get-PveRole'
$script:Cmd | Should -Not -BeNullOrEmpty
}
}
Context 'Parameter metadata' {
It 'Should have RoleId parameter (optional filter)' {
Skip-IfMissing 'Get-PveRole'
$script:Cmd.Parameters.ContainsKey('RoleId') | Should -BeTrue
}
It 'Should have Session parameter' {
Skip-IfMissing 'Get-PveRole'
$script:Cmd.Parameters.ContainsKey('Session') | Should -BeTrue
}
}
BeforeAll { $script:Cmd = Get-Command 'Get-PveRole' }
Context 'Without active session' {
It 'Should throw when no session is active' {
Skip-IfMissing 'Get-PveRole'
{ Get-PveRole -ErrorAction Stop } |
Should -Throw '*No active Proxmox VE session*'
}
@@ -270,36 +97,10 @@ Describe 'Get-PveRole' {
# Get-PvePermission
# ---------------------------------------------------------------------------
Describe 'Get-PvePermission' {
BeforeAll { $script:Cmd = Get-Command 'Get-PvePermission' -ErrorAction SilentlyContinue }
Context 'Command existence' {
It 'Should be available after module import' {
Skip-IfMissing 'Get-PvePermission'
$script:Cmd | Should -Not -BeNullOrEmpty
}
}
Context 'Parameter metadata' {
It 'Should have UserId parameter' {
Skip-IfMissing 'Get-PvePermission'
$script:Cmd.Parameters.ContainsKey('UserId') | Should -BeTrue
}
It 'Should have Path parameter (ACL path, optional)' {
Skip-IfMissing 'Get-PvePermission'
$script:Cmd.Parameters.ContainsKey('Path') | Should -BeTrue
}
It 'Should have Session parameter' {
Skip-IfMissing 'Get-PvePermission'
$script:Cmd.Parameters.ContainsKey('Session') | Should -BeTrue
}
}
BeforeAll { $script:Cmd = Get-Command 'Get-PvePermission' }
Context 'Without active session' {
It 'Should throw when no session is active' {
Skip-IfMissing 'Get-PvePermission'
{ Get-PvePermission -ErrorAction Stop } |
Should -Throw '*No active Proxmox VE session*'
}
@@ -310,36 +111,11 @@ Describe 'Get-PvePermission' {
# Set-PvePermission
# ---------------------------------------------------------------------------
Describe 'Set-PvePermission' {
BeforeAll { $script:Cmd = Get-Command 'Set-PvePermission' -ErrorAction SilentlyContinue }
Context 'Command existence' {
It 'Should be available after module import' {
Skip-IfMissing 'Set-PvePermission'
$script:Cmd | Should -Not -BeNullOrEmpty
}
}
BeforeAll { $script:Cmd = Get-Command 'Set-PvePermission' }
Context 'ShouldProcess support' {
It 'Should support WhatIf' {
Skip-IfMissing 'Set-PvePermission'
$script:Cmd.Parameters.ContainsKey('WhatIf') | Should -BeTrue
}
}
Context 'Required parameters' {
It 'Path should be Mandatory (the ACL path, e.g. / or /vms/100)' {
Skip-IfMissing 'Set-PvePermission'
$isMandatory = $script:Cmd.Parameters['Path'].ParameterSets.Values |
Where-Object { $_.IsMandatory }
$isMandatory | Should -Not -BeNullOrEmpty
}
It 'Role should be Mandatory' {
Skip-IfMissing 'Set-PvePermission'
$isMandatory = $script:Cmd.Parameters['Role'].ParameterSets.Values |
Where-Object { $_.IsMandatory }
$isMandatory | Should -Not -BeNullOrEmpty
}
}
}