Tests/Integration/MSFT_WindowsFeature.Integration.Tests.ps1
|
<#
Integration tests for installing/uninstalling a Windows Feature. Currently Telnet-Client is set as the feature to test since it's fairly small and doesn't require a restart. ADRMS is set as the feature to test installing/uninstalling a feature with subfeatures, but this takes a good chunk of time, so by default these tests are set to be skipped. If there's any major changes to the resource, then set the skipLongTests variable to $false and run those tests at least once to test the new functionality more completely. #> # Suppressing this rule since we need to create a plaintext password to test this resource [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')] param () if ($PSVersionTable.PSVersion.Major -lt 5 -or $PSVersionTable.PSVersion.Minor -lt 1) { Write-Warning -Message 'Cannot run PSDscResources integration tests on PowerShell versions lower than 5.1' return } Import-Module -Name (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) ` -ChildPath (Join-Path -Path 'TestHelpers' ` -ChildPath 'CommonTestHelper.psm1')) ` $script:testEnvironment = Enter-DscResourceTestEnvironment ` -DscResourceModuleName 'PSDscResources' ` -DscResourceName 'MSFT_WindowsFeature' ` -TestType 'Integration' $script:testFeatureName = 'Telnet-Client' $script:testFeatureWithSubFeaturesName = 'ADRMS' $script:installStateOfTestFeature = $false $script:installStateOfTestWithSubFeatures = $false <# If this is set to $true then the tests for installing/uninstalling a feature with its subfeatures will not run. #> $script:skipLongTests = $false try { #Saving the state so we can clean up afterwards $testFeature = Get-WindowsFeature -Name $script:testFeatureName $script:installStateOfTestFeature = $testFeature.Installed $testFeatureWithSubFeatures = Get-WindowsFeature -Name $script:testFeatureWithSubFeaturesName $script:installStateOfTestWithSubFeatures = $testFeatureWithSubFeatures.Installed $configFile = Join-Path -Path $PSScriptRoot -ChildPath 'MSFT_WindowsFeature.config.ps1' Describe 'WindowsFeature Integration Tests' { $testIncludeAllSubFeature = $false Remove-WindowsFeature -Name $script:testFeatureName Context "Should Install the Windows Feature: $script:testFeatureName" { $configurationName = 'MSFT_WindowsFeature_InstallFeature' $configurationPath = Join-Path -Path $TestDrive -ChildPath $configurationName $logPath = Join-Path -Path $TestDrive -ChildPath 'InstallFeatureTest.log' try { # Ensure the feature is not already on the machine Remove-WindowsFeature -Name $script:testFeatureName It 'Should compile without throwing' { { . $configFile -ConfigurationName $configurationName & $configurationName -Name $script:testFeatureName ` -IncludeAllSubFeature $testIncludeAllSubFeature ` -Ensure 'Present' ` -OutputPath $configurationPath ` -ErrorAction 'Stop' Start-DscConfiguration -Path $configurationPath -ErrorAction 'Stop' -Wait -Force } | Should Not Throw } It 'Should be able to call Get-DscConfiguration without throwing' { { Get-DscConfiguration -ErrorAction 'Stop' } | Should Not Throw } It 'Should return the correct configuration' { $currentConfig = Get-DscConfiguration -ErrorAction 'Stop' $currentConfig.Name | Should Be $script:testFeatureName $currentConfig.IncludeAllSubFeature | Should Be $testIncludeAllSubFeature $currentConfig.Ensure | Should Be 'Present' } It 'Should be Installed' { $feature = Get-WindowsFeature -Name $script:testFeatureName $feature.Installed | Should Be $true } } finally { if (Test-Path -Path $logPath) { Remove-Item -Path $logPath -Recurse -Force } if (Test-Path -Path $configurationPath) { Remove-Item -Path $configurationPath -Recurse -Force } } } Context "Should Uninstall the Windows Feature: $script:testFeatureName" { $configurationName = 'MSFT_WindowsFeature_UninstallFeature' $configurationPath = Join-Path -Path $TestDrive -ChildPath $configurationName $logPath = Join-Path -Path $TestDrive -ChildPath 'UninstallFeatureTest.log' try { It 'Should compile without throwing' { { . $configFile -ConfigurationName $configurationName & $configurationName -Name $script:testFeatureName ` -IncludeAllSubFeature $testIncludeAllSubFeature ` -Ensure 'Absent' ` -OutputPath $configurationPath ` -ErrorAction 'Stop' Start-DscConfiguration -Path $configurationPath -ErrorAction 'Stop' -Wait -Force } | Should Not Throw } It 'Should be able to call Get-DscConfiguration without throwing' { { Get-DscConfiguration -ErrorAction 'Stop' } | Should Not Throw } It 'Should return the correct configuration' { $currentConfig = Get-DscConfiguration -ErrorAction 'Stop' $currentConfig.Name | Should Be $script:testFeatureName $currentConfig.IncludeAllSubFeature | Should Be $testIncludeAllSubFeature $currentConfig.Ensure | Should Be 'Absent' } It 'Should not be installed' { $feature = Get-WindowsFeature -Name $script:testFeatureName $feature.Installed | Should Be $false } } finally { if (Test-Path -Path $logPath) { Remove-Item -Path $logPath -Recurse -Force } if (Test-Path -Path $configurationPath) { Remove-Item -Path $configurationPath -Recurse -Force } } } Context "Should Install the Windows Feature: $script:testFeatureWithSubFeaturesName" { $configurationName = 'MSFT_WindowsFeature_InstallFeatureWithSubFeatures' $configurationPath = Join-Path -Path $TestDrive -ChildPath $configurationName $logPath = Join-Path -Path $TestDrive -ChildPath 'InstallSubFeatureTest.log' try { if (-not $script:skipLongTests) { # Ensure that the feature is not already installed Remove-WindowsFeature -Name $script:testFeatureWithSubFeaturesName } It 'Should compile without throwing' -Skip:$script:skipLongTests { { . $configFile -ConfigurationName $configurationName & $configurationName -Name $script:testFeatureWithSubFeaturesName ` -IncludeAllSubFeature $true ` -Ensure 'Present' ` -OutputPath $configurationPath ` -ErrorAction 'Stop' Start-DscConfiguration -Path $configurationPath -ErrorAction 'Stop' -Wait -Force } | Should Not Throw } It 'Should be able to call Get-DscConfiguration without throwing' -Skip:$script:skipLongTests { { Get-DscConfiguration -ErrorAction 'Stop' } | Should Not Throw } It 'Should return the correct configuration' -Skip:$script:skipLongTests { $currentConfig = Get-DscConfiguration -ErrorAction 'Stop' $currentConfig.Name | Should Be $script:testFeatureWithSubFeaturesName $currentConfig.IncludeAllSubFeature | Should Be $true $currentConfig.Ensure | Should Be 'Present' } It 'Should be Installed (includes check for subFeatures)' -Skip:$script:skipLongTests { $feature = Get-WindowsFeature -Name $script:testFeatureWithSubFeaturesName $feature.Installed | Should Be $true foreach ($subFeatureName in $feature.SubFeatures) { $subFeature = Get-WindowsFeature -Name $subFeatureName $subFeature.Installed | Should Be $true } } } finally { if (Test-Path -Path $logPath) { Remove-Item -Path $logPath -Recurse -Force } if (Test-Path -Path $configurationPath) { Remove-Item -Path $configurationPath -Recurse -Force } } } Context "Should Uninstall the Windows Feature: $script:testFeatureWithSubFeaturesName" { $configurationName = 'MSFT_WindowsFeature_UninstallFeatureWithSubFeatures' $configurationPath = Join-Path -Path $TestDrive -ChildPath $configurationName $logPath = Join-Path -Path $TestDrive -ChildPath 'UninstallSubFeatureTest.log' try { It 'Should compile without throwing' -Skip:$script:skipLongTests { { . $configFile -ConfigurationName $configurationName & $configurationName -Name $script:testFeatureWithSubFeaturesName ` -IncludeAllSubFeature $true ` -Ensure 'Absent' ` -OutputPath $configurationPath ` -ErrorAction 'Stop' Start-DscConfiguration -Path $configurationPath -ErrorAction 'Stop' -Wait -Force } | Should Not Throw } It 'Should be able to call Get-DscConfiguration without throwing' -Skip:$script:skipLongTests { { Get-DscConfiguration -ErrorAction 'Stop' } | Should Not Throw } It 'Should return the correct configuration' -Skip:$script:skipLongTests { $currentConfig = Get-DscConfiguration -ErrorAction 'Stop' $currentConfig.Name | Should Be $script:testFeatureWithSubFeaturesName $currentConfig.IncludeAllSubFeature | Should Be $false $currentConfig.Ensure | Should Be 'Absent' } It 'Should not be installed (includes check for subFeatures)' -Skip:$script:skipLongTests { $feature = Get-WindowsFeature -Name $script:testFeatureWithSubFeaturesName $feature.Installed | Should Be $false foreach ($subFeatureName in $feature.SubFeatures) { $subFeature = Get-WindowsFeature -Name $subFeatureName $subFeature.Installed | Should Be $false } } } finally { if (Test-Path -Path $logPath) { Remove-Item -Path $logPath -Recurse -Force } if (Test-Path -Path $configurationPath) { Remove-Item -Path $configurationPath -Recurse -Force } } } } } finally { # Ensure that features used for testing are re-installed/uninstalled if ($script:installStateOfTestFeature) { Add-WindowsFeature -Name $script:testFeatureName } else { Remove-WindowsFeature -Name $script:testFeatureName } if (-not $script:skipLongTests) { if ($script:installStateOfTestWithSubFeatures) { Add-WindowsFeature -Name $script:testFeatureWithSubFeaturesName -IncludeAllSubFeature } else { Remove-WindowsFeature -Name $script:testFeatureWithSubFeaturesName } } Exit-DscResourceTestEnvironment -TestEnvironment $script:testEnvironment } |