NetworkingDsc

7.2.0.0

Tests/Unit/MSFT_NetBios.Tests.ps1

$script:DSCModuleName = 'NetworkingDsc'
$script:DSCResourceName = 'MSFT_NetBios'

Import-Module -Name (Join-Path -Path (Join-Path -Path (Split-Path $PSScriptRoot -Parent) -ChildPath 'TestHelpers') -ChildPath 'CommonTestHelper.psm1') -Global

#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 -Name (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
{
    #region Pester Tests
    InModuleScope $script:DSCResourceName {
        $interfaceAlias = 'Test Adapter'

        $mockNetadapter = New-Object `
            -TypeName CimInstance `
            -ArgumentList 'Win32_NetworkAdapter' |
            Add-Member `
            -MemberType NoteProperty `
            -Name Name `
            -Value $interfaceAlias `
            -PassThru

        $mockNetadapterSettingsDefault = New-Object `
            -TypeName CimInstance `
            -ArgumentList 'Win32_NetworkAdapterConfiguration' |
            Add-Member `
            -MemberType NoteProperty `
            -Name TcpipNetbiosOptions `
            -Value 0 `
            -PassThru

        $mockNetadapterSettingsEnable = New-Object `
            -TypeName CimInstance `
            -ArgumentList 'Win32_NetworkAdapterConfiguration' |
            Add-Member `
            -MemberType NoteProperty `
            -Name TcpipNetbiosOptions `
            -Value 1 `
            -PassThru

        $mockNetadapterSettingsDisable = New-Object `
            -TypeName CimInstance `
            -ArgumentList 'Win32_NetworkAdapterConfiguration' |
            Add-Member `
            -MemberType NoteProperty `
            -Name TcpipNetbiosOptions `
            -Value 2 `
            -PassThru

        #region Function Get-TargetResource
        Describe 'MSFT_NetBios\Get-TargetResource' {
            Context 'NetBios over TCP/IP is set to "Default"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsDefault}

                It 'Should not throw exception' {
                    {
                        $script:result = Get-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Default' -Verbose
                    } | Should -Not -Throw
                }

                It 'Returns a hashtable' {
                    $script:result -is [System.Collections.Hashtable] | Should -Be $true
                }

                It 'Setting should return "Default"' {
                    $script:result.Setting | Should -Be 'Default'
                }
            }

            Context 'NetBios over TCP/IP is set to "Enable"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsEnable }

                It 'Should not throw exception' {
                    {
                        $script:result = Get-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Default' -Verbose
                    } | Should -Not -Throw
                }

                It 'Returns a hashtable' {
                    $script:result -is [System.Collections.Hashtable] | Should -Be $true
                }

                It 'Setting should return "Enable"' {
                    $script:result.Setting | Should -Be 'Enable'
                }
            }

            Context 'NetBios over TCP/IP is set to "Disable"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsDisable }

                It 'Should not throw exception' {
                    {
                        $script:result = Get-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Default' -Verbose
                    } | Should -Not -Throw
                }

                It 'Returns a hashtable' {
                    $script:result -is [System.Collections.Hashtable] | Should -Be $true
                }

                It 'Setting should return "Disable"' {
                    $script:result.Setting | Should -Be 'Disable'
                }
            }

            Context 'Interface does not exist' {
                Mock -CommandName Get-CimInstance -MockWith { }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsDisable }

                $errorRecord = Get-InvalidOperationRecord `
                    -Message ($script:localizedData.InterfaceNotFoundError -f $interfaceAlias)

                It 'Should throw expected exception' {
                    {
                        $script:result = Get-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Default' -Verbose
                    } | Should -Throw $errorRecord
                }
            }
        }
        #endregion

        #region Function Test-TargetResource
        Describe 'MSFT_NetBios\Test-TargetResource' {
            Context 'NetBios over TCP/IP is set to "Default"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsDefault }

                It 'Should return true when value "Default" is set' {
                    Test-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Default' -Verbose | Should -Be $true
                }

                It 'Should return false when value "Disable" is set' {
                    Test-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Disable' -Verbose | Should -Be $false
                }
            }

            Context 'NetBios over TCP/IP is set to "Disable"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsDisable }

                It 'Should return true when value "Disable" is set' {
                    Test-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Disable' -Verbose | Should -Be $true
                }

                It 'Should return false when value "Enable" is set' {
                    Test-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Enable' -Verbose | Should -Be $false
                }
            }

            Context 'NetBios over TCP/IP is set to "Enable"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsEnable }

                It 'Should return true when value "Enable" is set' {
                    Test-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Enable' -Verbose | Should -Be $true
                }

                It 'Should return false when value "Disable" is set' {
                    Test-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Disable' -Verbose | Should -Be $false
                }
            }

            Context 'Interface does not exist' {
                Mock -CommandName Get-CimInstance -MockWith { }

                $errorRecord = Get-InvalidOperationRecord `
                    -Message ($script:localizedData.InterfaceNotFoundError -f $interfaceAlias)

                It 'Should throw expected exception' {
                    {
                        Test-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Enable' -Verbose
                    } | Should -Throw $errorRecord
                }
            }
        }
        #endregion

        #region Function Set-TargetResource
        Describe 'MSFT_NetBios\Set-TargetResource' {
            Context 'NetBios over TCP/IP should be set to "Default"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsEnable }
                Mock -CommandName Set-ItemProperty
                Mock -CommandName Invoke-CimMethod -MockWith { @{ ReturnValue = 0 } }

                It 'Should not throw exception' {
                    {
                        Set-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Default' -Verbose
                    } | Should -Not -Throw
                }

                It 'Should call "Set-ItemProperty" instead of "Invoke-CimMethod"' {
                    Assert-MockCalled -CommandName Set-ItemProperty -Exactly -Times 1
                    Assert-MockCalled -CommandName Invoke-CimMethod -Exactly -Times 0
                }
            }

            Context 'NetBios over TCP/IP should be set to "Disable"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsEnable }
                Mock -CommandName Set-ItemProperty
                Mock -CommandName Invoke-CimMethod -MockWith { @{ ReturnValue = 0 } }

                It 'Should not throw exception' {
                    {
                        Set-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Disable' -Verbose
                    } | Should -Not -Throw
                }

                It 'Should call "Invoke-CimMethod" instead of "Set-ItemProperty"' {
                    Assert-MockCalled -CommandName Set-ItemProperty -Exactly -Times 0
                    Assert-MockCalled -CommandName Invoke-CimMethod -Exactly -Times 1
                }
            }

            Context 'NetBios over TCP/IP should be set to "Enable"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsDisable }
                Mock -CommandName Set-ItemProperty
                Mock -CommandName Invoke-CimMethod -MockWith { @{ ReturnValue = 0 } }

                It 'Should not throw exception' {
                    {
                        Set-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Enable' -Verbose
                    } | Should -Not -Throw
                }

                It 'Should call "Invoke-CimMethod" instead of "Set-ItemProperty"' {

                    Assert-MockCalled -CommandName Set-ItemProperty -Exactly -Times 0
                    Assert-MockCalled -CommandName Invoke-CimMethod -Exactly -Times 1
                }
            }

            Context 'NetBios over TCP/IP should be set to "Enable" but error returned from "Invoke-CimMethod"' {
                Mock -CommandName Get-CimInstance -MockWith { $mockNetadapter }
                Mock -CommandName Get-CimAssociatedInstance -MockWith { $mockNetadapterSettingsDisable }
                Mock -CommandName Invoke-CimMethod -MockWith { @{ ReturnValue = 74 } }
                Mock -CommandName Set-ItemProperty

                $errorRecord = Get-InvalidOperationRecord `
                    -Message ($script:localizedData.FailedUpdatingNetBiosError -f 74, 'Enable')

                It 'Should throw expected exception' {
                    {
                        Set-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Enable' -Verbose
                    } | Should -Throw $errorRecord
                }

                It 'Should call "Invoke-CimMethod" instead of "Set-ItemProperty"' {
                    Assert-MockCalled -CommandName Set-ItemProperty -Exactly -Times 0
                    Assert-MockCalled -CommandName Invoke-CimMethod -Exactly -Times 1
                }
            }

            Context 'Interface does not exist' {
                Mock -CommandName Get-CimInstance -MockWith { }

                $errorRecord = Get-InvalidOperationRecord `
                    -Message ($script:localizedData.InterfaceNotFoundError -f $interfaceAlias)

                It 'Should throw expected exception' {
                    {
                        Set-TargetResource -InterfaceAlias $interfaceAlias -Setting 'Enable' -Verbose
                    } | Should -Throw $errorRecord
                }
            }
        }
        #endregion
    }
    #endregion
}
finally
{
    #region FOOTER
    Restore-TestEnvironment -TestEnvironment $TestEnvironment
    #endregion
}