This repository has been archived by the owner on Jun 14, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 54
/
Copy pathMSFT_GroupResource.Tests.ps1
2536 lines (1928 loc) · 157 KB
/
MSFT_GroupResource.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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')]
param ()
$errorActionPreference = 'Stop'
Set-StrictMode -Version 'Latest'
Describe 'GroupResource Unit Tests' {
BeforeAll {
# Import CommonTestHelper
$testsFolderFilePath = Split-Path $PSScriptRoot -Parent
$testHelperFolderFilePath = Join-Path -Path $testsFolderFilePath -ChildPath 'TestHelpers'
$commonTestHelperFilePath = Join-Path -Path $testHelperFolderFilePath -ChildPath 'CommonTestHelper.psm1'
Import-Module -Name $commonTestHelperFilePath
$script:testEnvironment = Enter-DscResourceTestEnvironment `
-DscResourceModuleName 'PSDscResources' `
-DscResourceName 'MSFT_GroupResource' `
-TestType 'Unit'
InModuleScope 'MSFT_GroupResource' {
<#
Create test group object to be used in tests.
It must be created within module scope for objects to be
accessible to tests running in module scope.
#>
$script:disposableObjects = @()
$script:testGroupName = 'TestGroup'
$script:testGroupDescription = 'A group for testing'
$script:localDomain = $env:computerName
$script:onNanoServer = Test-IsNanoServer
$script:testMemberName1 = 'User1'
$script:testMemberName2 = 'User2'
$script:testMemberName3 = 'User3'
$testUserName = 'TestUserName'
$testPassword = 'TestPassword'
$secureTestPassword = ConvertTo-SecureString -String $testPassword -AsPlainText -Force
$script:testCredential = New-Object -TypeName 'System.Management.Automation.PSCredential' -ArgumentList @( $testUsername, $secureTestPassword )
$script:testErrorMessage = 'Test error message'
if ($script:onNanoServer)
{
$script:testLocalGroup = New-Object -TypeName 'Microsoft.PowerShell.Commands.LocalGroup' -ArgumentList @( $script:testGroupName )
}
else
{
$script:testPrincipalContext = New-Object -TypeName 'System.DirectoryServices.AccountManagement.PrincipalContext' -ArgumentList @( [System.DirectoryServices.AccountManagement.ContextType]::Machine )
$script:testGroup = New-Object -TypeName 'System.DirectoryServices.AccountManagement.GroupPrincipal' -ArgumentList @( $script:testPrincipalContext )
$script:disposableObjects += $testGroup
$script:testUserPrincipal1 = New-Object -TypeName 'System.DirectoryServices.AccountManagement.UserPrincipal' -ArgumentList @( $testPrincipalContext )
$script:testuserPrincipal1.Name = $script:testMemberName1
$script:testuserPrincipal1.SamAccountName = 'SamAccountName1'
$script:disposableObjects += $script:testuserPrincipal1
$script:testUserPrincipal2 = New-Object -TypeName 'System.DirectoryServices.AccountManagement.UserPrincipal' -ArgumentList @( $testPrincipalContext )
$script:testuserPrincipal2.Name = $script:testMemberName2
$script:testuserPrincipal2.SamAccountName = 'SamAccountName2'
$script:disposableObjects += $script:testuserPrincipal2
$script:testUserPrincipal3 = New-Object -TypeName 'System.DirectoryServices.AccountManagement.UserPrincipal' -ArgumentList @( $testPrincipalContext )
$script:testuserPrincipal3.Name = $script:testMemberName3
$script:testuserPrincipal3.SamAccountName = 'SamAccountName3'
$script:disposableObjects += $script:testuserPrincipal3
}
}
}
AfterAll {
InModuleScope 'MSFT_GroupResource' {
# Dispose of module scoped test group objects
foreach ($disposableObject in $script:disposableObjects)
{
$disposableObject.Dispose()
}
}
Exit-DscResourceTestEnvironment -TestEnvironment $script:testEnvironment
}
InModuleScope 'MSFT_GroupResource' {
<#
.SYNOPSIS
Reset a test group object prior to running each test.
.DESCRIPTION
Resets the test group prior to executing tests to ensure
it is in a known state.
#>
function Reset-TestGroup {
[CmdletBinding()]
param
(
)
if (-not ($script:onNanoServer))
{
$script:testGroup.Name = $script:testGroupName
$script:testGroup.Description = ''
if ($script:testGroup.Members.Count -gt 0)
{
$script:testGroup.Members.Clear()
}
}
else
{
# Reset the local group
$script:testLocalGroup.Name = $script:testGroupName
$script:testLocalGroup.Description = ''
}
}
<#
Get-Group, Add-GroupMember, Remove-GroupMember, Clear-GroupMember, Save-Group,
Remove-Group, Find-Principal, and Remove-DisposableObject cannot be unit tested
because they are wrapper functions for .NET class function calls.
#>
Describe 'GroupResource\Get-TargetResource' -Tag 'Get' {
BeforeEach {
Mock -CommandName 'Assert-GroupNameValid' -MockWith { }
Mock -CommandName 'Test-IsNanoServer' -MockWith { return $false }
Mock -CommandName 'Get-TargetResourceOnFullSKU' -MockWith { return @{ TestResult = 'OnFullSKU' } }
Mock -CommandName 'Get-TargetResourceOnNanoServer' -MockWith { return @{ TestResult = 'OnNanoServer' } }
}
Context 'When called with the given group name' {
It 'Should call Assert-GroupNameValid' {
$null = Get-TargetResource -GroupName $script:testGroupName
Assert-MockCalled -CommandName 'Assert-GroupNameValid' -ParameterFilter { $GroupName -eq $script:testGroupName }
}
}
Context 'When called with all parameters when not on Nano Server' {
It 'Should return output from Get-TargetResourceOnFullSKU' {
$getTargetResourceResult = Get-TargetResource -GroupName $script:testGroupName -Credential $script:testCredential
Assert-MockCalled -CommandName 'Test-IsNanoServer'
Assert-MockCalled -CommandName 'Get-TargetResourceOnFullSKU' -ParameterFilter { $GroupName -eq $script:testGroupName -and $Credential -eq $script:testCredential }
$getTargetResourceResult.TestResult | Should -Be 'OnFullSKU'
}
}
Context 'When called with all parameters when on Nano Server' {
It 'Should return output from Get-TargetResourceOnNanoServer' {
Mock -CommandName 'Test-IsNanoServer' -MockWith { return $true }
$getTargetResourceResult = Get-TargetResource -GroupName $script:testGroupName -Credential $script:testCredential
Assert-MockCalled -CommandName 'Test-IsNanoServer'
Assert-MockCalled -CommandName 'Get-TargetResourceOnNanoServer' -ParameterFilter { $GroupName -eq $script:testGroupName -and $Credential -eq $script:testCredential }
$getTargetResourceResult.TestResult | Should -Be 'OnNanoServer'
}
}
}
Describe 'GroupResource\Set-TargetResource' -Tag 'Set' {
BeforeEach {
Mock -CommandName 'Assert-GroupNameValid' -MockWith { }
Mock -CommandName 'Test-IsNanoServer' -MockWith { return $false }
Mock -CommandName 'Set-TargetResourceOnFullSKU' -MockWith { }
Mock -CommandName 'Set-TargetResourceOnNanoServer' -MockWith { }
}
Context 'When called with the given group name' {
It 'Should call Assert-GroupNameValid' {
$null = Set-TargetResource -GroupName $script:testGroupName
Assert-MockCalled -CommandName 'Assert-GroupNameValid' -ParameterFilter { $GroupName -eq $script:testGroupName }
}
}
Context 'When called with all parameters when not on Nano Server' {
It 'Should call Set-TargetResourceOnFullSKU' {
Set-TargetResource -GroupName $script:testGroupName -Credential $script:testCredential
Assert-MockCalled -CommandName 'Test-IsNanoServer'
Assert-MockCalled -CommandName 'Set-TargetResourceOnFullSKU' -ParameterFilter { $GroupName -eq $script:testGroupName -and $Credential -eq $script:testCredential }
}
}
Context 'When called with all parameters when on Nano Server' {
It 'Should call Set-TargetResourceOnNanoServer' {
Mock -CommandName 'Test-IsNanoServer' -MockWith { return $true }
Set-TargetResource -GroupName $script:testGroupName -Credential $script:testCredential
Assert-MockCalled -CommandName 'Test-IsNanoServer'
Assert-MockCalled -CommandName 'Set-TargetResourceOnNanoServer' -ParameterFilter { $GroupName -eq $script:testGroupName -and $Credential -eq $script:testCredential }
}
}
}
Describe 'GroupResource\Test-TargetResource' -Tag 'Test' {
BeforeEach {
Mock -CommandName 'Assert-GroupNameValid' -MockWith { }
Mock -CommandName 'Test-IsNanoServer' -MockWith { return $false }
Mock -CommandName 'Test-TargetResourceOnFullSKU' -MockWith { }
Mock -CommandName 'Test-TargetResourceOnNanoServer' -MockWith { }
}
Context 'When called with the given group name' {
It 'Should call Assert-GroupNameValid' {
$null = Test-TargetResource -GroupName $script:testGroupName
Assert-MockCalled -CommandName 'Assert-GroupNameValid' -ParameterFilter { $GroupName -eq $script:testGroupName }
}
}
Context 'When called with all parameters when not on Nano Server' {
It 'Should call Test-TargetResourceOnFullSKU' {
$null = Test-TargetResource -GroupName $script:testGroupName -Credential $script:testCredential
Assert-MockCalled -CommandName 'Test-IsNanoServer'
Assert-MockCalled -CommandName 'Test-TargetResourceOnFullSKU' -ParameterFilter { $GroupName -eq $script:testGroupName -and $Credential -eq $script:testCredential }
}
}
Context 'When called with all parameters when on Nano Server' {
It 'Should call Test-TargetResourceOnNanoServer' {
Mock -CommandName 'Test-IsNanoServer' -MockWith { return $true }
$null = Test-TargetResource -GroupName $script:testGroupName -Credential $script:testCredential
Assert-MockCalled -CommandName 'Test-IsNanoServer'
Assert-MockCalled -CommandName 'Test-TargetResourceOnNanoServer' -ParameterFilter { $GroupName -eq $script:testGroupName -and $Credential -eq $script:testCredential }
}
}
}
Describe 'GroupResource\Assert-GroupNameValid' -Tag 'Helper' {
Context 'When called with an invalid group name' {
$invalidCharacters = @( '\', '/', '"', '[', ']', ':', '|', '<', '>', '+', '=', ';', ',', '?', '*', '@' ) |
ForEach-Object { @{ InvalidCharacter = $_ } }
It 'Should throw error if name contains invalid character "<InvalidCharacter>"' -TestCases $invalidCharacters {
param
(
[Parameter(Mandatory = $true)]
[System.String]
$InvalidCharacter
)
$invalidGroupName = ('Invalid' + $invalidCharacter + 'Group')
{ Assert-GroupNameValid -GroupName $invalidGroupName } | Should -Throw ($script:localizedData.InvalidGroupName -f $invalidGroupName, '')
}
$invalidGroups = @(
@{
InvalidGroupName = ' '
InvalidGroupDescription = 'only whitespace'
},
@{
InvalidGroupName = '....'
InvalidGroupDescription = 'only dots'
},
@{
InvalidGroupName = '.. ..'
InvalidGroupDescription = 'only whitespace and dots'
}
)
It 'Should throw if name contains <InvalidGroupDescription>' -TestCases $invalidGroups {
param
(
[Parameter(Mandatory = $true)]
[System.String]
$InvalidGroupDescription,
[Parameter(Mandatory = $true)]
[System.String]
$InvalidGroupName
)
{ Assert-GroupNameValid -GroupName $invalidGroupName } | Should -Throw ($script:localizedData.InvalidGroupName -f $invalidGroupName, '')
}
}
Context 'When called with a valid group name' {
It 'Should not throw if name contains whitespace and dots' {
$invalidGroupName = '.. MyGroup ..'
{ Assert-GroupNameValid -GroupName $invalidGroupName } | Should -Not -Throw
}
}
}
Describe 'GroupResource\Test-IsLocalMachine' -Tag 'Helper' {
BeforeEach {
Mock -CommandName 'Get-CimInstance' -MockWith { }
}
Context 'When called with a scope name that resolves to the local machine' {
$localMachineScopes = @(
@{ localMachineScope = '.' }
@{ localMachineScope = $ENV:COMPUTERNAME }
@{ localMachineScope = 'localhost' }
@{ localMachineScope = '127.0.0.1' }
)
It 'Should return true for local machine scope "<LocalMachineScope>"' -TestCases $localMachineScopes {
param
(
[Parameter(Mandatory = $true)]
[System.String]
$LocalMachineScope
)
Test-IsLocalMachine -Scope $LocalMachineScope | Should -BeTrue
}
$customLocalIPAddress = '123.4.5.6'
It 'Should return true if custom local IP address provided and Get-CimInstance contains matching IP address' {
Mock -CommandName 'Get-CimInstance' -MockWith { return @{ IPAddress = @($customLocalIPAddress, '789.1.2.3')} }
Test-IsLocalMachine -Scope $customLocalIPAddress | Should -BeTrue
}
}
Context 'When called with a scope name that does not resolve to the local machine' {
$customLocalIPAddress = '123.4.5.6'
It 'Should return false if custom local IP address provided and Get-CimInstance returns null' {
Test-IsLocalMachine -Scope $customLocalIPAddress | Should -BeFalse
}
It 'Should return false if custom local IP address provided and Get-CimInstance do not contain matching IP addresses' {
Mock -CommandName 'Get-CimInstance' -MockWith { return @{ IPAddress = @('789.1.2.3')} }
Test-IsLocalMachine -Scope $customLocalIPAddress | Should -BeFalse
}
}
}
Describe 'GroupResource\Split-MemberName' -Tag 'Helper' {
Context 'When called with the MemberName in the domain\username format with the local scope' {
It 'Should return the local scope and the username' {
Mock -CommandName 'Test-IsLocalMachine' -MockWith { return $true }
$testMemberName = 'domain\username'
$splitMemberNameResult = Split-MemberName -MemberName $testMemberName
Assert-MockCalled -CommandName 'Test-IsLocalMachine'
$splitMemberNameResult | Should -Be @( $script:localDomain, 'username' )
}
}
Context 'When called with a MemberName in the domain\username format with the domain scope' {
It 'Should return the specified domain and the username' {
Mock -CommandName 'Test-IsLocalMachine' -MockWith { return $false }
$testMemberName = 'domain\username'
$splitMemberNameResult = Split-MemberName -MemberName $testMemberName
Assert-MockCalled -CommandName 'Test-IsLocalMachine'
$splitMemberNameResult | Should -Be @( 'domain', 'username' )
}
}
Context 'When called with a MemberName in the username@domain format with the domain scope' {
It 'Should return the specified domain and the username' {
Mock -CommandName 'Test-IsLocalMachine' -MockWith { return $false }
$testMemberName = 'username@domain'
$splitMemberNameResult = Split-MemberName -MemberName $testMemberName
$splitMemberNameResult | Should -Be @( 'domain', 'username' )
}
}
Context 'When called with a MemberName in the CN=username,DC=domain format with local scope' {
It 'Should return the local scope and the username' {
Mock -CommandName 'Test-IsLocalMachine' -MockWith { return $false }
$testMemberName = 'CN=username,DC=domain'
$splitMemberNameResult = Split-MemberName -MemberName $testMemberName
$splitMemberNameResult | Should -Be @( $script:localDomain, $testMemberName )
}
}
Context 'When called with a MemberName in the CN=username,DC=domain format with domain scope' {
It 'Should return the specified domain and the username' {
Mock -CommandName 'Test-IsLocalMachine' -MockWith { return $false }
$testMemberName = 'CN=username,DC=domain,DC=com'
$splitMemberNameResult = Split-MemberName -MemberName $testMemberName
$splitMemberNameResult | Should -Be @( 'domain', $testMemberName )
}
}
Context 'When called with a MemberName in the without a scope specified' {
It 'Should return the local scope and the username' {
Mock -CommandName 'Test-IsLocalMachine' -MockWith { return $false }
$testMemberName = 'username'
$splitMemberNameResult = Split-MemberName -MemberName $testMemberName
$splitMemberNameResult | Should -Be @( $script:localDomain, 'username' )
}
}
}
if ($script:onNanoServer)
{
Describe 'GroupResource\Get-TargetResourceOnNanoServer' -Tag 'Helper' {
$testMembers = @('User1', 'User2')
BeforeEach {
Reset-TestGroup
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @() }
}
Context 'When Get-LocalGroup throws a GroupNotFound exception' {
It 'Should return Ensure as Absent' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
$getTargetResourceResult = Get-TargetResourceOnNanoServer -GroupName $script:testGroupName
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
$getTargetResourceResult -is [System.Collections.Hashtable] | Should -BeTrue
$getTargetResourceResult.Keys.Count | Should -Be 2
$getTargetResourceResult.GroupName | Should -Be $script:testGroupName
$getTargetResourceResult.Ensure | Should -Be 'Absent'
}
}
Context 'When Get-LocalGroup throws an exception other than GroupNotFound' {
It 'Should throw expected exception' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message $script:testErrorMessage -CategoryReason 'OtherException' }
{ $null = Get-TargetResourceOnNanoServer -GroupName $script:testGroupName } | Should -Throw -ExpectedMessage $script:testErrorMessage
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Get-LocalGroup returns a valid, existing group without members' {
It 'Should return expected values and call expected mocks' {
$script:testLocalGroup.Description = $script:testGroupDescription
Mock -CommandName 'Get-LocalGroup' -MockWith { return $script:testLocalGroup }
$getTargetResourceResult = Get-TargetResourceOnNanoServer -GroupName $script:testGroupName
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group -eq $script:testLocalGroup }
$getTargetResourceResult -is [System.Collections.Hashtable] | Should -BeTrue
$getTargetResourceResult.Keys.Count | Should -Be 4
$getTargetResourceResult.GroupName | Should -Be $script:testGroupName
$getTargetResourceResult.Ensure | Should -Be 'Present'
$getTargetResourceResult.Description | Should -Be $script:testGroupDescription
$getTargetResourceResult.Members | Should -Be $null
}
}
Context 'When Get-LocalGroup returns a valid, existing group with members' {
It 'Should return expected values and call expected mocks' {
$script:testLocalGroup.Description = $script:testGroupDescription
Mock -CommandName 'Get-LocalGroup' -MockWith { return $script:testLocalGroup }
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return $testMembers }
$getTargetResourceResult = Get-TargetResourceOnNanoServer -GroupName $script:testGroupName
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group -eq $script:testLocalGroup }
$getTargetResourceResult -is [System.Collections.Hashtable] | Should -BeTrue
$getTargetResourceResult.Keys.Count | Should -Be 4
$getTargetResourceResult.GroupName | Should -Be $script:testGroupName
$getTargetResourceResult.Ensure | Should -Be 'Present'
$getTargetResourceResult.Description | Should -Be $script:testGroupDescription
$getTargetResourceResult.Members | Should -Be $testMembers
}
}
}
Describe 'GroupResource\Set-TargetResourceOnNanoServer' -Tag 'Helper' {
<#
.SYNOPSIS
Assert that Group Members have not changed on Nano Server.
.DESCRIPTION
This helper asserts that none of the calls to update a group
have been made.
#>
function Assert-GroupMembersNotChangedOnNanoServer
{
[CmdletBinding()]
param
(
)
Assert-MockCalled -CommandName 'Set-LocalGroup' -Times 0 -Scope 'It'
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -Times 0 -Scope 'It'
Assert-MockCalled -CommandName 'Remove-LocalGroupMember' -Times 0 -Scope 'It'
}
BeforeEach {
Reset-TestGroup
Mock -CommandName 'Get-LocalGroup' -MockWith { return $script:testLocalGroup }
Mock -CommandName 'New-LocalGroup' -MockWith { return $script:testLocalGroup }
Mock -CommandName 'Set-LocalGroup' -MockWith { }
Mock -CommandName 'Remove-LocalGroup' -MockWith { }
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { }
Mock -CommandName 'Add-LocalGroupMember' -MockWith { }
Mock -CommandName 'Remove-LocalGroupMember' -MockWith { }
}
Context 'When Ensure is absent and the group does not exist' {
It 'Should not attempt to remove an absent group' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Absent'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Remove-LocalGroup' -Times 0 -Scope 'It'
}
}
Context 'When Ensure is absent and the group exists' {
It 'Should remove an existing group' {
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Absent'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Remove-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName } -Scope 'It'
}
}
Context 'When Ensure is present and the group does not exist' {
It 'Should create an empty group' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'New-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group does not exist and Description is passed' {
It 'Should create an empty group with a description' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Description $script:testGroupDescription -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'New-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Set-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName -and $Description -eq $script:testGroupDescription }
}
}
Context 'When Ensure is present and the group does not exist and Members is passed with one local member' {
It 'Should create a group with one local member' {
$testMembers = @( $script:testMemberName1 )
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'New-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
}
}
Context 'When Ensure is present and the group does not exist and Members is passed with two local members' {
It 'Should create a group with two local members' {
$testMembers = @( $script:testMemberName1, $script:testMemberName2 )
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'New-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Ensure is present and the group does not exist and MembersToInclude is passed with one local member' {
It 'Should create a group with one local member' {
$testMembers = @( $script:testMemberName1 )
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'New-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
}
}
Context 'When Ensure is present and the group does not exist and MembersToInclude is passed with two local members' {
It 'Should create a group with two local members using MembersToInclude' {
$testMembers = @( $script:testMemberName1, $script:testMemberName2 )
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'New-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Get-LocalGroup throws an exception other than GroupNotFound' {
It 'Should throw expected exception' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message $script:testErrorMessage -CategoryReason 'OtherException' }
{ Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Present' } | Should -Throw $script:testErrorMessage
}
}
Context 'When Ensure is present and the group exists with no members and Members is passed with one member' {
It 'Should add a member to an existing group' {
$testMembers = @( $script:testMemberName1 )
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
}
}
Context 'When Ensure is present and the group exists with two members missing from Members list passed' {
It 'Should add two members to an existing group' {
$testMembers = @( $script:testMemberName1, $script:testMemberName2 )
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Ensure is present and the group exists with no members and MembersToInclude is passed with one member' {
It 'Should add a member to an existing group' {
$testMembers = @( $script:testMemberName1 )
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
}
}
Context 'When Ensure is present and the group exists with two members missing from MembersToInclude list passed' {
It 'Should add two members to an existing group' {
$testMembers = @( $script:testMemberName1, $script:testMemberName2 )
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Ensure is present and the group exists with one member not in the Members list passed' {
It 'Should remove a member from an existing group' {
$testMembers = @( $script:testMemberName1 )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Remove-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Ensure is present and the group exists with containing members and an empty Members list passed' {
It 'Should clear all members from an existing group' {
$testMembers = @( )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Remove-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName1 }
Assert-MockCalled -CommandName 'Remove-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Ensure is present and the group exists with a member contained in the MembersToExclude list passed' {
It 'Should remove a member from an existing group' {
$testMembers = @( $script:testMemberName2 )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToExclude $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Remove-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Ensure is present and the group exists with Members passed that require one member to be added and one removed' {
It 'Should add a user and remove a user' {
$testMembers = @( $script:testMemberName1, $script:testMemberName3 )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName3 }
Assert-MockCalled -CommandName 'Remove-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Ensure is present and the group exists with MembersToInclude and MembersToExclude passed that require one member to be added and one removed' {
It 'Should add a user and remove a user' {
$testMembersToInclude = @( $script:testMemberName3 )
$testMembersToExclude = @( $script:testMemberName2 )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMemberstoInclude -MembersToExclude $testMemberstoExclude -Ensure 'Present'
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Add-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName3 }
Assert-MockCalled -CommandName 'Remove-LocalGroupMember' -ParameterFilter { $Group.Name -eq $script:testGroupName -and $Member.Name -eq $script:testMemberName2 }
}
}
Context 'When Members and MembersToInclude are both specified' {
It 'Should throw expected exception' {
$testMembers = @( $script:testMemberName1, $script:testMemberName2 )
$testMembersToInclude = @( $script:testMemberName3 )
$errorMessage = $script:localizedData.MembersAndIncludeExcludeConflict -f 'Members', 'MembersToInclude'
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
{ Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -MembersToInclude $testMembersToInclude -Ensure 'Present' } | Should -Throw -ExpectedMessage $errorMessage
}
}
Context 'When Members and MembersToExclude are both specified' {
It 'Should throw expected exception' {
$testMembers = @( $script:testMemberName1, $script:testMemberName2 )
$testMembersToExclude = @( $script:testMemberName3 )
$errorMessage = $script:localizedData.MembersAndIncludeExcludeConflict -f 'Members', 'MembersToExclude'
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
{ Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -MembersToExclude $testMembersToExclude -Ensure 'Present' } | Should -Throw -ExpectedMessage $errorMessage
}
}
Context 'When MembersToInclude and MembersToExclude both contain the same member' {
It 'Should throw expected exception' {
$testMembersToInclude = @( $script:testMemberName1 )
$testMembersToExclude = @( $script:testMemberName1 )
$errorMessage = $script:localizedData.IncludeAndExcludeConflict -f $script:testMemberName1, 'MembersToInclude', 'MembersToExclude'
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
{ Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembersToInclude -MembersToExclude $testMembersToExclude -Ensure 'Present' } | Should -Throw -ExpectedMessage $errorMessage
}
}
Context 'When Ensure is present and the group exists with members already containing all principals in the MembersToInclude' {
It 'Should not modify the group' {
$testMembers = @( $script:testMemberName1 )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
Context 'When Ensure is present and the group exists with members not containing any of the principals in the MembersToExclude' {
It 'Should not modify the group' {
$testMembers = @( $script:testMemberName3 )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToExclude $testMembers -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
Context 'When Ensure is present and the group exists with members that match the Members' {
It 'Should not modify the group' {
$testMembers = @( $script:testMemberName1, $script:testMemberName2 )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
Context 'When Ensure is present and the group exists with no members and the MembersToInclude is specified but Empty' {
It 'Should not modify the group' {
$testMembers = @( )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
Context 'When Ensure is present and the group exists with no members and the MembersToExclude is specified but Empty' {
It 'Should not modify the group' {
$testMembers = @( )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToExclude $testMembers -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
Context 'When Ensure is present and the group exists with no members and both MembersToInclude and MembersToExclude are empty' {
It 'Should not modify the group' {
$testMembers = @( )
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -MembersToExclude $testMembers -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
Context 'When Ensure is present and the group exists with no members and empty Members passed' {
It 'Should not modify the group' {
$testMembers = @( )
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
Context 'When Ensure is present and the group exists and no changes are made to the group' {
It 'Should not save group' {
Mock -CommandName 'Get-LocalGroup' -MockWith { return $script:testLocalGroup }
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { return @( $script:testMemberName1, $script:testMemberName2 ) }
Set-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Present'
Assert-GroupMembersNotChangedOnNanoServer
}
}
}
Describe 'GroupResource\Test-TargetResourceOnNanoServer' -Tag 'Helper' {
BeforeEach {
Reset-TestGroup
Mock -CommandName 'Get-LocalGroup' -MockWith { return $script:testLocalGroup }
Mock -CommandName 'Get-MembersOnNanoServer' -MockWith { }
}
Context 'When Ensure is absent and the group does not exist' {
It 'Should return true and expected mocks are called' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Absent' | Should -BeTrue
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Ensure is absent and the group exists' {
It 'Should return false and expected mocks are called' {
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Absent' | Should -BeFalse
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group does not exist' {
It 'Should return false and expected mocks are called' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message 'Test error message' -CategoryReason 'GroupNotFoundException' }
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Present' | Should -BeFalse
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Get-LocalGroup throws an exception other than GroupNotFound' {
It 'Should throw expected exception' {
Mock -CommandName 'Get-LocalGroup' -MockWith { Write-Error -Message $script:testErrorMessage -CategoryReason 'OtherException' }
{ Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Present' } | Should -Throw -ExpectedMessage $script:testErrorMessage
}
}
Context 'When Ensure is present and the group exists' {
It 'Should return true and expected mocks are called' {
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Ensure 'Present' | Should -BeTrue
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group exists and Description matches' {
It 'Should return true and expected mocks are called' {
$script:testLocalGroup.Description = $script:testGroupDescription
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Description $script:testGroupDescription -Ensure 'Present' | Should -BeTrue
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group exists and Description does not match' {
It 'Should return false and expected mocks are called' {
$script:testLocalGroup.Description = $script:testGroupDescription
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Description 'Wrong description' -Ensure 'Present' | Should -BeFalse
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group exists and with no members and Members should be empty' {
It 'Should return true and expected mocks are called' {
$testMembers = @( )
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present' | Should -BeTrue
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group exists mismatching number of members when passing Members' {
It 'Should return false and expected mocks are called' {
$testMembers = @( $script:testMemberName1 )
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -Members $testMembers -Ensure 'Present' | Should -BeFalse
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group exists with missing member when passing MembersToInclude' {
It 'Should return false and expected mocks are called' {
$testMembers = @( $script:testMemberName1 )
Test-TargetResourceOnNanoServer -GroupName $script:testGroupName -MembersToInclude $testMembers -Ensure 'Present' | Should -BeFalse
Assert-MockCalled -CommandName 'Get-LocalGroup' -ParameterFilter { $Name -eq $script:testGroupName }
Assert-MockCalled -CommandName 'Get-MembersOnNanoServer' -ParameterFilter { $Group.Name -eq $script:testGroupName }
}
}
Context 'When Ensure is present and the group exists with missing member when passing MembersToExclude' {
It 'Should return true and expected mocks are called' {