/
Instance.Assertions.ps1
821 lines (779 loc) · 35.9 KB
/
Instance.Assertions.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
<#
This file is used to hold the Assertions for the Instance.Tests
When adding new checks or improving existing ones -
- Ensure your branch is up to date with the development branch
- In the Instance.Assertions.ps1 - Add a New code block in the switch using the unique tag name
'MemoryDump' { # This is the unique tag
if ($There) { ## we need $There to save trying to gather information from later checks for an instance that is not contactable
## Then a try catch to gather the required information for the assertion and set a variable to a customobject
try {
$MaxDump = [pscustomobject] @{
# Warning Action removes dbatools output for version too low from test results
# Skip on the it will show in the results
Count = (Get-DbaDump -SqlInstance $psitem -WarningAction SilentlyContinue).Count
}
}
# In the catch set There to false and create an object with the same name but an obvious error entry
catch {
$There = $false
$MaxDump = [pscustomobject] @{
Count = 'We Could not Connect to $Instance'
}
}
}
# the else matches the catch block
else {
$There = $false
$MaxDump = [pscustomobject] @{
Count = 'We Could not Connect to $Instance'
}
}
}
- Create an Assertion for the Check
Name must start Assert
function Assert-MaxDump {
Pass in params for configs
Param($AllInstanceInfo,$maxdumps)
Ensure Because has good information
$AllInstanceInfo.MaxDump.Count | Should -BeLessThan $maxdumps -Because "We expected less than $maxdumps dumps but found $($AllInstanceInfo.MaxDump.Count). Memory dumps often suggest issues with the SQL Server instance"
}
- In The Instance.Tests.ps1 file create the check
# Must be in its own describe block, must use an s on Tags, first tag must be unique, last tag must be $filename
Describe "SQL Memory Dumps" -Tags MemoryDump, Medium, $filename {
# Gather any config items here so that the code to match config to check works
$maxdumps = Get-DbcConfigValue policy.dump.maxcount
# We check if the instance is contactable at the top of the file, use this block with the context title the same as the proper test below
if ($NotContactable -contains $psitem) {
Context "Checking that dumps on $psitem do not exceed $maxdumps for $psitem" {
It "Can't Connect to $Psitem" {
$false | Should -BeTrue -Because "The instance should be available to be connected to!"
}
}
}
else {
# The title must end $psitem
Context "Checking that dumps on $psitem do not exceed $maxdumps for $psitem" {
# The check itself - a skip can be added from a config value if required -Skip:$Skip or per version
It "dump count of $count is less than or equal to the $maxdumps dumps on $psitem" -Skip:($InstanceSMO.Version.Major -lt 10 ) {
# Call the assertion with any parameters here
Assert-MaxDump -AllInstanceInfo $AllInstanceInfo -maxdumps $maxdumps
}
}
}
}
- In the tests\checks\InstanceChecks.Tests.ps1 file add tests for the assertions by mocking passing and failing tests following the code in the file
- In a NEW session - checkout your branch of dbachecks
cd to the root of the repo
import the module with
ipmo .\dbachecks.psd1
Run the Pester tests
Invoke-Pester .\tests\ -ExcludeTag Integration -Show Fails
It starts with the Get-AllInstanceInfo which uses all of the unique
tags that have been passed and gathers the required information
which can then be used for the assertions.
The long term aim is to make Get-AllInstanceInfo as performant as
possible and to cover all of the tests
#>
function Get-AllInstanceInfo {
# Using the unique tags gather the information required
Param($Instance, $Tags, $There)
# Using there so that if the instance is not contactable, no point carrying on with gathering more information
switch ($tags) {
'ErrorLog' {
if ($There) {
try {
$logWindow = Get-DbcConfigValue -Name policy.errorlog.warningwindow
# so that it can be mocked
function Get-ErrorLogEntry {
# get the number of the first error log that was created after the logwindow config
$OldestErrorLogNumber = ($InstanceSMO.EnumErrorLogs() | Where-Object { $psitem.CreateDate -gt (Get-Date).AddDays( - $LogWindow) } | Sort-Object ArchiveNo -Descending | Select-Object -First 1).ArchiveNo + 1
# Get the Error Log entries for each one
(0..$OldestErrorLogNumber).ForEach{
$InstanceSMO.ReadErrorLog($psitem).Where{ $_.Text -match "Severity: 1[7-9]|Severity: 2[0-4]" }
}
}
# It is not enough to check the CreateDate on the log, you must check the LogDate on every error record as well.
$ErrorLog = @(Get-ErrorLogEntry).ForEach{
[PSCustomObject]@{
LogDate = $psitem.LogDate
ProcessInfo = $Psitem.ProcessInfo
Text = $Psitem.Text
} | Where-Object { $psitem.LogDate -gt (Get-Date).AddDays( - $LogWindow) }
}
}
catch {
$There = $false
$ErrorLog = [PSCustomObject]@{
LogDate = 'Do not know the Date'
ProcessInfo = 'Do not know the Process'
Text = 'Do not know the Test'
InstanceName = 'An Error occurred ' + $Instance
}
}
}
else {
$There = $false
$ErrorLog = [PSCustomObject]@{
LogDate = 'Do not know the Date'
ProcessInfo = 'Do not know the Process'
Text = 'Do not know the Test'
InstanceName = 'An Error occurred ' + $Instance
}
}
}
'DefaultTrace' {
if ($There) {
try {
$SpConfig = Get-DbaSpConfigure -SqlInstance $Instance -ConfigName 'DefaultTraceEnabled'
$DefaultTrace = [pscustomobject] @{
ConfiguredValue = $SpConfig.ConfiguredValue
}
}
catch {
$There = $false
$DefaultTrace = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$DefaultTrace = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
'OleAutomationProceduresDisabled' {
if ($There) {
try {
$SpConfig = Get-DbaSpConfigure -SqlInstance $Instance -ConfigName 'OleAutomationProceduresEnabled'
$OleAutomationProceduresDisabled = [pscustomobject] @{
ConfiguredValue = $SpConfig.ConfiguredValue
}
}
catch {
$There = $false
$OleAutomationProceduresDisabled = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$OleAutomationProceduresDisabled = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
'CrossDBOwnershipChaining' {
if ($There) {
try {
$SpConfig = Get-DbaSpConfigure -SqlInstance $Instance -ConfigName 'CrossDBOwnershipChaining'
$CrossDBOwnershipChaining = [pscustomobject] @{
ConfiguredValue = $SpConfig.ConfiguredValue
}
}
catch {
$There = $false
$CrossDBOwnershipChaining = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$CrossDBOwnershipChaining = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
'ScanForStartupProceduresDisabled' {
if ($There) {
try {
$SpConfig = Get-DbaSpConfigure -SqlInstance $Instance -ConfigName 'ScanForStartupProcedures'
$ScanForStartupProceduresDisabled = [pscustomobject] @{
ConfiguredValue = $SpConfig.ConfiguredValue
}
}
catch {
$There = $false
$ScanForStartupProceduresDisabled = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$ScanForStartupProceduresDisabled = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
'MemoryDump' {
if ($There) {
try {
$MaxDump = [pscustomobject] @{
# Warning Action removes dbatools output for version too low from test results
# Skip on the it will show in the results
Count = (Get-DbaDump -SqlInstance $Instance -WarningAction SilentlyContinue).Count
}
}
catch {
$There = $false
$MaxDump = [pscustomobject] @{
Count = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$MaxDump = [pscustomobject] @{
Count = 'We Could not Connect to $Instance'
}
}
}
'RemoteAccessDisabled' {
if ($There) {
try {
$SpConfig = Get-DbaSpConfigure -SqlInstance $Instance -ConfigName 'RemoteAccess'
$RemoteAccessDisabled = [pscustomobject] @{
ConfiguredValue = $SpConfig.ConfiguredValue
}
}
catch {
$There = $false
$RemoteAccessDisabled = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$RemoteAccessDisabled = [pscustomobject] @{
ConfiguredValue = 'We Could not Connect to $Instance'
}
}
}
'LatestBuild' {
if ($There) {
try {
$results = Test-DbaBuild -SqlInstance $Instance -Latest
$LatestBuild = [pscustomobject] @{
Compliant = $results.Compliant
}
}
catch {
$There = $false
$LatestBuild = [pscustomobject] @{
Compliant = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$LatestBuild = [pscustomobject] @{
Compliant = 'We Could not Connect to $Instance'
}
}
}
'SaDisabled' {
if ($There) {
try {
#This needs to be done in query just in case the account had already been renamed
$login = Get-DbaLogin -SqlInstance $server | Where-Object Id -eq 1
$SaDisabled = [pscustomobject] @{
Disabled = $login.IsDisabled
}
}
catch {
$There = $false
$SaDisabled = [pscustomobject] @{
Disabled = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$SaDisabled = [pscustomobject] @{
Disabled = 'We Could not Connect to $Instance'
}
}
}
'SaExist' {
if ($There) {
try {
$results = Get-DbaLogin -SqlInstance $Instance -Login sa
if ($null -eq $results.Name) {
$Exist = $false
}
else {
$Exist = $true
}
$SaExist = [pscustomobject] @{
Exist = $Exist
}
}
catch {
$There = $false
$SaExist = [pscustomobject] @{
Exist = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$SaExist = [pscustomobject] @{
Exist = 'We Could not Connect to $Instance'
}
}
}
'SqlEngineServiceAccount' {
if ($There) {
try {
$ComputerName , $InstanceName = $Instance.Name.Split('\')
if ($null -eq $InstanceName) {
$InstanceName = 'MSSQLSERVER'
}
$SqlEngineService = Get-DbaService -ComputerName $ComputerName -InstanceName $instanceName -Type Engine -ErrorAction SilentlyContinue
$EngineService = [pscustomobject] @{
State = $SqlEngineService.State
StartType = $SqlEngineService.StartMode
}
}
catch {
$There = $false
$EngineService = [pscustomobject] @{
State = 'We Could not Connect to $Instance $ComputerName , $InstanceName from catch'
StartType = 'We Could not Connect to $Instance $ComputerName , $InstanceName from catch'
}
}
}
else {
$There = $false
$EngineService = [pscustomobject] @{
State = 'We Could not Connect to $Instance'
StartType = 'We Could not Connect to $Instance'
}
}
}
'PublicRolePermission' {
if ($There) {
try {
#This needs to be done in query just in case the account had already been renamed
$query = "
SELECT Count(*) AS [RowCount]
FROM master.sys.server_permissions
WHERE (grantee_principal_id = SUSER_SID(N'public') and state_desc LIKE 'GRANT%')
AND NOT (state_desc = 'GRANT' and [permission_name] = 'VIEW ANY DATABASE' and class_desc = 'SERVER')
AND NOT (state_desc = 'GRANT' and [permission_name] = 'CONNECT' and class_desc = 'ENDPOINT' and major_id = 2)
AND NOT (state_desc = 'GRANT' and [permission_name] = 'CONNECT' and class_desc = 'ENDPOINT' and major_id = 3)
AND NOT (state_desc = 'GRANT' and [permission_name] = 'CONNECT' and class_desc = 'ENDPOINT' and major_id = 4)
AND NOT (state_desc = 'GRANT' and [permission_name] = 'CONNECT' and class_desc = 'ENDPOINT' and major_id = 5);
"
$results = Invoke-DbaQuery -SqlInstance $Instance -Query $query
Write-Output $results.RowCount
$PublicRolePermission = [pscustomobject] @{
Count = $results.RowCount
}
}
catch {
$There = $false
$PublicRolePermission = [pscustomobject] @{
Count = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$PublicRolePermission = [pscustomobject] @{
Count = 'We Could not Connect to $Instance'
}
}
}
'BuiltInAdmin' {
if ($There) {
try {
$results = Get-DbaLogin -SqlInstance $Instance -Login "BUILTIN\Administrators"
if ($null -eq $results.Name) {
$Exist = $false
}
else {
$Exist = $true
}
$BuiltInAdmin = [pscustomobject] @{
Exist = $Exist
}
}
catch {
$There = $false
$BuiltInAdmin = [pscustomobject] @{
Exist = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$BuiltInAdmin = [pscustomobject] @{
Exist = 'We Could not Connect to $Instance'
}
}
}
'LocalWindowsGroup' {
if ($There) {
try {
$logins = Get-DbaLogin -SqlInstance $Instance | Where-Object LoginType -eq WindowsGroup
if ($null -ne $logins) {
$LocalWindowsGroup = [pscustomobject] @{
Exist = $true
}
}
else {
$LocalWindowsGroup = [pscustomobject] @{
Exist = $false
}
}
}
catch {
$There = $false
$LocalWindowsGroup = [pscustomobject] @{
Exist = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$LocalWindowsGroup = [pscustomobject] @{
Exist = 'We Could not Connect to $Instance'
}
}
}
'LoginAuditFailed' {
if ($There) {
try {
$results = Get-DbaInstanceProperty -SQLInstance $instance -InstanceProperty AuditLevel
$LoginAuditFailed = [pscustomobject] @{
AuditLevel = $results.Value
}
}
catch {
$There = $false
$LoginAuditFailed = [pscustomobject] @{
AuditLevel = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$LoginAuditFailed = [pscustomobject] @{
AuditLevel = 'We Could not Connect to $Instance'
}
}
}
'LoginAuditSuccessful' {
if ($There) {
try {
$results = Get-DbaInstanceProperty -SQLInstance $instance -InstanceProperty AuditLevel
$LoginAuditSuccessful = [pscustomobject] @{
AuditLevel = $results.Value
}
}
catch {
$There = $false
$LoginAuditSuccessful = [pscustomobject] @{
AuditLevel = 'We Could not Connect to $Instance'
}
}
}
else {
$There = $false
$LoginAuditSuccessful = [pscustomobject] @{
AuditLevel = 'We Could not Connect to $Instance'
}
}
}
Default { }
}
[PSCustomObject]@{
ErrorLog = $ErrorLog
DefaultTrace = $DefaultTrace
MaxDump = $MaxDump
CrossDBOwnershipChaining = $CrossDBOwnershipChaining
ScanForStartupProceduresDisabled = $ScanForStartupProceduresDisabled
RemoteAccess = $RemoteAccessDisabled
OleAutomationProceduresDisabled = $OleAutomationProceduresDisabled
LatestBuild = $LatestBuild
SaExist = $SaExist
SaDisabled = $SaDisabled
EngineService = $EngineService
LoginAuditFailed = $LoginAuditFailed
LoginAuditSuccessful = $LoginAuditSuccessful
LocalWindowsGroup = $LocalWindowsGroup
BuiltInAdmin = $BuiltInAdmin
PublicRolePermission = $PublicRolePermission
}
}
function Assert-DefaultTrace {
Param($AllInstanceInfo)
$AllInstanceInfo.DefaultTrace.ConfiguredValue | Should -Be 1 -Because "We expected the Default Trace to be enabled"
}
function Assert-EngineState {
Param($AllInstanceInfo, $state)
$AllInstanceInfo.EngineService.State | Should -Be $state -Because "The SQL Service was expected to be $state"
}
function Assert-EngineStartType {
Param($AllInstanceInfo, $starttype)
$AllInstanceInfo.EngineService.StartType | Should -Be $starttype -Because "The SQL Service Start Type was expected to be $starttype"
}
function Assert-EngineStartTypeCluster {
Param($AllInstanceInfo)
$AllInstanceInfo.EngineService.StartType | Should -Be "Manual" -Because 'Clustered Instances required that the SQL engine service is set to manual'
}
function Assert-OleAutomationProcedures {
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
[CmdletBinding()]
Param($AllInstanceInfo)
$AllInstanceInfo.OleAutomationProceduresDisabled.ConfiguredValue | Should -Be 0 -Because "We expect the OLE Automation Procedures to be disabled"
}
function Assert-ScanForStartupProcedures {
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
[CmdletBinding()]
param ($AllInstanceInfo)
$AllInstanceInfo.ScanForStartupProceduresDisabled.ConfiguredValue | Should -Be 0 -Because "We expected the scan for startup procedures to be disabled"
}
function Assert-MaxDump {
Param($AllInstanceInfo, $maxdumps)
$AllInstanceInfo.MaxDump.Count | Should -BeLessThan $maxdumps -Because "We expected less than $maxdumps dumps but found $($AllInstanceInfo.MaxDump.Count). Memory dumps often suggest issues with the SQL Server instance"
}
function Assert-RemoteAccess {
param ($AllInstanceInfo)
$AllInstanceInfo.RemoteAccess.ConfiguredValue | Should -Be 0 -Because "We expected Remote Access to be disabled"
}
function Assert-InstanceMaxDop {
Param(
[string]$Instance,
[switch]$UseRecommended,
[int]$MaxDopValue
)
$MaxDop = @(Test-DbaMaxDop -SqlInstance $Instance)[0]
if ($UseRecommended) {
#if UseRecommended - check that the CurrentInstanceMaxDop property returned from Test-DbaMaxDop matches the the RecommendedMaxDop property
$MaxDop.CurrentInstanceMaxDop | Should -Be $MaxDop.RecommendedMaxDop -Because "We expect the MaxDop Setting to be the recommended value $($MaxDop.RecommendedMaxDop)"
}
else {
#if not UseRecommended - check that the CurrentInstanceMaxDop property returned from Test-DbaMaxDop matches the MaxDopValue parameter
$MaxDop.CurrentInstanceMaxDop | Should -Be $MaxDopValue -Because "We expect the MaxDop Setting to be $MaxDopValue"
}
}
function Assert-BackupCompression {
Param($Instance, $defaultbackupcompression)
(Get-DbaSpConfigure -SqlInstance $Instance -ConfigName 'DefaultBackupCompression').ConfiguredValue -eq 1 | Should -Be $defaultbackupcompression -Because 'The default backup compression should be set correctly'
}
function Assert-TempDBSize {
Param($Instance)
@((Get-DbaDbFile -SqlInstance $Instance -Database tempdb).Where{ $_.Type -eq 0 }.Size.Megabyte | Select-Object -Unique).Count | Should -Be 1 -Because "We want all the tempdb data files to be the same size - See https://blogs.sentryone.com/aaronbertrand/sql-server-2016-tempdb-fixes/ and https://www.brentozar.com/blitz/tempdb-data-files/ for more information"
}
function Assert-InstanceSupportedBuild {
Param(
[string]$Instance,
[int]$BuildWarning,
[string]$BuildBehind,
[DateTime]$Date
)
#If $BuildBehind check against SP/CU parameter to determine validity of the build
if ($BuildBehind) {
$results = Test-DbaBuild -SqlInstance $Instance -MaxBehind $BuildBehind
$Compliant = $results.Compliant
$Build = $results.build
$Compliant | Should -Be $true -Because "this build $Build should not be behind the required build"
#If no $BuildBehind only check against support dates
}
else {
$Results = Test-DbaBuild -SqlInstance $Instance -Latest
[DateTime]$SupportedUntil = Get-Date $results.SupportedUntil -Format O
$Build = $results.build
#If $BuildWarning, check for support date within the warning window
if ($BuildWarning) {
[DateTime]$expected = Get-Date ($Date).AddMonths($BuildWarning) -Format O
$SupportedUntil | Should -BeGreaterThan $expected -Because "this build $Build will be unsupported by Microsoft on $(Get-Date $SupportedUntil -Format O) which is less than $BuildWarning months away"
}
#If neither, check for Microsoft support date
else {
$SupportedUntil | Should -BeGreaterThan $Date -Because "this build $Build is now unsupported by Microsoft"
}
}
}
function Assert-TwoDigitYearCutoff {
Param(
[string]$Instance,
[int]$TwoDigitYearCutoff
)
(Get-DbaSpConfigure -SqlInstance $Instance -ConfigName 'TwoDigitYearCutoff').ConfiguredValue | Should -Be $TwoDigitYearCutoff -Because 'This is the value that you have chosen for Two Digit Year Cutoff configuration'
}
function Assert-TraceFlag {
Param(
[string]$SQLInstance,
[int[]]$ExpectedTraceFlag
)
if ($null -eq $ExpectedTraceFlag) {
(Get-DbaTraceFlag -SqlInstance $SQLInstance).TraceFlag | Should -BeNullOrEmpty -Because "We expect that there will be no Trace Flags set on $SQLInstance"
}
else {
@($ExpectedTraceFlag).ForEach{
(Get-DbaTraceFlag -SqlInstance $SQLInstance).TraceFlag | Should -Contain $PSItem -Because "We expect that Trace Flag $PsItem will be set on $SQLInstance"
}
}
}
function Assert-NotTraceFlag {
Param(
[string]$SQLInstance,
[int[]]$NotExpectedTraceFlag
)
if ($null -eq $NotExpectedTraceFlag) {
(Get-DbaTraceFlag -SqlInstance $SQLInstance).TraceFlag | Should -BeNullOrEmpty -Because "We expect that there will be no Trace Flags set on $SQLInstance"
}
else {
@($NotExpectedTraceFlag).ForEach{
(Get-DbaTraceFlag -SqlInstance $SQLInstance).TraceFlag | Should -Not -Contain $PSItem -Because "We expect that Trace Flag $PsItem will not be set on $SQLInstance"
}
}
}
function Assert-CLREnabled {
param (
$SQLInstance,
$CLREnabled
)
(Get-DbaSpConfigure -SqlInstance $SQLInstance -Name IsSqlClrEnabled).ConfiguredValue -eq 1 | Should -Be $CLREnabled -Because 'The CLR Enabled should be set correctly'
}
function Assert-CrossDBOwnershipChaining {
Param($AllInstanceInfo)
$AllInstanceInfo.CrossDBOwnershipChaining.ConfiguredValue | Should -Be 0 -Because "We expected the Cross DB Ownership Chaining to be disabled"
}
function Assert-AdHocDistributedQueriesEnabled {
param (
$SQLInstance,
$AdHocDistributedQueriesEnabled
)
(Get-DbaSpConfigure -SqlInstance $SQLInstance -Name AdHocDistributedQueriesEnabled).ConfiguredValue -eq 1 | Should -Be $AdHocDistributedQueriesEnabled -Because 'The AdHoc Distributed Queries Enabled setting should be set correctly'
}
function Assert-XpCmdShellDisabled {
param (
$SQLInstance,
$XpCmdShellDisabled
)
(Get-DbaSpConfigure -SqlInstance $SQLInstance -Name XPCmdShellEnabled).ConfiguredValue -eq 0 | Should -Be $XpCmdShellDisabled -Because 'The XP CmdShell setting should be set correctly'
}
function Assert-ErrorLogCount {
param (
$SQLInstance,
$errorLogCount
)
(Get-DbaErrorLogConfig -SqlInstance $SQLInstance).LogCount | Should -BeGreaterOrEqual $errorLogCount -Because "We expect to have at least $errorLogCount number of error log files"
}
function Assert-ErrorLogEntry {
Param($AllInstanceInfo)
$AllInstanceInfo.ErrorLog | Should -BeNullOrEmpty -Because "these severities indicate serious problems"
}
function Assert-LatestBuild {
Param($AllInstanceInfo)
$AllInstanceInfo.LatestBuild.Compliant | Should -Be $true -Because "We expected the SQL Server to be on the newest SQL Server Packs/CUs"
}
function Assert-SaDisabled {
Param($AllInstanceInfo)
$AllInstanceInfo.SaDisabled.Disabled | Should -Be $true -Because "We expected the original sa login to be disabled"
}
function Assert-SaExist {
Param($AllInstanceInfo)
$AllInstanceInfo.SaExist.Exist | Should -Be $false -Because "We expected no login to exist with the name sa"
}
function Assert-LocalWindowsGroup {
Param($AllInstanceInfo)
$AllInstanceInfo.LocalWindowsGroup.Exist | Should -Be $false -Because "We expected to have no local Windows groups as SQL logins"
}
function Assert-PublicRolePermission {
Param($AllInstanceInfo)
$AllInstanceInfo.PublicRolePermission.Count | Should -Be 0 -Because "We expected the public server role to have been granted no permissions"
}
function Assert-BuiltInAdmin {
Param($AllInstanceInfo)
$AllInstanceInfo.BuiltInAdmin.Exist | Should -Be $false -Because "We expected no login to exist with the name BUILTIN\Administrators"
}
function Assert-LoginAuditSuccessful {
Param($AllInstanceInfo)
$AllInstanceInfo.LoginAuditSuccessful.AuditLevel | Should -Be "All" -Because "We exepcted the audit level to be set to capture all logins (successfull and failed)"
}
function Assert-LoginAuditFailed {
Param($AllInstanceInfo)
$AllInstanceInfo.LoginAuditFailed.AuditLevel | Should -BeIn @("Failure", "All") -Because "We expected expected the audit level to be set to capture failed logins"
}
# SIG # Begin signature block
# MIINEAYJKoZIhvcNAQcCoIINATCCDP0CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUUSq5eR44NExtCJltIXTiayOj
# 3cCgggpSMIIFGjCCBAKgAwIBAgIQAsF1KHTVwoQxhSrYoGRpyjANBgkqhkiG9w0B
# AQsFADByMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYD
# VQQLExB3d3cuZGlnaWNlcnQuY29tMTEwLwYDVQQDEyhEaWdpQ2VydCBTSEEyIEFz
# c3VyZWQgSUQgQ29kZSBTaWduaW5nIENBMB4XDTE3MDUwOTAwMDAwMFoXDTIwMDUx
# MzEyMDAwMFowVzELMAkGA1UEBhMCVVMxETAPBgNVBAgTCFZpcmdpbmlhMQ8wDQYD
# VQQHEwZWaWVubmExETAPBgNVBAoTCGRiYXRvb2xzMREwDwYDVQQDEwhkYmF0b29s
# czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAI8ng7JxnekL0AO4qQgt
# Kr6p3q3SNOPh+SUZH+SyY8EA2I3wR7BMoT7rnZNolTwGjUXn7bRC6vISWg16N202
# 1RBWdTGW2rVPBVLF4HA46jle4hcpEVquXdj3yGYa99ko1w2FOWzLjKvtLqj4tzOh
# K7wa/Gbmv0Si/FU6oOmctzYMI0QXtEG7lR1HsJT5kywwmgcjyuiN28iBIhT6man0
# Ib6xKDv40PblKq5c9AFVldXUGVeBJbLhcEAA1nSPSLGdc7j4J2SulGISYY7ocuX3
# tkv01te72Mv2KkqqpfkLEAQjXgtM0hlgwuc8/A4if+I0YtboCMkVQuwBpbR9/6ys
# Z+sCAwEAAaOCAcUwggHBMB8GA1UdIwQYMBaAFFrEuXsqCqOl6nEDwGD5LfZldQ5Y
# MB0GA1UdDgQWBBRcxSkFqeA3vvHU0aq2mVpFRSOdmjAOBgNVHQ8BAf8EBAMCB4Aw
# EwYDVR0lBAwwCgYIKwYBBQUHAwMwdwYDVR0fBHAwbjA1oDOgMYYvaHR0cDovL2Ny
# bDMuZGlnaWNlcnQuY29tL3NoYTItYXNzdXJlZC1jcy1nMS5jcmwwNaAzoDGGL2h0
# dHA6Ly9jcmw0LmRpZ2ljZXJ0LmNvbS9zaGEyLWFzc3VyZWQtY3MtZzEuY3JsMEwG
# A1UdIARFMEMwNwYJYIZIAYb9bAMBMCowKAYIKwYBBQUHAgEWHGh0dHBzOi8vd3d3
# LmRpZ2ljZXJ0LmNvbS9DUFMwCAYGZ4EMAQQBMIGEBggrBgEFBQcBAQR4MHYwJAYI
# KwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmRpZ2ljZXJ0LmNvbTBOBggrBgEFBQcwAoZC
# aHR0cDovL2NhY2VydHMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0U0hBMkFzc3VyZWRJ
# RENvZGVTaWduaW5nQ0EuY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQAD
# ggEBANuBGTbzCRhgG0Th09J0m/qDqohWMx6ZOFKhMoKl8f/l6IwyDrkG48JBkWOA
# QYXNAzvp3Ro7aGCNJKRAOcIjNKYef/PFRfFQvMe07nQIj78G8x0q44ZpOVCp9uVj
# sLmIvsmF1dcYhOWs9BOG/Zp9augJUtlYpo4JW+iuZHCqjhKzIc74rEEiZd0hSm8M
# asshvBUSB9e8do/7RhaKezvlciDaFBQvg5s0fICsEhULBRhoyVOiUKUcemprPiTD
# xh3buBLuN0bBayjWmOMlkG1Z6i8DUvWlPGz9jiBT3ONBqxXfghXLL6n8PhfppBhn
# daPQO8+SqF5rqrlyBPmRRaTz2GQwggUwMIIEGKADAgECAhAECRgbX9W7ZnVTQ7Vv
# lVAIMA0GCSqGSIb3DQEBCwUAMGUxCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdp
# Q2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xJDAiBgNVBAMTG0Rp
# Z2lDZXJ0IEFzc3VyZWQgSUQgUm9vdCBDQTAeFw0xMzEwMjIxMjAwMDBaFw0yODEw
# MjIxMjAwMDBaMHIxCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMx
# GTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xMTAvBgNVBAMTKERpZ2lDZXJ0IFNI
# QTIgQXNzdXJlZCBJRCBDb2RlIFNpZ25pbmcgQ0EwggEiMA0GCSqGSIb3DQEBAQUA
# A4IBDwAwggEKAoIBAQD407Mcfw4Rr2d3B9MLMUkZz9D7RZmxOttE9X/lqJ3bMtdx
# 6nadBS63j/qSQ8Cl+YnUNxnXtqrwnIal2CWsDnkoOn7p0WfTxvspJ8fTeyOU5JEj
# lpB3gvmhhCNmElQzUHSxKCa7JGnCwlLyFGeKiUXULaGj6YgsIJWuHEqHCN8M9eJN
# YBi+qsSyrnAxZjNxPqxwoqvOf+l8y5Kh5TsxHM/q8grkV7tKtel05iv+bMt+dDk2
# DZDv5LVOpKnqagqrhPOsZ061xPeM0SAlI+sIZD5SlsHyDxL0xY4PwaLoLFH3c7y9
# hbFig3NBggfkOItqcyDQD2RzPJ6fpjOp/RnfJZPRAgMBAAGjggHNMIIByTASBgNV
# HRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBhjATBgNVHSUEDDAKBggrBgEF
# BQcDAzB5BggrBgEFBQcBAQRtMGswJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmRp
# Z2ljZXJ0LmNvbTBDBggrBgEFBQcwAoY3aHR0cDovL2NhY2VydHMuZGlnaWNlcnQu
# Y29tL0RpZ2lDZXJ0QXNzdXJlZElEUm9vdENBLmNydDCBgQYDVR0fBHoweDA6oDig
# NoY0aHR0cDovL2NybDQuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJlZElEUm9v
# dENBLmNybDA6oDigNoY0aHR0cDovL2NybDMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0
# QXNzdXJlZElEUm9vdENBLmNybDBPBgNVHSAESDBGMDgGCmCGSAGG/WwAAgQwKjAo
# BggrBgEFBQcCARYcaHR0cHM6Ly93d3cuZGlnaWNlcnQuY29tL0NQUzAKBghghkgB
# hv1sAzAdBgNVHQ4EFgQUWsS5eyoKo6XqcQPAYPkt9mV1DlgwHwYDVR0jBBgwFoAU
# Reuir/SSy4IxLVGLp6chnfNtyA8wDQYJKoZIhvcNAQELBQADggEBAD7sDVoks/Mi
# 0RXILHwlKXaoHV0cLToaxO8wYdd+C2D9wz0PxK+L/e8q3yBVN7Dh9tGSdQ9RtG6l
# jlriXiSBThCk7j9xjmMOE0ut119EefM2FAaK95xGTlz/kLEbBw6RFfu6r7VRwo0k
# riTGxycqoSkoGjpxKAI8LpGjwCUR4pwUR6F6aGivm6dcIFzZcbEMj7uo+MUSaJ/P
# QMtARKUT8OZkDCUIQjKyNookAv4vcn4c10lFluhZHen6dGRrsutmQ9qzsIzV6Q3d
# 9gEgzpkxYz0IGhizgZtPxpMQBvwHgfqL2vmCSfdibqFT+hKUGIUukpHqaGxEMrJm
# oecYpJpkUe8xggIoMIICJAIBATCBhjByMQswCQYDVQQGEwJVUzEVMBMGA1UEChMM
# RGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMTEwLwYDVQQD
# EyhEaWdpQ2VydCBTSEEyIEFzc3VyZWQgSUQgQ29kZSBTaWduaW5nIENBAhACwXUo
# dNXChDGFKtigZGnKMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEMMQowCKACgACh
# AoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQBgjcCAQsxDjAM
# BgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSUzgQRTdWd2Gr/xQpcs+8v4iRz
# YjANBgkqhkiG9w0BAQEFAASCAQAsrpN6w4z8xce6ddPsQUCJ1b/osoVcOGB4ViwD
# 5nENd2vU4GBgqZcDHkDBKmMJJhfsM/EaLbAN34ib52GoJxt9+3wYTWtHf+cAi4Ip
# chkVADcS3Npc1HssA+C2XZvQkuPd49kFruuxLsSqyx3CmDjR3l96Xw1W7sfzovvK
# 6aXHmKDBja4m1+M9jRGTgY6sPAYZR+Hjvrt7AkQprQOPZzvMytVyr76FU8UZh3Ov
# B9ZerFbJOao5fpYu5Smb3jDT0N3A7ZpA7mmYDM8UDMC/7v9DnuEFifrEqHC/mb8j
# woxXBA8s0AdK3CAh1G6Q3jEsZ4s6AWdFZSl8fQOU6JphgB8e
# SIG # End signature block