-
Notifications
You must be signed in to change notification settings - Fork 225
/
Copy pathDSC_SqlRole.Tests.ps1
1308 lines (1047 loc) · 54.1 KB
/
DSC_SqlRole.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
<#
.SYNOPSIS
Automated unit test for DSC_SqlRole DSC resource.
#>
Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath '..\TestHelpers\CommonTestHelper.psm1')
if (-not (Test-BuildCategory -Type 'Unit'))
{
return
}
$script:dscModuleName = 'SqlServerDsc'
$script:dscResourceName = 'DSC_SqlRole'
function Invoke-TestSetup
{
try
{
Import-Module -Name DscResource.Test -Force -ErrorAction 'Stop'
}
catch [System.IO.FileNotFoundException]
{
throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -Tasks build" first.'
}
$script:testEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:dscModuleName `
-DSCResourceName $script:dscResourceName `
-ResourceType 'Mof' `
-TestType 'Unit'
}
function Invoke-TestCleanup
{
Restore-TestEnvironment -TestEnvironment $script:testEnvironment
}
Invoke-TestSetup
try
{
InModuleScope $script:dscResourceName {
$mockServerName = 'localhost'
$mockInstanceName = 'MSSQLSERVER'
$mockSqlServerRole = 'AdminSqlforBI'
$mockSqlServerChildRole = 'TestChildRole'
$mockSqlServerLoginOne = 'CONTOSO\John'
$mockSqlServerLoginTwo = 'CONTOSO\Kelly'
$mockSqlServerLoginThree = 'CONTOSO\Lucy'
$mockSqlServerLoginFour = 'CONTOSO\Steve'
$mockSqlServerRoleSysAdmin = 'sysadmin'
$mockSqlServerSA = 'SA'
$mockEnumMemberNames = @(
$mockSqlServerLoginOne,
$mockSqlServerLoginTwo
)
$mockEnumMemberNamesSysAdmin = @(
$mockSqlServerLoginOne,
$mockSqlServerLoginTwo,
$mockSqlServerSA
)
$mockSecurityPrincipals = @(
$mockSqlServerLoginOne
$mockSqlServerLoginTwo
$mockSqlServerLoginThree
$mockSqlServerLoginFour
$mockSqlServerChildRole
)
$mockSecurityPrincipalsSysAdmin = @(
$mockSqlServerLoginOne
$mockSqlServerLoginTwo
$mockSqlServerLoginThree
$mockSqlServerLoginFour
$mockSqlServerChildRole
$mockSqlServerSA
)
$mockSqlServerLoginType = 'WindowsUser'
$mockExpectedServerRoleToDrop = 'ServerRoleToDrop'
$mockPrincipalsAsArrays = $false
# Default parameters that are used for the It-blocks
$mockDefaultParameters = @{
InstanceName = $mockInstanceName
ServerName = $mockServerName
}
#region Function mocks
$mockConnectSQL = {
$mockServerObjectHashtable = @{
InstanceName = $mockInstanceName
ComputerNamePhysicalNetBIOS = $mockServerName
Name = "$mockServerName\$mockInstanceName"
}
if ($mockPrincipalsAsArrays)
{
$mockServerObjectHashtable += @{
Logins = @()
Roles = @()
}
}
else
{
$mockServerObjectHashtable += @{
Logins = @{}
Roles = @{}
}
}
$mockServerObject = [PSCustomObject]$mockServerObjectHashtable
# Add the roles to the mock Server objet
foreach ($mockRole in $($mockSqlServerRole, $mockSqlServerChildRole))
{
# Create the role objet
$mockRoleObject = [PSCustomObject]@{
Name = $mockRole
}
# Add mocked methods
$mockRoleObject | Add-Member -MemberType ScriptMethod -Name EnumMemberNames -Value {
if ($mockInvalidOperationForEnumMethod)
{
throw 'Mock EnumMemberNames Method was called with invalid operation.'
}
else
{
$mockEnumMemberNames
}
} -PassThru |
Add-Member -MemberType ScriptMethod -Name Drop -Value {
if ($mockInvalidOperationForDropMethod)
{
throw 'Mock Drop Method was called with invalid operation.'
}
if ( $this.Name -ne $mockExpectedServerRoleToDrop )
{
throw "Called mocked drop() method without dropping the right server role. Expected '{0}'. But was '{1}'." `
-f $mockExpectedServerRoleToDrop, $this.Name
}
} -PassThru |
Add-Member -MemberType ScriptMethod -Name AddMember -Value {
param
(
[Parameter(Mandatory = $true)]
[String]
$memberName
)
if ($mockInvalidOperationForAddMemberMethod)
{
throw 'Mock AddMember Method was called with invalid operation.'
}
if ($mockExpectedMemberToAdd -ne $memberName)
{
throw "Called mocked AddMember() method without adding the right login. Expected '{0}'. But was '{1}'." `
-f $mockExpectedMemberToAdd, $memberName
}
} -PassThru |
Add-Member -MemberType ScriptMethod -Name DropMember -Value {
param
(
[Parameter(Mandatory = $true)]
[String]
$memberName
)
if ($mockInvalidOperationForDropMemberMethod)
{
throw 'Mock DropMember Method was called with invalid operation.'
}
if ($mockExpectedMemberToDrop -ne $memberName)
{
throw "Called mocked DropMember() method without removing the right login. Expected '{0}'. But was '{1}'." `
-f $mockExpectedMemberToDrop, $memberName
}
}
# Add the mock role to the roles collection
if ($mockServerObject.Roles -is [array])
{
$mockServerObject.Roles += $mockRoleObject
}
else
{
$mockServerObject.Roles.Add($mockRole, $mockRoleObject)
}
}
# Add all mock logins
foreach ($mockLoginName in @($mockSqlServerLoginOne, $mockSqlServerLoginTwo, $mockSqlServerLoginThree, $mockSqlServerLoginFour))
{
$mockLoginObject = [PSCustomObject]@{
Name = $mockLoginName
LoginType = $mockSqlServerLoginType
}
if ($mockServerObject.Logins -is [array])
{
$mockServerObject.Logins += $mockLoginObject
}
else
{
$mockServerObject.Logins.Add($mockLoginName, $mockLoginObject)
}
}
return @($mockServerObject)
}
$mockNewObjectServerRole = {
$mockObject = [PSCustomObject] @{
Name = $mockSqlServerRoleAdd
}
$mockObject | Add-Member -MemberType ScriptMethod -Name Create -Value {
if ($mockInvalidOperationForCreateMethod)
{
throw 'Mock Create Method was called with invalid operation.'
}
if ( $this.Name -ne $mockExpectedServerRoleToCreate )
{
throw "Called mocked Create() method without adding the right server role. Expected '{0}'. But was '{1}'." `
-f $mockExpectedServerRoleToCreate, $this.Name
}
}
return @($mockObject)
}
#endregion
Describe "DSC_SqlRole\Get-TargetResource" -Tag 'Get' {
BeforeAll {
Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable
}
Context 'When the system is in the desired state and ensure is set to Absent' {
$testParameters = $mockDefaultParameters
$testParameters += @{
ServerRoleName = 'UnknownRoleName'
}
$result = Get-TargetResource @testParameters
It 'Should return the state as absent when the role does not exist' {
$result.Ensure | Should -Be 'Absent'
}
It 'Should return the members as null' {
$result.membersInRole | Should -Be $null
}
It 'Should return the same values as passed as parameters' {
$result.ServerName | Should -Be $testParameters.ServerName
$result.InstanceName | Should -Be $testParameters.InstanceName
$result.ServerRoleName | Should -Be $testParameters.ServerRoleName
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When the system is not in the desired state and ensure is set to Absent' {
$testParameters = $mockDefaultParameters
$testParameters += @{
ServerRoleName = $mockSqlServerRole
}
$result = Get-TargetResource @testParameters
It 'Should not return the state as absent when the role exist' {
$result.Ensure | Should -Not -Be 'Absent'
}
It 'Should return the members as not null' {
$result.Members | Should -Not -Be $null
}
# Regression test for issue #790
It 'Should return the members as string array' {
($result.Members -is [System.String[]]) | Should -BeTrue
}
It 'Should return the same values as passed as parameters' {
$result.ServerName | Should -Be $testParameters.ServerName
$result.InstanceName | Should -Be $testParameters.InstanceName
$result.ServerRoleName | Should -Be $testParameters.ServerRoleName
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When passing values to parameters and throwing with EnumMemberNames method' {
It 'Should throw the correct error' {
$mockInvalidOperationForEnumMethod = $true
$testParameters = $mockDefaultParameters
$testParameters += @{
ServerRoleName = $mockSqlServerRole
}
$errorMessage = $script:localizedData.EnumMemberNamesServerRoleGetError `
-f $mockServerName, $mockInstanceName, $mockSqlServerRole
{ Get-TargetResource @testParameters } | Should -Throw $errorMessage
}
It 'Should call the mock function Connect-SQL' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Assert-VerifiableMock
}
Describe "DSC_SqlRole\Test-TargetResource" -Tag 'Test' {
BeforeAll {
Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable
}
Context 'When the system is not in the desired state and ensure is set to Absent' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Absent'
ServerRoleName = $mockSqlServerRole
}
$result = Test-TargetResource @testParameters
It 'Should return false when desired server role exist' {
$result | Should -BeFalse
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When the system is in the desired state and ensure is set to Absent' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Absent'
ServerRoleName = 'newServerRole'
}
$result = Test-TargetResource @testParameters
It 'Should return true when desired server role does not exist' {
$result | Should -BeTrue
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When the system is in the desired state and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
}
$result = Test-TargetResource @testParameters
It 'Should return true when desired server role exist' {
$result | Should -BeTrue
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When the system is not in the desired state and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = 'newServerRole'
}
$result = Test-TargetResource @testParameters
It 'Should return false when desired server role does not exist' {
$result | Should -BeFalse
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When the system is not in the desired state and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = @($mockSqlServerLoginThree, $mockSqlServerLoginFour)
}
$result = Test-TargetResource @testParameters -verbose
It 'Should return false when desired members are not in desired server role' {
$result | Should -BeFalse
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When both the parameters Members and MembersToInclude are assigned a value and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = $mockEnumMemberNames
MembersToInclude = $mockSqlServerLoginThree
}
$errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull
It 'Should throw the correct error' {
{ Test-TargetResource @testParameters } | Should -Throw '(DRC0010)'
}
It 'Should not be executed' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 0 -Scope Context
}
}
Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToInclude = $mockSqlServerLoginTwo
}
$result = Test-TargetResource @testParameters
It 'Should return true when desired server role exist' {
$result | Should -BeTrue
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = 'RoleNotExist' # $mockSqlServerRole
MembersToInclude = $mockSqlServerLoginThree
}
$result = Test-TargetResource @testParameters
It 'Should return false when desired server role does not exist' {
$result | Should -BeFalse
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When both the parameters Members and MembersToExclude are assigned a value and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = $mockEnumMemberNames
MembersToExclude = $mockSqlServerLoginTwo
}
$errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull
It 'Should throw the correct error' {
{Test-TargetResource @testParameters} | Should -Throw '(DRC0010)'
}
It 'Should not be executed' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 0 -Scope Context
}
}
Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToExclude = $mockSqlServerLoginThree
}
$mockEnumMemberNames
$result = Test-TargetResource @testParameters
It 'Should return true when desired server role does not exist' {
$result | Should -BeTrue
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToExclude = $mockSqlServerLoginTwo
}
$result = Test-TargetResource @testParameters
It 'Should return false when desired server role exist' {
$result | Should -BeFalse
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Assert-VerifiableMock
}
Describe "DSC_SqlRole\Set-TargetResource" -Tag 'Set' {
BeforeAll {
Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable
Mock -CommandName New-Object -MockWith $mockNewObjectServerRole -ParameterFilter {
$TypeName -eq 'Microsoft.SqlServer.Management.Smo.ServerRole'
}
Mock -CommandName Test-SqlSecurityPrincipal -MockWith {
return ($mockSecurityPrincipals -contains $SecurityPrincipal)
}
}
Context 'When the system is not in the desired state and ensure is set to Absent' {
$mockSqlServerRole = 'ServerRoleToDrop'
$mockExpectedServerRoleToDrop = 'ServerRoleToDrop'
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Absent'
ServerRoleName = $mockSqlServerRole
}
It 'Should not throw when calling the drop method' {
{ Set-TargetResource @testParameters } | Should -Not -Throw
}
It 'Should be executed once' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope Context
}
}
Context 'When the system is not in the desired state and ensure is set to Absent' {
It 'Should throw the correct error when calling the drop method' {
$mockInvalidOperationForDropMethod = $true
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Absent'
ServerRoleName = $mockSqlServerRole
}
$errorMessage = $script:localizedData.DropServerRoleSetError `
-f $mockServerName, $mockInstanceName, $mockSqlServerRole
{ Set-TargetResource @testParameters } | Should -Throw $errorMessage
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When the system is not in the desired state and ensure is set to Present' {
It 'Should not throw when calling the create method' {
$mockSqlServerRoleAdd = 'ServerRoleToAdd'
$mockExpectedServerRoleToCreate = 'ServerRoleToAdd'
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRoleAdd
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
It 'Should call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.ServerRole' {
Assert-MockCalled -CommandName New-Object -Exactly -Times 1 -ParameterFilter {
$TypeName -eq 'Microsoft.SqlServer.Management.Smo.ServerRole'
} -Scope Context
}
}
Context 'When the system is not in the desired state and ensure is set to Present' {
It 'Should throw the correct error when calling the create method' {
$mockSqlServerRoleAdd = 'ServerRoleToAdd'
$mockExpectedServerRoleToCreate = 'ServerRoleToAdd'
$mockInvalidOperationForCreateMethod = $true
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRoleAdd
}
$errorMessage = $script:localizedData.CreateServerRoleSetError `
-f $mockServerName, $mockInstanceName, $mockSqlServerRoleAdd
{ Set-TargetResource @testParameters } | Should -Throw $errorMessage
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
It 'Should call the mock function New-Object with TypeName equal to Microsoft.SqlServer.Management.Smo.ServerRole' {
Assert-MockCalled -CommandName New-Object -Exactly -Times 1 -ParameterFilter {
$TypeName -eq 'Microsoft.SqlServer.Management.Smo.ServerRole'
} -Scope Context
}
}
Context 'When both the parameters Members and MembersToInclude are assigned a value and ensure is set to Present' {
It 'Should throw the correct error' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = $mockEnumMemberNames
MembersToInclude = $mockSqlServerLoginThree
}
#$errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull
{ Set-TargetResource @testParameters } | Should -Throw '(DRC0010)'
}
It 'Should should not call Connect-SQL' {
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 0 -Scope Context
}
}
Context 'When both the parameters Members and MembersToExclude are assigned a value and ensure is set to Present' {
It 'Should throw the correct error' {
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = $mockEnumMemberNames
MembersToExclude = $mockSqlServerLoginTwo
}
$errorMessage = $script:localizedData.MembersToIncludeAndExcludeParamMustBeNull
{ Set-TargetResource @testParameters } | Should -Throw '(DRC0010)'
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 0 -Scope It
}
}
Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
It 'Should not thrown when calling the AddMember method' {
$mockExpectedMemberToAdd = $mockSqlServerLoginThree
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToInclude = $mockSqlServerLoginThree
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
It 'Should throw the correct error when calling the AddMember method' {
$mockInvalidOperationForAddMemberMethod = $true
$mockExpectedMemberToAdd = $mockSqlServerLoginThree
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToInclude = $mockSqlServerLoginThree
}
$errorMessage = $script:localizedData.AddMemberServerRoleSetError `
-f $mockServerName, $mockInstanceName, $mockSqlServerRole, $mockSqlServerLoginThree
{ Set-TargetResource @testParameters } | Should -Throw $errorMessage
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When parameter MembersToInclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
It 'Should throw the correct error when login does not exist' {
$mockExpectedMemberToAdd = $mockSqlServerLoginThree
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToInclude = 'KingJulian'
}
$errorMessage = $script:localizedData.AddMemberServerRoleSetError -f (
$mockServerName,
$mockInstanceName,
$mockSqlServerRole,
'KingJulian'
)
{ Set-TargetResource @testParameters } | Should -Throw $errorMessage
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
It 'Should not throw when calling the DropMember method' {
$mockExpectedMemberToDrop = $mockSqlServerLoginTwo
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToExclude = $mockSqlServerLoginTwo
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
It 'Should throw the correct error when calling the DropMember method' {
$mockInvalidOperationForDropMemberMethod = $true
$mockExpectedMemberToDrop = $mockSqlServerLoginTwo
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToExclude = $mockSqlServerLoginTwo
}
$errorMessage = $script:localizedData.DropMemberServerRoleSetError `
-f $mockServerName, $mockInstanceName, $mockSqlServerRole, $mockSqlServerLoginTwo
{ Set-TargetResource @testParameters } | Should -Throw $errorMessage
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When parameter MembersToExclude is assigned a value, parameter Members is not assigned a value, and ensure is set to Present' {
It 'Should throw the correct error when login does not exist' {
$mockEnumMemberNames = @('KingJulian', $mockSqlServerLoginOne, $mockSqlServerLoginTwo)
$mockExpectedMemberToAdd = $mockSqlServerLoginThree
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToExclude = 'KingJulian'
}
$errorMessage = $script:localizedData.DropMemberServerRoleSetError -f (
$mockServerName,
$mockInstanceName,
$mockSqlServerRole,
'KingJulian'
)
{ Set-TargetResource @testParameters } | Should -Throw $errorMessage
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When parameter Members is assigned a value and ensure is set to Present' {
It 'Should throw the correct error when login does not exist' {
$mockExpectedMemberToDrop = $mockSqlServerLoginTwo
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = @('KingJulian', $mockSqlServerLoginOne, $mockSqlServerLoginThree)
}
$errorMessage = $script:localizedData.AddMemberServerRoleSetError -f (
$mockServerName,
$mockInstanceName,
$mockSqlServerRole,
'KingJulian'
)
{ Set-TargetResource @testParameters } | Should -Throw $errorMessage
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When Members parameter is set and ensure parameter is set to Present' {
It 'Should not throw when calling both the AddMember and DropMember methods' {
$mockExpectedMemberToAdd = $mockSqlServerLoginThree
$mockExpectedMemberToDrop = $mockSqlServerLoginTwo
$testParameters = $mockDefaultParameters
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = @($mockSqlServerLoginOne, $mockSqlServerLoginThree)
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When nesting role membership' {
Context 'When defining an explicit list of members.' {
It 'Should not throw when the member is a Role' {
$mockExpectedMemberToAdd = $mockSqlServerChildRole
$testParameters = $mockDefaultParameters.Clone()
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
Members = @($mockSqlServerLoginOne, $mockSqlServerLoginTwo, $mockSqlServerChildRole)
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When specifying a list of security principals to include in the Role.' {
It 'Should not throw when a member to include is a Role.' {
$mockExpectedMemberToAdd = $mockSqlServerChildRole
$testParameters = $mockDefaultParameters.Clone()
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToInclude = @($mockSqlServerChildRole)
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When specifying a list of security principals to remove from the Role.' {
It 'Should not throw when the member to exclude is a Role.' {
$mockExpectedMemberToDrop = $mockSqlServerChildRole
$testParameters = $mockDefaultParameters.Clone()
$testParameters += @{
Ensure = 'Present'
ServerRoleName = $mockSqlServerRole
MembersToExclude = @($mockSqlServerChildRole)
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
}
Context 'When evaluating role membership, case sensitivity should not be used. (Issue #1153)' {
Context 'When specifying explicit role members.' {
It 'Should not attempt to remove an explicit member from the role.' {
$mockExpectedMemberToDrop = $mockSqlServerLoginTwo
$testParameters = $mockDefaultParameters.Clone()
$testParameters += @{
ServerRoleName = $mockSqlServerRole
Ensure = 'Present'
Members = $mockSqlServerLoginOne.ToUpper()
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
It 'Should not attempt to add an explicit member that already exists in the role.' {
$mockExpectedMemberToAdd = ''
$testParameters = $mockDefaultParameters.Clone()
$testParameters += @{
ServerRoleName = $mockSqlServerRole
Ensure = 'Present'
Members = @($mockSqlServerLoginOne.ToUpper(), $mockSqlServerLoginTwo)
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
Context 'When specifying mandatory role membership.' {
It 'Should not attempt to add a member that already exists in the role.' {
$mockExpectedMemberToAdd = ''
$testParameters = $mockDefaultParameters.Clone()
$testParameters += @{
ServerRoleName = $mockSqlServerRole
Ensure = 'Present'
MembersToInclude = @($mockSqlServerLoginOne.ToUpper())
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
It 'Should attempt to remove a member that is to be excluded.' {
$mockExpectedMemberToDrop = $mockSqlServerLoginOne
$testParameters = $mockDefaultParameters.Clone()
$testParameters += @{
ServerRoleName = $mockSqlServerRole
Ensure = 'Present'
MembersToExclude = @($mockSqlServerLoginOne.ToUpper())
}
{ Set-TargetResource @testParameters } | Should -Not -Throw
Assert-MockCalled -CommandName Connect-SQL -Exactly -Times 1 -Scope It
}
}
}
Assert-VerifiableMock
}
Describe 'DSC_SqlRole\Test-SqlSecurityPrincipal' -Tag 'Helper' {
BeforeAll {
Mock -CommandName Connect-SQL -MockWith $mockConnectSQL -Verifiable
$mockPrincipalsAsArrays = $true
$testSqlServerObject = Connect-SQL -ServerName $mockServerName -InstanceName $mockInstanceName
}
Context 'When the security principal does not exist.' {
It 'Should throw the correct exception' {
$testSecurityPrincipal = 'Nabrond'
$testParameters = @{
SqlServerObject = $testSqlServerObject
SecurityPrincipal = $testSecurityPrincipal
}
$testErrorMessage = $script:localizedData.SecurityPrincipalNotFound -f (
$testSecurityPrincipal,
"$mockServerName\$mockInstanceName"
)
{ Test-SqlSecurityPrincipal @testParameters } | Should -Throw -ExpectedMessage $testErrorMessage
}
<#
@person doing the code review: This test should fail. the only reason $result is False, is because it is not filled.
eg powershell evolves an empty variable to false. i vote to remove this test, but do not know the history of this test
and why it is in here.
#>
It 'Should return false when ErrorAction is set to SilentlyContinue' {
$testSecurityPrincipal = 'Nabrond'
$testParameters = @{
SqlServerObject = $testSqlServerObject
SecurityPrincipal = $testSecurityPrincipal
}
<#
Pester will still see the error on the stack regardless of the value used for ErrorAction
Wrap this call in a try/catch to swallow the exception and capture the return value.
#>