Tests/Unit/MSFT_AdfsApplicationPermission.Tests.ps1
|
$Global:DSCModuleName = 'AdfsDsc' $Global:PSModuleName = 'ADFS' $Global:DSCResourceName = 'MSFT_AdfsApplicationPermission' $moduleRoot = Split-Path -Parent (Split-Path -Parent (Split-Path -Parent $Script:MyInvocation.MyCommand.Path)) if ( (-not (Test-Path -Path (Join-Path -Path $moduleRoot -ChildPath 'DSCResource.Tests'))) -or ` (-not (Test-Path -Path (Join-Path -Path $moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) ) { & git @('clone', 'https://github.com/PowerShell/DscResource.Tests.git', (Join-Path -Path $moduleRoot -ChildPath '\DSCResource.Tests\')) } Import-Module (Join-Path -Path $moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force $TestEnvironment = Initialize-TestEnvironment ` -DSCModuleName $Global:DSCModuleName ` -DSCResourceName $Global:DSCResourceName ` -TestType Unit try { InModuleScope $Global:DSCResourceName { # Import Stub Module Import-Module (Join-Path -Path $PSScriptRoot -ChildPath "Stubs\$($Global:PSModuleName)Stub.psm1") -Force # Define Resource Commands $ResourceCommand = @{ Get = 'Get-AdfsApplicationPermission' Set = 'Set-AdfsApplicationPermission' Add = 'Grant-AdfsApplicationPermission' Remove = 'Revoke-AdfsApplicationPermission' } $mockResource = @{ ClientRoleIdentifier = 'NativeApp1' ServerRoleIdentifier = 'https://nativeapp1.contoso.com' Description = "This is the AppPermission1 Description" ScopeNames = 'openid' Ensure = 'Present' } $mockAbsentResource = @{ ClientRoleIdentifier = $mockResource.ClientRoleIdentifier ServerRoleIdentifier = $mockResource.ServerRoleIdentifier Description = $null ScopeNames = @() Ensure = 'Absent' } $mockChangedResource = @{ Description = "This is the new AppPermission1 Description" ScopeNames = 'openid, profile' } $mockGetTargetResourceResult = @{ ClientRoleIdentifier = $mockResource.ClientRoleIdentifier ServerRoleIdentifier = $mockResource.ServerRoleIdentifier Description = $mockResource.Description ScopeNames = $mockResource.ScopeNames } $mockGetTargetResourcePresentResult = $mockGetTargetResourceResult.Clone() $mockGetTargetResourcePresentResult.Ensure = 'Present' $mockGetTargetResourceAbsentResult = $mockGetTargetResourceResult.Clone() $mockGetTargetResourceAbsentResult.Ensure = 'Absent' Describe "$Global:DSCResourceName\Get-TargetResource" -Tag 'Get' { BeforeAll { $getTargetResourceParameters = @{ ClientRoleIdentifier = $mockResource.ClientRoleIdentifier ServerRoleIdentifier = $mockResource.ServerRoleIdentifier } $mockGetResourceCommandResult = @{ ClientRoleIdentifier = $mockResource.ClientRoleIdentifier ServerRoleIdentifier = $mockResource.ServerRoleIdentifier Description = $mockResource.Description ScopeNames = $mockResource.ScopeNames } Mock -CommandName Assert-Module Mock -CommandName Assert-Command Mock -CommandName "Assert-$($Global:PSModuleName)Service" } Context 'When the Resource is Present' { BeforeAll { Mock -CommandName $ResourceCommand.Get -MockWith { $mockGetResourceCommandResult } } $result = Get-TargetResource @getTargetResourceParameters foreach ($property in $mockResource.Keys) { It "Should return the correct $property property" { $result.$property | Should -Be $mockResource.$property } } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Assert-Module ` -ParameterFilter { $ModuleName -eq $Global:PSModuleName } ` -Exactly -Times 1 Assert-MockCalled -CommandName Assert-Command ` -ParameterFilter { $Module -eq $Global:PSModuleName -and $Command -eq $ResourceCommand.Get } ` -Exactly -Times 1 Assert-MockCalled -CommandName "Assert-$($Global:PSModuleName)Service" -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Get ` -ParameterFilter { ` $ClientRoleIdentifiers -eq $getTargetResourceParameters.ClientRoleIdentifier } ` -Exactly -Times 1 } } Context 'When the Resource is Absent' { BeforeAll { Mock -CommandName $ResourceCommand.Get $result = Get-TargetResource @GetTargetResourceParameters } foreach ($property in $mockResource.Keys) { It "Should return the correct $property property" { $result.$property | Should -Be $mockAbsentResource.$property } } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Assert-Module ` -ParameterFilter { $ModuleName -eq $Global:PSModuleName } ` -Exactly -Times 1 Assert-MockCalled -CommandName Assert-Command ` -ParameterFilter { $Module -eq $Global:PSModuleName -and $Command -eq $ResourceCommand.Get } ` -Exactly -Times 1 Assert-MockCalled -CommandName "Assert-$($Global:PSModuleName)Service" -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Get ` -ParameterFilter { ` $ClientRoleIdentifiers -eq $getTargetResourceParameters.ClientRoleIdentifier } ` -Exactly -Times 1 } } } Describe "$Global:DSCResourceName\Set-TargetResource" -Tag 'Set' { BeforeAll { $setTargetResourceParameters = @{ ClientRoleIdentifier = $mockResource.ClientRoleIdentifier ServerRoleIdentifier = $mockResource.ServerRoleIdentifier Description = $mockResource.Description ScopeNames = $mockResource.ScopeNames } $setTargetResourcePresentParameters = $setTargetResourceParameters.Clone() $setTargetResourcePresentParameters.Ensure = 'Present' $setTargetResourceAbsentParameters = $setTargetResourceParameters.Clone() $setTargetResourceAbsentParameters.Ensure = 'Absent' Mock -CommandName $ResourceCommand.Set Mock -CommandName $ResourceCommand.Add Mock -CommandName $ResourceCommand.Remove } Context 'When the Resource is Present' { BeforeAll { Mock -CommandName Get-TargetResource -MockWith { $mockGetTargetResourcePresentResult } } Context 'When the Resource should be Present' { foreach ($property in $mockChangedResource.Keys) { Context "When $property has changed" { BeforeAll { $setTargetResourceParametersChangedProperty = $setTargetResourcePresentParameters.Clone() $setTargetResourceParametersChangedProperty.$property = $mockChangedResource.$property } It 'Should not throw' { { Set-TargetResource @setTargetResourceParametersChangedProperty } | Should -Not -Throw } It 'Should call the correct mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $setTargetResourcePresentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $setTargetResourcePresentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Set ` -ParameterFilter { ` $TargetClientRoleIdentifier -eq $setTargetResourcePresentParameters.ClientRoleIdentifier -and ` $TargetServerRoleIdentifier -eq $setTargetResourcePresentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Add -Exactly -Times 0 Assert-MockCalled -CommandName $ResourceCommand.Remove -Exactly -Times 0 } } } } Context 'When the Resource should be Absent' { It 'Should not throw' { { Set-TargetResource @setTargetResourceAbsentParameters } | Should -Not -Throw } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $setTargetResourceAbsentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $setTargetResourceAbsentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Remove ` -ParameterFilter { $TargetClientRoleIdentifier -eq $setTargetResourceAbsentParameters.ClientRoleIdentifier -and ` $TargetServerRoleIdentifier -eq $setTargetResourceAbsentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Set -Exactly -Times 0 Assert-MockCalled -CommandName $ResourceCommand.Add -Exactly -Times 0 } } } Context 'When the Resource is Absent' { BeforeAll { Mock -CommandName Get-TargetResource -MockWith { $mockGetTargetResourceAbsentResult } } Context 'When the Resource should be Present' { It 'Should not throw' { { Set-TargetResource @setTargetResourcePresentParameters } | Should -Not -Throw } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $setTargetResourcePresentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $setTargetResourcePresentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Add ` -ParameterFilter { ` $ClientRoleIdentifier -eq $setTargetResourcePresentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $setTargetResourcePresentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Set -Exactly -Times 0 Assert-MockCalled -CommandName $ResourceCommand.Remove -Exactly -Times 0 } } Context 'When the Resource should be Absent' { It 'Should not throw' { { Set-TargetResource @setTargetResourceAbsentParameters } | Should -Not -Throw } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $setTargetResourceAbsentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $setTargetResourceAbsentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 Assert-MockCalled -CommandName $ResourceCommand.Remove -Exactly -Times 0 Assert-MockCalled -CommandName $ResourceCommand.Add -Exactly -Times 0 Assert-MockCalled -CommandName $ResourceCommand.Set -Exactly -Times 0 } } } } Describe "$Global:DSCResourceName\Test-TargetResource" -Tag 'Test' { BeforeAll { $testTargetResourceParameters = @{ ClientRoleIdentifier = $mockResource.ClientRoleIdentifier ServerRoleIdentifier = $mockResource.ServerRoleIdentifier Description = $mockResource.Description ScopeNames = $mockResource.ScopeNames } $testTargetResourcePresentParameters = $testTargetResourceParameters.Clone() $testTargetResourcePresentParameters.Ensure = 'Present' $testTargetResourceAbsentParameters = $testTargetResourceParameters.Clone() $testTargetResourceAbsentParameters.Ensure = 'Absent' } Context 'When the Resource is Present' { BeforeAll { Mock -CommandName Get-TargetResource -MockWith { $mockGetTargetResourcePresentResult } } Context 'When the Resource should be Present' { It 'Should not throw' { { Test-TargetResource @testTargetResourcePresentParameters } | Should -Not -Throw } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $testTargetResourcePresentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $testTargetResourcePresentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 } foreach ($property in $mockChangedResource.Keys) { Context "When the $property resource property is not in the desired state" { BeforeAll { $testTargetResourceNotInDesiredStateParameters = $testTargetResourcePresentParameters.Clone() $testTargetResourceNotInDesiredStateParameters.$property = $mockChangedResource.$property } It 'Should return the desired result' { Test-TargetResource @testTargetResourceNotInDesiredStateParameters | Should -Be $false } } } Context 'When all the resource properties are in the desired state' { It 'Should return the desired result' { Test-TargetResource @testTargetResourcePresentParameters | Should -Be $true } } } Context 'When the Resource should be Absent' { It 'Should return the desired result' { Test-TargetResource @testTargetResourceAbsentParameters | Should -Be $false } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $testTargetResourceAbsentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $testTargetResourceAbsentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 } } } Context 'When the Resource is Absent' { BeforeAll { Mock -CommandName Get-TargetResource -MockWith { $mockGetTargetResourceAbsentResult } } Context 'When the Resource should be Present' { It 'Should return return the desired result' { Test-TargetResource @testTargetResourcePresentParameters | Should -Be $false } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $testTargetResourcePresentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $testTargetResourcePresentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 } } Context 'When the Resource should be Absent' { It 'Should return return the desired result' { Test-TargetResource @testTargetResourceAbsentParameters | Should -Be $true } It 'Should call the expected mocks' { Assert-MockCalled -CommandName Get-TargetResource ` -ParameterFilter { ` $ClientRoleIdentifier -eq $testTargetResourceAbsentParameters.ClientRoleIdentifier -and ` $ServerRoleIdentifier -eq $testTargetResourceAbsentParameters.ServerRoleIdentifier } ` -Exactly -Times 1 } } } } } } finally { Restore-TestEnvironment -TestEnvironment $TestEnvironment } |