Tests/Unit/BMD_cFSRMFileScreenTemplateAction.Tests.ps1
|
$DSCResourceName = 'BMD_cFSRMFileScreenTemplateAction' $DSCModuleName = 'cFSRM' #region HEADER if ( (-not (Test-Path -Path '.\DSCResource.Tests\')) -or ` (-not (Test-Path -Path '.\DSCResource.Tests\TestHelper.psm1')) ) { & git @('clone','https://github.com/PlagueHO/DscResource.Tests.git') } Import-Module .\DSCResource.Tests\TestHelper.psm1 -Force $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName $DSCModuleName ` -DSCResourceName $DSCResourceName ` -TestType Unit #endregion # Begin Testing try { #region Pester Tests InModuleScope $DSCResourceName { # Create the Mock Objects that will be used for running tests # General purpose Action Mocks $Global:MockEmail = New-CimInstance ` -ClassName 'MSFT_FSRMAction' ` -Namespace Root/Microsoft/Windows/FSRM ` -ClientOnly ` -Property @{ Type = 'Email' Subject = '[FileScreen Threshold]% FileScreen threshold exceeded' Body = 'User [Source Io Owner] has exceed the [FileScreen Threshold]% FileScreen threshold for FileScreen on [FileScreen Path] on server [Server]. The FileScreen limit is [FileScreen Limit MB] MB and the current usage is [FileScreen Used MB] MB ([FileScreen Used Percent]% of limit).' MailBCC = '' MailCC = 'fileserveradmins@contoso.com' MailTo = '[Source Io Owner Email]' } $Global:MockCommand = New-CimInstance ` -ClassName 'MSFT_FSRMAction' ` -Namespace Root/Microsoft/Windows/FSRM ` -ClientOnly ` -Property @{ Type = 'Command' Command = 'c:\dothis.cmd' CommandParameters = '' KillTimeOut = 60 RunLimitInterval = 3600 SecurityLevel = 'LocalSystem' ShouldLogError = $true WorkingDirectory = 'c:\' } $Global:MockEvent = New-CimInstance ` -ClassName 'MSFT_FSRMAction' ` -Namespace Root/Microsoft/Windows/FSRM ` -ClientOnly ` -Property @{ Type = 'Event' Body = 'User [Source Io Owner] has exceed the [FileScreen Threshold]% FileScreen threshold for FileScreen on [FileScreen Path] on server [Server]. The FileScreen limit is [FileScreen Limit MB] MB and the current usage is [FileScreen Used MB] MB ([FileScreen Used Percent]% of limit).' EventType = 'Warning' } $Global:MockReport = New-CimInstance ` -ClassName 'MSFT_FSRMAction' ` -Namespace Root/Microsoft/Windows/FSRM ` -ClientOnly ` -Property @{ Type = 'Report' ReportTypes = @('DuplicateFiles','LargeFiles','FileScreenUsage') } # File Screen Template mocks $Global:MockFileScreenTemplate = New-CimInstance ` -ClassName 'MSFT_FSRMFileScreenTemplate' ` -Namespace Root/Microsoft/Windows/FSRM ` -ClientOnly ` -Property @{ Name = 'Block Some Files' Description = 'File Screen Templates for Blocking Some Files' Ensure = 'Present' Active = $True IncludeGroup = @( 'Audio and Video Files','Executable Files','Backup Files' ) Notification = [Microsoft.Management.Infrastructure.CimInstance[]]@( $Global:MockEmail,$Global:MockCommand,$Global:MockEvent ) } $Global:TestFileScreenTemplateActionEmail = [PSObject]@{ Name = $Global:MockFileScreenTemplate.Name Type = 'Email' } $Global:TestFileScreenTemplateActionSetEmail = $Global:TestFileScreenTemplateActionEmail.Clone() $Global:TestFileScreenTemplateActionSetEmail += [PSObject]@{ Ensure = 'Present' Subject = $Global:MockEmail.Subject Body = $Global:MockEmail.Body MailBCC = $Global:MockEmail.MailBCC MailCC = $Global:MockEmail.MailCC MailTo = $Global:MockEmail.MailTo } $Global:TestFileScreenTemplateActionEvent = [PSObject]@{ Name = $Global:MockFileScreenTemplate.Name Type = 'Event' } $Global:TestFileScreenTemplateActionSetEvent = $Global:TestFileScreenTemplateActionEvent.Clone() $Global:TestFileScreenTemplateActionSetEvent += [PSObject]@{ Ensure = 'Present' Body = $Global:MockEvent.Body EventType = $Global:MockEvent.EventType } $Global:TestFileScreenTemplateActionCommand = [PSObject]@{ Name = $Global:MockFileScreenTemplate.Name Type = 'Command' } $Global:TestFileScreenTemplateActionSetCommand = $Global:TestFileScreenTemplateActionCommand.Clone() $Global:TestFileScreenTemplateActionSetCommand += [PSObject]@{ Ensure = 'Present' Command = $Global:MockCommand.Command CommandParameters = $Global:MockCommand.CommandParameters KillTimeOut = $Global:MockCommand.KillTimeOut RunLimitInterval = $Global:MockCommand.RunLimitInterval SecurityLevel = $Global:MockCommand.SecurityLevel ShouldLogError = $Global:MockCommand.ShouldLogError WorkingDirectory = $Global:MockCommand.WorkingDirectory } $Global:TestFileScreenTemplateActionReport = [PSObject]@{ Name = $Global:MockFileScreenTemplate.Name Type = 'Report' } $Global:TestFileScreenTemplateActionSetReport = $Global:TestFileScreenTemplateActionReport.Clone() $Global:TestFileScreenTemplateActionSetReport += [PSObject]@{ Ensure = 'Present' ReportTypes = $Global:MockReport.ReportTypes } Describe 'BMD_cFSRMFileScreenTemplateAction\Get-TargetResource' { Context 'File Screen template does not exist' { Mock Get-FsrmFileScreenTemplate { throw (New-Object -TypeName Microsoft.PowerShell.Cmdletization.Cim.CimJobException) } It 'should throw FileScreenTemplateNotFound exception' { $Splat = $Global:TestFileScreenTemplateActionEmail.Clone() $errorId = 'FileScreenTemplateNotFound' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.FileScreenTemplateNotFoundError) ` -f $Splat.Name,$Splat.$Splat.Type $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null { $Result = Get-TargetResource @Splat } | Should Throw $errorRecord } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists but action does not' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return absent File Screen template action' { $Splat = $Global:TestFileScreenTemplateActionReport.Clone() $Result = Get-TargetResource @Splat $Result.Ensure | Should Be 'Absent' } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template and action exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return correct File Screen template action' { $Splat = $Global:TestFileScreenTemplateActionEmail.Clone() $Result = Get-TargetResource @Splat $Result.Ensure | Should Be 'Present' $Result.Type = 'Email' $Result.Subject = $Global:MockEmail.Subject $Result.Body = $Global:MockEmail.Body $Result.MailBCC = $Global:MockEmail.MailBCC $Result.MailCC = $Global:MockEmail.MailCC $Result.MailTo = $Global:MockEmail.MailTo } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } } Describe 'BMD_cFSRMFileScreenTemplateAction\Set-TargetResource' { Context 'File Screen template does not exist' { Mock Get-FsrmFileScreenTemplate -MockWith { throw (New-Object -TypeName Microsoft.PowerShell.Cmdletization.Cim.CimJobException) } Mock Set-FsrmFileScreenTemplate It 'should throw FileScreenTemplateNotFound exception' { $Splat = $Global:TestFileScreenTemplateActionEmail.Clone() $errorId = 'FileScreenTemplateNotFound' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.FileScreenTemplateNotFoundError) ` -f $Splat.Name,$Splat.Type $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null { Set-TargetResource @Splat } | Should Throw $errorRecord } It 'should call expected Mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 Assert-MockCalled -commandName Set-FsrmFileScreenTemplate -Exactly 0 } } Context 'File Screen template exists but action does not' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } Mock Set-FsrmFileScreenTemplate It 'should not throw exception' { $Splat = $Global:TestFileScreenTemplateActionSetEvent.Clone() $Splat.Type = 'Event' { Set-TargetResource @Splat } | Should Not Throw } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 Assert-MockCalled -commandName Set-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } Mock Set-FsrmFileScreenTemplate It 'should not throw exception' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() { Set-TargetResource @Splat } | Should Not Throw } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 Assert-MockCalled -commandName Set-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action exists but should not' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } Mock Set-FsrmFileScreenTemplate It 'should not throw exception' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() $Splat.Ensure = 'Absent' { Set-TargetResource @Splat } | Should Not Throw } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 Assert-MockCalled -commandName Set-FsrmFileScreenTemplate -Exactly 1 } } } Describe 'BMD_cFSRMFileScreenTemplateAction\Test-TargetResource' { Context 'File Screen template does not exist' { Mock Get-FsrmFileScreenTemplate -MockWith { throw (New-Object -TypeName Microsoft.PowerShell.Cmdletization.Cim.CimJobException) } It 'should throw FileScreenTemplateNotFound exception' { $Splat = $Global:TestFileScreenTemplateActionEmail.Clone() $errorId = 'FileScreenTemplateNotFound' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.FileScreenTemplateNotFoundError) ` -f $Splat.Name,$Splat.Type $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null { Test-TargetResource @Splat } | Should Throw $errorRecord } It 'should call expected Mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists but action does not' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetReport.Clone() Test-TargetResource @Splat | Should Be $False } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and matching action exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return true' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() Test-TargetResource @Splat | Should Be $true } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different Subject exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() $Splat.Subject = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different Body exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() $Splat.Body = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different Mail BCC exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() $Splat.MailBCC = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different Mail CC exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() $Splat.MailCC = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different Mail To exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() $Splat.MailTo = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different Command exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetCommand.Clone() $Splat.Command = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different CommandParameters exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetCommand.Clone() $Splat.CommandParameters = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different KillTimeOut exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetCommand.Clone() $Splat.KillTimeOut = $Splat.KillTimeOut+1 Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different RunLimitInterval exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetCommand.Clone() $Splat.RunLimitInterval = $Splat.RunLimitInterval+1 Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different SecurityLevel exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetCommand.Clone() $Splat.SecurityLevel = 'NetworkService' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different ShouldLogError exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetCommand.Clone() $Splat.ShouldLogError = (-not $Splat.ShouldLogError) Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different WorkingDirectory exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetCommand.Clone() $Splat.WorkingDirectory = 'Different' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action with different ReportTypes exists' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetReport.Clone() $Splat.ReportTypes = @( 'LeastRecentlyAccessed' ) Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } Context 'File Screen template exists and action exists but should not' { Mock Get-FsrmFileScreenTemplate -MockWith { return @($Global:MockFileScreenTemplate) } It 'should return false' { $Splat = $Global:TestFileScreenTemplateActionSetEmail.Clone() $Splat.Ensure = 'Absent' Test-TargetResource @Splat | Should Be $false } It 'should call the expected mocks' { Assert-MockCalled -commandName Get-FsrmFileScreenTemplate -Exactly 1 } } } } #endregion } finally { #region FOOTER Restore-TestEnvironment -TestEnvironment $TestEnvironment #endregion } |