Tests/Integration/MSFT_FirewallProfile.Integration.Tests.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
$script:DSCModuleName   = 'NetworkingDsc'
$script:DSCResourceName = 'MSFT_FirewallProfile'

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

#region HEADER
# Integration Test Template Version: 1.1.1
[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 Integration
#endregion

# Configure Loopback Adapter
. (Join-Path -Path (Split-Path -Parent $Script:MyInvocation.MyCommand.Path) -ChildPath 'IntegrationHelper.ps1')

# Backup the existing settings
$firewallProfileName = 'Public'
$currentFirewallProfile = Get-NetFirewallProfile -Name $firewallProfileName

# Using try/finally to always cleanup even if something awful happens.
try
{
    # Import the Common Networking functions
    Import-Module -Name (Join-Path -Path $script:moduleRoot -ChildPath 'Modules\NetworkingDsc.Common\NetworkingDsc.Common.psm1') -Force

    # Load the ParameterList from the data file.
    $resourceDataPath = Join-Path `
        -Path $script:moduleRoot `
        -ChildPath (Join-Path -Path 'DSCResources' -ChildPath $script:DSCResourceName)
    $resourceData = Import-LocalizedData `
        -BaseDirectory $resourceDataPath `
        -FileName "$($script:DSCResourceName).data.psd1"
    $parameterList = $resourceData.ParameterList

    # Create a Loopback adapter to use to test disabling interface aliases
    $adapterName = 'NetworkingDscLBA'
    New-IntegrationLoopbackAdapter -AdapterName $adapterName
    $adapter = Get-NetAdapter -Name $adapterName
    $interfaceAlias = $adapter.InterfaceAlias

    # Set the Firewall Profile to known values
    Set-NetFirewallProfile `
        -Name $firewallProfileName `
        -Enabled 'False' `
        -DefaultInboundAction 'Allow' `
        -DefaultOutboundAction 'Allow' `
        -AllowInboundRules 'True' `
        -AllowLocalFirewallRules 'True' `
        -AllowLocalIPsecRules 'True' `
        -AllowUserApps 'True' `
        -AllowUserPorts 'True' `
        -AllowUnicastResponseToMulticast 'True' `
        -NotifyOnListen 'True' `
        -EnableStealthModeForIPsec 'True' `
        -LogFileName '%systemroot%\system32\LogFiles\Firewall\pfirewalltest.log' `
        -LogMaxSizeKilobytes 16384 `
        -LogAllowed 'True' `
        -LogBlocked 'True' `
        -LogIgnored 'True' `
        -DisabledInterfaceAliases $interfaceAlias

    $configData = @{
        AllNodes = @(
            @{
                NodeName                        = 'localhost'
                Name                            = $firewallProfileName
                Enabled                         = 'False'
                DefaultInboundAction            = 'Block'
                DefaultOutboundAction           = 'Block'
                AllowInboundRules               = 'False'
                AllowLocalFirewallRules         = 'False'
                AllowLocalIPsecRules            = 'False'
                AllowUserApps                   = 'False'
                AllowUserPorts                  = 'False'
                AllowUnicastResponseToMulticast = 'False'
                NotifyOnListen                  = 'False'
                EnableStealthModeForIPsec       = 'False'
                LogFileName                     = '%systemroot%\system32\LogFiles\Firewall\pfirewall.log'
                LogMaxSizeKilobytes             = 32767
                LogAllowed                      = 'False'
                LogBlocked                      = 'False'
                LogIgnored                      = 'False'
                DisabledInterfaceAliases        = $interfaceAlias
            }
        )
    }

    #region Integration Tests
    $ConfigFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName).config.ps1"
    . $ConfigFile

    Describe "$($script:DSCResourceName)_Integration" {
        #region DEFAULT TESTS
        It 'Should compile and apply the MOF without throwing' {
            {
                & "$($script:DSCResourceName)_Config" `
                    -OutputPath $TestDrive `
                    -ConfigurationData $configData
                Start-DscConfiguration `
                    -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
            } | Should -Not -Throw
        }

        It 'Should be able to call Get-DscConfiguration without throwing' {
            { Get-DscConfiguration -Verbose -ErrorAction Stop } | Should -Not -Throw
        }
        #endregion

        # Get the DNS Client Global Settings details
        $firewallProfileNew = Get-NetFirewallProfile -Name $firewallProfileName

        # Use the Parameters List to perform these tests
        foreach ($parameter in $parameterList)
        {
            $parameterName = $parameter.name
            $parameterCurrentValue = (Get-Variable -Name 'firewallProfileNew').value.$($parameter.name)
            $parameterNewValue = (Get-Variable -Name configData).Value.AllNodes[0].$($parameter.Name)

            It "Should have set the '$parameterName' to '$parameterNewValue'" {
                $parameterCurrentValue | Should -Be $parameterNewValue
            }
        }
    }
    #endregion
}
finally
{
    # Clean up
    Set-NetFirewallProfile `
        -Name $firewallProfileName `
        -Enabled $currentFirewallProfile.Enabled `
        -DefaultInboundAction $currentFirewallProfile.DefaultInboundAction `
        -DefaultOutboundAction $currentFirewallProfile.DefaultOutboundAction `
        -AllowInboundRules $currentFirewallProfile.AllowInboundRules `
        -AllowLocalFirewallRules $currentFirewallProfile.AllowLocalFirewallRules `
        -AllowLocalIPsecRules $currentFirewallProfile.AllowLocalIPsecRules `
        -AllowUserApps $currentFirewallProfile.AllowUserApps `
        -AllowUserPorts $currentFirewallProfile.AllowUserPorts `
        -AllowUnicastResponseToMulticast $currentFirewallProfile.AllowUnicastResponseToMulticast `
        -NotifyOnListen $currentFirewallProfile.NotifyOnListen `
        -EnableStealthModeForIPsec $currentFirewallProfile.EnableStealthModeForIPsec `
        -LogFileName $currentFirewallProfile.LogFileName `
        -LogMaxSizeKilobytes $currentFirewallProfile.LogMaxSizeKilobytes `
        -LogAllowed $currentFirewallProfile.LogAllowed `
        -LogBlocked $currentFirewallProfile.LogBlocked `
        -LogIgnored $currentFirewallProfile.LogIgnored `
        -DisabledInterfaceAliases $currentFirewallProfile.DisabledInterfaceAliases

    # Remove Loopback Adapter
    Remove-IntegrationLoopbackAdapter -AdapterName $adapterName

    #region FOOTER
    Restore-TestEnvironment -TestEnvironment $TestEnvironment
    #endregion
}