Tests/Integration/MSFT_Firewall.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
$script:DSCModuleName = 'NetworkingDsc'
$script:DSCResourceName = 'MSFT_Firewall'

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

# 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 config data object to pass to the Add Rule Config
    $ruleNameGuid = [Guid]::NewGuid().ToString()
    $ruleName = $ruleNameGuid + '[]*'
    $ruleNameEscaped = $ruleNameGuid + '`[`]`*'
    $configData = @{
        AllNodes = @(
            @{
                NodeName            = 'localhost'
                RuleName            = $ruleName
                Ensure              = 'Present'
                DisplayName         = 'Test Rule'
                Group               = 'Test Group'
                DisplayGroup        = 'Test Group'
                Enabled             = 'False'
                Profile             = @('Domain', 'Private')
                Action              = 'Allow'
                Description         = 'MSFT_Firewall Test Firewall Rule'
                Direction           = 'Inbound'
                RemotePort          = @('8080', '8081')
                LocalPort           = @('9080', '9081')
                Protocol            = 'TCP'
                Program             = 'c:\windows\system32\notepad.exe'
                Service             = 'WinRM'
                Authentication      = 'NotRequired'
                Encryption          = 'NotRequired'
                InterfaceAlias      = (Get-NetAdapter -Physical | Select-Object -First 1).Name
                InterfaceType       = 'Wired'
                LocalAddress        = @('192.168.2.0-192.168.2.128', '192.168.1.0/255.255.255.0', '10.0.240.1/8')
                LocalUser           = 'Any'
                Package             = 'S-1-15-2-3676279713-3632409675-756843784-3388909659-2454753834-4233625902-1413163418'
                Platform            = @('6.1')
                RemoteAddress       = @('192.168.2.0-192.168.2.128', '192.168.1.0/255.255.255.0')
                RemoteMachine       = 'Any'
                RemoteUser          = 'Any'
                DynamicTransport    = 'Any'
                EdgeTraversalPolicy = 'Allow'
                LocalOnlyMapping    = $false
                LooseSourceMapping  = $false
                OverrideBlockRules  = $false
                Owner               = (Get-CimInstance win32_useraccount | Select-Object -First 1).Sid
                IcmpType            = 'Any'
            }
        )
    }

    $configFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName)_add.config.ps1"
    . $configFile

    Describe "$($script:DSCResourceName)_Add_Integration" {
        It 'Should compile and apply the MOF without throwing' {
            {
                & "$($script:DSCResourceName)_Add_Config" `
                    -OutputPath $TestDrive `
                    -ConfigurationData $configData
                Start-DscConfiguration `
                    -Path $TestDrive `
                    -ComputerName localhost `
                    -Wait `
                    -Verbose `
                    -Force `
                    -ErrorAction Stop
            } | Should -Not -Throw
        }

        It 'Should be able to call Get-DscConfiguration without throwing' {
            { $script:current = Get-DscConfiguration -Verbose -ErrorAction Stop } | Should -Not -Throw
        }

        Context 'DSC resource state' {
            # Use the Parameters List to perform these tests
            foreach ($parameter in $parameterList)
            {
                $parameterName = $parameter.Name

                if ($parameterName -ne 'Name')
                {
                    $parameterValue = $Current.$($parameter.Name)

                    $parameterNew = (Get-Variable -Name configData).Value.AllNodes[0].$($parameter.Name)

                    if ($parameter.Type -eq 'Array' -and $parameter.Delimiter)
                    {
                        It "Should have set the '$parameterName' to '$parameterNew'" {
                            $parameterValue | Should -Be $parameterNew
                        }
                    }
                    elseif ($parameter.Type -eq 'ArrayIP')
                    {
                        for ([int] $entry = 0; $entry -lt $parameterNew.Count; $entry++)
                        {
                            It "Should have set the '$parameterName' arry item $entry to '$($parameterNew[$entry])'" {
                                $parameterValue[$entry] | Should -Be (Convert-CIDRToSubhetMask -Address $parameterNew[$entry])
                            }
                        }
                    }
                    else
                    {
                        It "Should have set the '$parameterName' to '$parameterNew'" {
                            $parameterValue | Should -Be $parameterNew
                        }
                    }
                }
            }
        }

        Context 'The current firewall rule state' {
            # Get the Rule details
            $firewallRule = Get-NetFireWallRule -Name $ruleNameEscaped

            $properties = @{
                AddressFilters       = @(Get-NetFirewallAddressFilter -AssociatedNetFirewallRule $FirewallRule)
                ApplicationFilters   = @(Get-NetFirewallApplicationFilter -AssociatedNetFirewallRule $FirewallRule)
                InterfaceFilters     = @(Get-NetFirewallInterfaceFilter -AssociatedNetFirewallRule $FirewallRule)
                InterfaceTypeFilters = @(Get-NetFirewallInterfaceTypeFilter -AssociatedNetFirewallRule $FirewallRule)
                PortFilters          = @(Get-NetFirewallPortFilter -AssociatedNetFirewallRule $FirewallRule)
                Profile              = @(Get-NetFirewallProfile -AssociatedNetFirewallRule $FirewallRule)
                SecurityFilters      = @(Get-NetFirewallSecurityFilter -AssociatedNetFirewallRule $FirewallRule)
                ServiceFilters       = @(Get-NetFirewallServiceFilter -AssociatedNetFirewallRule $FirewallRule)
            }

            # Use the Parameters List to perform these tests
            foreach ($parameter in $parameterList)
            {
                $parameterName = $parameter.Name

                if ($parameterName -ne 'Name')
                {
                    if ($parameter.Property)
                    {
                        $parameterValue = (Get-Variable -Name ($parameter.Variable)).value.$($parameter.Property).$($parameter.Name)
                    }
                    else
                    {
                        $parameterValue = (Get-Variable -Name ($parameter.Variable)).value.$($parameter.Name)
                    }

                    $parameterNew = (Get-Variable -Name configData).Value.AllNodes[0].$($parameter.Name)

                    if ($parameter.Type -eq 'Array' -and $parameter.Delimiter)
                    {
                        $parameterNew = $parameterNew -join $parameter.Delimiter

                        It "Should have set the '$parameterName' to '$parameterNew'" {
                            $parameterValue | Should -Be $parameterNew
                        }
                    }
                    elseif ($parameter.Type -eq 'ArrayIP')
                    {
                        for ([int] $entry = 0; $entry -lt $parameterNew.Count; $entry++)
                        {
                            It "Should have set the '$parameterName' arry item $entry to '$($parameterNew[$entry])'" {
                                $parameterValue[$entry] | Should -Be (Convert-CIDRToSubhetMask -Address $parameterNew[$entry])
                            }
                        }
                    }
                    else
                    {
                        It "Should have set the '$parameterName' to '$parameterNew'" {
                            $parameterValue | Should -Be $parameterNew
                        }
                    }
                }
            }
        }
    }

    # Modify the config data object to pass to the Remove Rule Config
    $configData.AllNodes[0].Ensure = 'Absent'

    $configFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName)_remove.config.ps1"
    . $configFile

    Describe "$($script:DSCResourceName)_Remove_Integration" {
        It 'Should compile and apply the MOF without throwing' {
            {
                & "$($script:DSCResourceName)_Remove_Config" `
                    -OutputPath $TestDrive `
                    -ConfigurationData $configData
                Start-DscConfiguration `
                    -Path $TestDrive `
                    -ComputerName localhost `
                    -Wait `
                    -Verbose `
                    -Force `
                    -ErrorAction Stop
            } | Should -Not -Throw
        }

        It 'Should be able to call Get-DscConfiguration without throwing' {
            { $script:current = Get-DscConfiguration -Verbose -ErrorAction Stop } | Should -Not -Throw
        }

        Context 'DSC resource state' {
            It 'Should return the expected values' {
                $script:current.Ensure | Should -Be 'Absent'
            }
        }

        Context 'The current firewall rule state' {
            It 'Should have deleted the rule' {
                # Get the Rule details
                $firewallRule = Get-NetFireWallRule -Name $ruleNameEscaped -ErrorAction SilentlyContinue
                $firewallRule | Should -BeNullOrEmpty
            }
        }
    }
}
finally
{
    #region FOOTER
    if (Get-NetFirewallRule -Name $ruleNameEscaped -ErrorAction SilentlyContinue)
    {
        Remove-NetFirewallRule -Name $ruleNameEscaped
    }

    Restore-TestEnvironment -TestEnvironment $TestEnvironment
    #endregion
}