Tests/Integration/MSFT_xEnvironmentResource.Integration.Tests.ps1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# These tests must be run with elevated access $errorActionPreference = 'Stop' Set-StrictMode -Version 'Latest' # Import CommonTestHelper for Enter-DscResourceTestEnvironment, Exit-DscResourceTestEnvironment $script:testsFolderFilePath = Split-Path $PSScriptRoot -Parent $script:commonTestHelperFilePath = Join-Path -Path $testsFolderFilePath -ChildPath 'CommonTestHelper.psm1' Import-Module -Name $commonTestHelperFilePath $script:testEnvironment = Enter-DscResourceTestEnvironment ` -DscResourceModuleName 'xPSDesiredStateConfiguration' ` -DscResourceName 'MSFT_xEnvironmentResource' ` -TestType 'Integration' try { Describe 'xEnvironment Integration Tests' { BeforeAll { # Import environment resource module for Get-TargetResource, Test-TargetResource, Set-TargetResource $moduleRootFilePath = Split-Path -Path (Split-Path $PSScriptRoot -Parent) -Parent $dscResourcesFolderFilePath = Join-Path -Path $moduleRootFilePath -ChildPath 'DscResources' $environmentResourceFolderFilePath = Join-Path -Path $dscResourcesFolderFilePath -ChildPath 'MSFT_xEnvironmentResource' $environmentResourceModuleFilePath = Join-Path -Path $environmentResourceFolderFilePath -ChildPath 'MSFT_xEnvironmentResource.psm1' Import-Module -Name $environmentResourceModuleFilePath -Force } It 'Should return the correct value for an environment variable that exists' { $envVar = 'Username' $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable $envVar is successfully retrieved $retrievedVar.Ensure | Should Be 'Present' $regItem = Get-Item -Path 'HKLM:\\System\\CurrentControlSet\\Control\\Session Manager\\Environment' $matchVar = $regItem.GetValue($envVar) $retrievedVarValue = $retrievedVar.Value # Verify the $retrievedVar environmnet variable value matches the value retrieved using [Environment] API $retrievedVarValue | Should Be $matchVar } It 'Should return Absent for an environment variable that does not exists' { $envVar = 'BlahVar' Set-TargetResource -Name $envVar -Ensure Absent $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable $envVar is not found $retrievedVar.Ensure | Should Be 'Absent' } It 'Should throw an error when creating a new environment variable with no Value specified' { # Ensure the variable does not already exist $envVar = 'TestEnvVar' Set-TargetResource -Name $envVar -Ensure Absent { Set-TargetResource -Name $envVar } | Should Throw # Now retrieve the created variable $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable $envVar is successfully created $retrievedVar.Ensure | Should Be 'Absent' # Verify the create environmnet variable's value is set to default value [String]::Empty $retrievedVar.Value | Should Be $null # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should create a new environment variable with the Value specified' { $envVar = 'TestEnvVar' $val = 'TestEnvVal' # Ensure the value does not already exist Set-TargetResource -Name $envVar -Ensure Absent Set-TargetResource -Name $envVar -Value $val # Now retrieve the created variable $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable $envVar is successfully created $retrievedVar.Ensure | Should Be 'Present' # Verify the create environmnet variable's value is set $retrievedVar.Value | Should Be $val # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should update existing environment variable with new Value' { $envVar = 'TestEnvVar' $val = 'TestEnvVal' # Create the environment variable Set-TargetResource -Name $envVar -Value $val # Update the environment variable $newVal = 'TestEnvNewVal' Set-TargetResource -Name $envVar -Value $newVal # Now retrieve the created variable $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable $envVar is successfully updated $retrievedVar.Value | Should Be $newVal # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should Remove an existing environment variable (Ensure = Absent)' { $envVar = 'TestEnvVar' $val = 'TestEnvVal' # Create the environment variable Set-TargetResource -Name $envVar -Value $val Set-TargetResource -Name $envVar -Ensure Absent # Now try to retrieve the created variable $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable no more exists $retrievedVar.Ensure | Should Be 'Absent' } It 'Should update a path environment variable' { $envVar = 'TestEnvVar' $val = 'A;B;C' Set-TargetResource -Name $envVar -Value $val -Path $true $addPathVal = 'D' Set-TargetResource -Name $envVar -Value $addPathVal -Path $true $expectedFinalVal = $val + ';' + $addPathVal # Now try to retrieve the created variable $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable no more exists $retrievedVar.Value | Should Be $expectedFinalVal # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should remove a sub-path from a path environment variable' { $envVar = 'TestEnvVar' $val = 'A;B;C' Set-TargetResource -Name $envVar -Value $val -Path $true $removePathVal = 'C' Set-TargetResource -Name $envVar -Value $removePathVal -Path $true -Ensure Absent $expectedFinalVal = 'A;B' # Now try to retrieve the created variable $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable no more exists $retrievedVar.Value | Should Be $expectedFinalVal # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should remove a path environment variable by removing all its sub-paths' { $envVar = 'TestEnvVar' $val = 'A;B;C' Set-TargetResource -Name $envVar -Value $val -Path $true $removePathVal = 'C;B;A' Set-TargetResource -Name $envVar -Value $removePathVal -Path $true -Ensure Absent # Now try to retrieve the created variable $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable no more exists $retrievedVar.Ensure | Should Be 'Absent' # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should return true when an environment variable is present and should be' { $envVar = 'BlahVar' $val = 'A;B;C' Set-TargetResource -Name $envVar -Value $val # Test the created environmnet variable Test-TargetResource -Name $envVar | Should Be $true # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should return true when an environment environment with a specific value exists and should' { $envVar = 'BlahVar' $val = 'BlahVal' Set-TargetResource -Name $envVar -Value $val # Verify the environmnet variable exists Test-TargetResource -Name $envVar -Value $val | Should Be $true # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should return true when an environment variable is absent and should be' { $envVar = 'BlahVar' Set-TargetResource -Name $envVar -Ensure Absent # Verify the environmnet variable exists Test-TargetResource -Name $envVar -Ensure Absent | Should Be $true # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should return true when a path exists in a path environment variable and should' { $envVar = 'PathVar' $val = 'A;B;C' Set-TargetResource -Name $envVar -Value $val -Path $true $subpath = 'B' # Test a sub-path exists in environment variable Test-TargetResource -Name $envVar -Value $subpath -Path $true | Should Be $true # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should return true when a matching but shuffled path exists in a path environment variable' { $envVar = 'PathVar' $val = 'A;B;C' Set-TargetResource -Name $envVar -Value $val -Path $true $subpath = 'B;a;c' Test-TargetResource -Name $envVar -Value $subpath -Path $true | Should Be $true # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should return true when a path does not exist in a path environment variable and should not' { $envVar = 'PathVar' $val = 'A;B;C' Set-TargetResource -Name $envVar -Value $val -Path $true $subpath = 'D;E' Test-TargetResource -Name $envVar -Value $subpath -Path $true -Ensure Absent | Should Be $true # Remove the created test variable Set-TargetResource -Name $envVar -Ensure Absent } It 'Should retrieve an existing environment variable using Get-TargetResource' { $envVar = 'windir' $retrievedVar = Get-TargetResource -Name $envVar # Verify the environmnet variable $envVar is successfully retrieved $retrievedVar.Ensure | Should Be 'Present' $matchVar = '%SystemRoot%' $retrievedVarValue = $retrievedVar.Value # Verify the $retrievedVar environmnet variable value matches the value retrieved using [Environment] API $retrievedVarValue | Should Be $matchVar } } } finally { Exit-DscResourceTestEnvironment -TestEnvironment $script:testEnvironment } |