Tests/Host/SSH-Warning.Vester.ps1

# Test file for the Vester module - https://github.com/WahlNetwork/Vester
# Called via Invoke-Pester VesterTemplate.Tests.ps1

# Test title, e.g. 'DNS Servers'
$Title = 'SSH Warning'

# Test description: How New-VesterConfig explains this value to the user
$Description = 'On/off switch for the vSphere warning when a host has SSH enabled'

# The config entry stating the desired values
$Desired = $cfg.host.sshwarn

# The test value's data type, to help with conversion: bool/string/int
$Type = 'int'

# The command(s) to pull the actual value for comparison
# $Object will scope to the folder this test is in (Cluster, Host, etc.)
[ScriptBlock]$Actual = {
    (Get-AdvancedSetting -Entity $Object | Where-Object -FilterScript {
        $_.Name -eq 'UserVars.SuppressShellWarning'
    }).Value
}

# The command(s) to match the environment to the config
# Use $Object to help filter, and $Desired to set the correct value
[ScriptBlock]$Fix = {
    Get-AdvancedSetting -Entity $Object | Where-Object -FilterScript {
            $_.Name -eq 'UserVars.SuppressShellWarning'
        } | Set-AdvancedSetting -Value $Desired -Confirm:$false -ErrorAction Stop
}