DFSDsc

4.3.0.0

Tests/Unit/MSFT_DFSReplicationGroupFolder.Tests.ps1

$script:DSCModuleName   = 'DFSDsc'
$script:DSCResourceName = 'MSFT_DFSReplicationGroupFolder'

#region HEADER
# Unit Test Template Version: 1.1.0
[System.String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)

if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
     (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
    & git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}

Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
    -DSCModuleName $script:DSCModuleName `
    -DSCResourceName $script:DSCResourceName `
    -TestType Unit
#endregion HEADER

# Begin Testing
try
{
    # Ensure that the tests can be performed on this computer
    $productType = (Get-CimInstance Win32_OperatingSystem).ProductType
    Describe 'Environment' {
        Context 'Operating System' {
            It 'Should be a Server OS' {
                $productType | Should -Be 3
            }
        }
    }

    if ($productType -ne 3)
    {
        break
    }

    $featureInstalled = (Get-WindowsFeature -Name FS-DFS-Replication).Installed
    Describe 'Environment' {
        Context 'Windows Features' {
            It 'Should have the DFS Replication Feature Installed' {
                $featureInstalled | Should -Be $true
            }
        }
    }

    if ($featureInstalled -eq $false)
    {
        break
    }

    $featureInstalled = (Get-WindowsFeature -Name RSAT-DFS-Mgmt-Con).Installed
    Describe 'Environment' {
        Context 'Windows Features' {
            It 'Should have the DFS Management Tools Feature Installed' {
                $featureInstalled | Should -Be $true
            }
        }
    }

    if ($featureInstalled -eq $false)
    {
        break
    }

    #region Pester Tests
    InModuleScope $script:DSCResourceName {
        # Create the Mock Objects that will be used for running tests
        $replicationGroup = [PSObject]@{
            GroupName = 'Test Group'
            Ensure = 'Present'
            DomainName = 'contoso.com'
            Description = 'Test Description'
            Members = @('FileServer1','FileServer2')
            Folders = @('Folder1','Folder2')
        }

        $mockReplicationGroupFolder = @(
            [PSObject]@{
                GroupName = $replicationGroup.GroupName
                DomainName = $replicationGroup.DomainName
                FolderName = $replicationGroup.Folders[0]
                Description = 'Description 1'
                FileNameToExclude = @('~*','*.bak','*.tmp')
                DirectoryNameToExclude = @()
                DfsnPath = "\\contoso.com\Namespace\$($replicationGroup.Folders[0])"
            },
            [PSObject]@{
                GroupName = $replicationGroup.GroupName
                DomainName = $replicationGroup.DomainName
                FolderName = $replicationGroup.Folders[1]
                Description = 'Description 2'
                FileNameToExclude = @('~*','*.bak','*.tmp')
                DirectoryNameToExclude = @()
                DfsnPath = "\\contoso.com\Namespace\$($replicationGroup.Folders[1])"
            }
        )

        Describe 'MSFT_DFSReplicationGroupFolder\Get-TargetResource' {
            Context 'Replication group folder does not exist' {
                Mock Get-DfsReplicatedFolder

                It 'Should throw RegGroupFolderMissingError error' {
                    $errorRecord = Get-InvalidOperationRecord `
                        -Message ($($LocalizedData.ReplicationGroupFolderMissingError) -f $mockReplicationGroupFolder[0].GroupName,$mockReplicationGroupFolder[0].FolderName)

                    {
                        $result = Get-TargetResource `
                            -GroupName $mockReplicationGroupFolder[0].GroupName `
                            -FolderName $mockReplicationGroupFolder[0].FolderName
                    } | Should -Throw $errorRecord
                }

                It 'Should call the expected mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Requested replication group does exist' {
                Mock Get-DfsReplicatedFolder -MockWith { return @($mockReplicationGroupFolder[0]) }

                It 'Should return correct replication group' {
                    $result = Get-TargetResource `
                        -GroupName $mockReplicationGroupFolder[0].GroupName `
                        -FolderName $mockReplicationGroupFolder[0].FolderName
                    $result.GroupName | Should -Be $mockReplicationGroupFolder[0].GroupName
                    $result.FolderName | Should -Be $mockReplicationGroupFolder[0].FolderName
                    $result.Description | Should -Be $mockReplicationGroupFolder[0].Description
                    $result.DomainName | Should -Be $mockReplicationGroupFolder[0].DomainName
                    <#
                        Tests disabled until this issue is resolved:
                        https://windowsserver.uservoice.com/forums/301869-powershell/suggestions/11088807-get-dscconfiguration-fails-with-embedded-cim-type
                    #>
                    if ($false) {
                        $result.FileNameToExclude | Should -Be $mockReplicationGroupFolder[0].FileNameToExclude
                        $result.DirectoryNameToExclude | Should -Be $mockReplicationGroupFolder[0].DirectoryNameToExclude
                    }
                }

                It 'Should call the expected mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }
        }

        Describe 'MSFT_DFSReplicationGroupFolder\Set-TargetResource' {
            Context 'Replication group folder exists but has different Description' {
                Mock Set-DfsReplicatedFolder

                It 'Should not throw error' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.Description = 'Different'
                    { Set-TargetResource @splat } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Set-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists but has different FileNameToExclude' {
                Mock Set-DfsReplicatedFolder

                It 'Should not throw error' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.FileNameToExclude = @('*.tmp')
                    { Set-TargetResource @splat } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Set-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists but has different DirectoryNameToExclude' {
                Mock Set-DfsReplicatedFolder

                It 'Should not throw error' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.DirectoryNameToExclude = @('*.tmp')
                    { Set-TargetResource @splat } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Set-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists but has different DfsnPath' {
                Mock Set-DfsReplicatedFolder

                It 'Should not throw error' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.DfsnPath = '\\contoso.com\Public\Different'
                    { Set-TargetResource @splat } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Set-DfsReplicatedFolder -Exactly -Times 1
                }
            }
        }

        Describe 'MSFT_DFSReplicationGroupFolder\Test-TargetResource' {
            Context 'Replication group folder does not exist' {
                Mock Get-DfsReplicatedFolder

                It 'Should throw RegGroupFolderMissingError error' {
                    $errorRecord = Get-InvalidOperationRecord `
                        -Message ($($LocalizedData.ReplicationGroupFolderMissingError) -f $mockReplicationGroupFolder[0].GroupName,$mockReplicationGroupFolder[0].FolderName)

                    $splat = $mockReplicationGroupFolder[0].Clone()
                    { Test-TargetResource @splat } | Should -Throw $errorRecord
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists and has no differences' {
                Mock Get-DfsReplicatedFolder -MockWith { return @($mockReplicationGroupFolder[0]) }

                It 'Should return true' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    Test-TargetResource @splat | Should -Be $True
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists but has different Description' {
                Mock Get-DfsReplicatedFolder -MockWith { return @($mockReplicationGroupFolder[0]) }

                It 'Should return false' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.Description = 'Different'
                    Test-TargetResource @splat | Should -Be $False
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists but has different FileNameToExclude' {
                Mock Get-DfsReplicatedFolder -MockWith { return @($mockReplicationGroupFolder[0]) }

                It 'Should return false' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.FileNameToExclude = @('*.tmp')
                    Test-TargetResource @splat | Should -Be $False
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists but has different DirectoryNameToExclude' {
                Mock Get-DfsReplicatedFolder -MockWith { return @($mockReplicationGroupFolder[0]) }

                It 'Should return false' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.DirectoryNameToExclude = @('*.tmp')
                    Test-TargetResource @splat | Should -Be $False
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }

            Context 'Replication group folder exists but has different DfsnPath' {
                Mock Get-DfsReplicatedFolder -MockWith { return @($mockReplicationGroupFolder[0]) }

                It 'Should return false' {
                    $splat = $mockReplicationGroupFolder[0].Clone()
                    $splat.DfsnPath = '\\contoso.com\Public\Different'
                    Test-TargetResource @splat | Should -Be $False
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -commandName Get-DfsReplicatedFolder -Exactly -Times 1
                }
            }
        }
    }
    #endregion
}
finally
{
    #region FOOTER
    Restore-TestEnvironment -TestEnvironment $TestEnvironment
    #endregion
}