Tests/Unit/MSFT_Route.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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
$script:DSCModuleName = 'NetworkingDsc'
$script:DSCResourceName = 'MSFT_Route'

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
{
    InModuleScope $script:DSCResourceName {
        # Create the Mock Objects that will be used for running tests
        $mockNetAdapter = [PSCustomObject] @{
            Name = 'Ethernet'
        }

        $testRoute = [PSObject]@{
            InterfaceAlias    = $mockNetAdapter.Name
            AddressFamily     = 'IPv4'
            DestinationPrefix = '10.0.0.1/8'
            NextHop           = '10.0.0.2'
            Ensure            = 'Present'
            RouteMetric       = 200
            Publish           = 'Age'
            PreferredLifetime = 50000
        }

        $testRouteKeys = [PSObject]@{
            InterfaceAlias    = $mockNetAdapter.Name
            AddressFamily     = $testRoute.AddressFamily
            DestinationPrefix = $testRoute.DestinationPrefix
            NextHop           = $testRoute.NextHop
        }

        $mockRoute = [PSObject]@{
            InterfaceAlias    = $mockNetAdapter.Name
            AddressFamily     = $testRoute.AddressFamily
            DestinationPrefix = $testRoute.DestinationPrefix
            NextHop           = $testRoute.NextHop
            Ensure            = $testRoute.Ensure
            RouteMetric       = $testRoute.RouteMetric
            Publish           = $testRoute.Publish
            PreferredLifetime = ([Timespan]::FromSeconds($testRoute.PreferredLifetime))
        }

        Describe 'MSFT_Route\Get-TargetResource' -Tag 'Get' {
            Context 'Route does not exist' {
                Mock -CommandName Get-NetRoute

                It 'Should return absent Route' {
                    $result = Get-TargetResource @testRouteKeys
                    $result.Ensure | Should -Be 'Absent'
                }

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

            Context 'Route does exist' {
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }

                It 'Should return correct Route' {
                    $result = Get-TargetResource @testRouteKeys
                    $result.Ensure            | Should -Be 'Present'
                    $result.InterfaceAlias    | Should -Be $testRoute.InterfaceAlias
                    $result.AddressFamily     | Should -Be $testRoute.AddressFamily
                    $result.DestinationPrefix | Should -Be $testRoute.DestinationPrefix
                    $result.NextHop           | Should -Be $testRoute.NextHop
                    $result.RouteMetric       | Should -Be $testRoute.RouteMetric
                    $result.Publish           | Should -Be $testRoute.Publish
                    $result.PreferredLifetime | Should -Be $testRoute.PreferredLifetime
                }

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

        Describe 'MSFT_Route\Set-TargetResource' -Tag 'Set' {
            Context 'Route does not exist but should' {
                Mock -CommandName Get-NetRoute
                Mock -CommandName New-NetRoute
                Mock -CommandName Set-NetRoute
                Mock -CommandName Remove-NetRoute

                It 'Should not throw error' {
                    {
                        $setTargetResourceParameters = $testRoute.Clone()
                        Set-TargetResource @setTargetResourceParameters
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName New-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName Set-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Remove-NetRoute -Exactly -Times 0
                }
            }

            Context 'Route exists and should but has a different RouteMetric' {
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }
                Mock -CommandName New-NetRoute
                Mock -CommandName Set-NetRoute
                Mock -CommandName Remove-NetRoute

                It 'Should not throw error' {
                    {
                        $setTargetResourceParameters = $testRoute.Clone()
                        $setTargetResourceParameters.RouteMetric = $setTargetResourceParameters.RouteMetric + 10
                        Set-TargetResource @setTargetResourceParameters
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName New-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Set-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName Remove-NetRoute -Exactly -Times 0
                }
            }

            Context 'Route exists and should but has a different Publish' {
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }
                Mock -CommandName New-NetRoute
                Mock -CommandName Set-NetRoute
                Mock -CommandName Remove-NetRoute

                It 'Should not throw error' {
                    {
                        $setTargetResourceParameters = $testRoute.Clone()
                        $setTargetResourceParameters.Publish = 'No'
                        Set-TargetResource @setTargetResourceParameters
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName New-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Set-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName Remove-NetRoute -Exactly -Times 0
                }
            }

            Context 'Route exists and should but has a different PreferredLifetime' {
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }
                Mock -CommandName New-NetRoute
                Mock -CommandName Set-NetRoute
                Mock -CommandName Remove-NetRoute

                It 'Should not throw error' {
                    {
                        $setTargetResourceParameters = $testRoute.Clone()
                        $setTargetResourceParameters.PreferredLifetime = $testRoute.PreferredLifetime + 1000
                        Set-TargetResource @setTargetResourceParameters
                    } | Should -Not -Throw
                }

                It 'Should call expected mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName New-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Set-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName Remove-NetRoute -Exactly -Times 0
                }
            }

            Context 'Route exists and but should not' {
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }
                Mock -CommandName New-NetRoute
                Mock -CommandName Set-NetRoute
                Mock -CommandName Remove-NetRoute `
                    -ParameterFilter {
                    ($InterfaceAlias -eq $testRoute.InterfaceAlias) -and `
                    ($AddressFamily -eq $testRoute.AddressFamily) -and `
                    ($DestinationPrefix -eq $testRoute.DestinationPrefix) -and `
                    ($NextHop -eq $testRoute.NextHop) -and `
                    ($RouteMetric -eq $testRoute.RouteMetric)
                }

                It 'Should not throw error' {
                    {
                        $setTargetResourceParameters = $testRoute.Clone()
                        $setTargetResourceParameters.Ensure = 'Absent'
                        Set-TargetResource @setTargetResourceParameters
                    } | Should -Not -Throw
                }

                It 'Should call expected mocks and parameters' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName New-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Set-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Remove-NetRoute `
                        -ParameterFilter {
                            ($InterfaceAlias -eq $testRoute.InterfaceAlias) -and `
                            ($AddressFamily -eq $testRoute.AddressFamily) -and `
                            ($DestinationPrefix -eq $testRoute.DestinationPrefix) -and `
                            ($NextHop -eq $testRoute.NextHop) -and `
                            ($RouteMetric -eq $testRoute.RouteMetric)
                        } `
                        -Exactly -Times 1
                }
            }

            Context 'Route does not exist and should not' {
                Mock -CommandName Get-NetRoute
                Mock -CommandName New-NetRoute
                Mock -CommandName Set-NetRoute
                Mock -CommandName Remove-NetRoute

                It 'Should not throw error' {
                    {
                        $setTargetResourceParameters = $testRoute.Clone()
                        $setTargetResourceParameters.Ensure = 'Absent'
                        Set-TargetResource @setTargetResourceParameters
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                    Assert-MockCalled -CommandName New-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Set-NetRoute -Exactly -Times 0
                    Assert-MockCalled -CommandName Remove-NetRoute -Exactly -Times 0
                }
            }
        }

        Describe 'MSFT_Route\Test-TargetResource' -Tag 'Test' {
            Context 'Route does not exist but should' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }
                Mock -CommandName Get-NetRoute

                It 'Should return false' {
                    $testTargetResourceParameters = $testRoute.Clone()
                    Test-TargetResource @testTargetResourceParameters | Should -Be $False

                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                }
            }

            Context 'Route exists and should but has a different RouteMetric' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }

                It 'Should return false' {
                    {
                        $testTargetResourceParameters = $testRoute.Clone()
                        $testTargetResourceParameters.RouteMetric = $testTargetResourceParameters.RouteMetric + 5
                        Test-TargetResource @testTargetResourceParameters | Should -Be $False
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                }
            }

            Context 'Route exists and should but has a different Publish' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }

                It 'Should return false' {
                    {
                        $testTargetResourceParameters = $testRoute.Clone()
                        $testTargetResourceParameters.Publish = 'Yes'
                        Test-TargetResource @testTargetResourceParameters | Should -Be $False
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                }
            }

            Context 'Route exists and should but has a different PreferredLifetime' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }

                It 'Should return false' {
                    {
                        $testTargetResourceParameters = $testRoute.Clone()
                        $testTargetResourceParameters.PreferredLifetime = $Splat.PreferredLifetime + 5000
                        Test-TargetResource @testTargetResourceParameters | Should -Be $False
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                }
            }

            Context 'Route exists and should and all parameters match' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }

                It 'Should return true' {
                    {
                        $testTargetResourceParameters = $testRoute.Clone()
                        Test-TargetResource @testTargetResourceParameters | Should -Be $True
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                }
            }

            Context 'Route exists but should not' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }
                Mock -CommandName Get-NetRoute -MockWith { $mockRoute }

                It 'Should return false' {
                    {
                        $testTargetResourceParameters = $testRoute.Clone()
                        $testTargetResourceParameters.Ensure = 'Absent'
                        Test-TargetResource @testTargetResourceParameters | Should -Be $False
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                }
            }

            Context 'Route does not exist and should not' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }
                Mock -CommandName Get-NetRoute

                It 'Should return true' {
                    {
                        $testTargetResourceParameters = $testRoute.Clone()
                        $testTargetResourceParameters.Ensure = 'Absent'
                        Test-TargetResource @testTargetResourceParameters | Should -Be $True
                    } | Should -Not -Throw
                }

                It 'Should call expected Mocks' {
                    Assert-MockCalled -CommandName Get-NetRoute -Exactly -Times 1
                }
            }
        }

        Describe 'MSFT_Route\Assert-ResourceProperty' {
            Context 'Invoking with bad interface alias' {
                Mock -CommandName Get-NetAdapter

                It 'Should throw an InterfaceNotAvailable error' {
                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.InterfaceNotAvailableError -f $testRoute.InterfaceAlias) `
                        -ArgumentName 'Interface'

                    { Assert-ResourceProperty @testRoute } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with bad IPv4 DestinationPrefix address' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressFormatError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = '10.0.300.0/24'
                    $Splat.NextHop = '10.0.1.0'
                    $Splat.AddressFamily = 'IPv4'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressFormatError -f '10.0.300.0') `
                        -ArgumentName 'DestinationPrefix'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with bad IPv6 DestinationPrefix address' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressFormatError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = 'fe8x::/64'
                    $Splat.NextHop = 'fe90::'
                    $Splat.AddressFamily = 'IPv6'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressFormatError -f 'fe8x::') `
                        -ArgumentName 'DestinationPrefix'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with IPv4 DestinationPrefix mismatch' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressIPv6MismatchError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = 'fe80::/64'
                    $Splat.NextHop = '10.0.1.0'
                    $Splat.AddressFamily = 'IPv4'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressIPv6MismatchError -f 'fe80::', 'IPv4') `
                        -ArgumentName 'DestinationPrefix'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with IPv6 DestinationPrefix mismatch' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressIPv4MismatchError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = '10.0.0.0/24'
                    $Splat.NextHop = 'fe81::'
                    $Splat.AddressFamily = 'IPv6'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressIPv4MismatchError -f '10.0.0.0', 'IPv6') `
                        -ArgumentName 'DestinationPrefix'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with bad IPv4 NextHop address' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressFormatError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = '10.0.0.0/24'
                    $Splat.NextHop = '10.0.300.0'
                    $Splat.AddressFamily = 'IPv4'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressFormatError -f '10.0.300.0') `
                        -ArgumentName 'NextHop'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with bad IPv6 NextHop address' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressFormatError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = 'fe80::/64'
                    $Splat.NextHop = 'fe9x::'
                    $Splat.AddressFamily = 'IPv6'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressFormatError -f 'fe9x::') `
                        -ArgumentName 'NextHop'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with IPv4 NextHop mismatch' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressIPv6MismatchError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = '10.0.0.0/24'
                    $Splat.NextHop = 'fe90::'
                    $Splat.AddressFamily = 'IPv4'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressIPv6MismatchError -f 'fe90::', 'IPv4') `
                        -ArgumentName 'NextHop'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }

            Context 'Invoking with IPv6 NextHop mismatch' {
                Mock -CommandName Get-NetAdapter -MockWith { $mockNetAdapter }

                It 'Should throw an AddressIPv4MismatchError error' {
                    $Splat = $testRoute.Clone()
                    $Splat.DestinationPrefix = 'fe80::/64'
                    $Splat.NextHop = '10.0.1.0'
                    $Splat.AddressFamily = 'IPv6'

                    $errorRecord = Get-InvalidArgumentRecord `
                        -Message ($script:localizedData.AddressIPv4MismatchError -f '10.0.1.0', 'IPv6') `
                        -ArgumentName 'NextHop'

                    { Assert-ResourceProperty @Splat } | Should -Throw $errorRecord
                }
            }
        }
    }
}
finally
{
    #region FOOTER
    Restore-TestEnvironment -TestEnvironment $TestEnvironment
    #endregion
}