add filesafeoperator + small improves + configs

Author: ClaudioESSilva

source/checks/Agentv5.Tests.ps1

@@ -31,23 +31,26 @@ BeforeDiscovery {
             }
         }
     }
+
     Write-PSFMessage -Message "Instances = $($InstancesToTest.Name)" -Level Verbose
     Set-PSFConfig -Module dbachecks -Name global.notcontactable -Value $NotContactable
-}
 
+    # Get-DbcConfig is expensive so we call it once
+    $__dbcconfig = Get-DbcConfig
+}
 
-Describe "Database Mail XPs" -Tag DatabaseMailEnabled, CIS, security -ForEach $InstancesToTest {
-    $skip = Get-DbcConfigValue skip.agent.databasemailenabled
+Describe "Database Mail XPs" -Tag DatabaseMailEnabled, CIS, security, Agent -ForEach $InstancesToTest {
+    $skip = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.databasemailenabled' }).Value
     Context "Testing Database Mail XPs on <_.Name>" {
-        It "Testing Database Mail XPs is set to <_.DatabaseMailEnabled> on <_.Name>" -Skip:$skip {
+        It "Testing Database Mail XPs is set to <_.ConfigValues.DatabaseMailEnabled> on <_.Name>" -Skip:$skip {
             $PSItem.DatabaseMailEnabled | Should -Be $PSItem.ConfigValues.DatabaseMailEnabled -Because 'The Database Mail XPs setting should be set correctly'
         }
     }
 }
 
-Describe "SQL Agent Account" -Tag AgentServiceAccount, ServiceAccount -ForEach $InstancesToTest {
-    $skipServiceState = Get-DbcConfigValue skip.agent.servicestate
-    $skipServiceStartMode = Get-DbcConfigValue skip.agent.servicestartmode
+Describe "SQL Agent Account" -Tag AgentServiceAccount, ServiceAccount, Agent -ForEach $InstancesToTest {
+    $skipServiceState = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.servicestate' }).Value
+    $skipServiceStartMode = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.servicestartmode' }).Value
 
     Context "Testing SQL Agent is running on <_.Name>" {
         It "SQL Agent should be running for <_.InstanceName> on <_.Name>" -Skip:$skipServiceState {
@@ -66,9 +69,9 @@ Describe "SQL Agent Account" -Tag AgentServiceAccount, ServiceAccount -ForEach $
     }
 }
 
-Describe "DBA Operator" -Tag DbaOperator, Operator -ForEach $InstancesToTest {
-    $skipOperatorName = Get-DbcConfigValue skip.agent.operatorname
-    $skipOperatorEmail = Get-DbcConfigValue skip.agent.operatoremail
+Describe "DBA Operator" -Tag DbaOperator, Operator, Agent -ForEach $InstancesToTest {
+    $skipOperatorName = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.dbaoperatorname' }).Value
+    $skipOperatorEmail = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.dbaoperatoremail' }).Value
 
     Context "Testing DBA Operators exists on <_.Name>" {
         It "The Operator <_.ExpectedOperatorName> exists on <_.Name>" -Skip:$skipOperatorName -ForEach ($PSItem.Operator | Where-Object ExpectedOperatorName -NE 'null') {
@@ -81,23 +84,28 @@ Describe "DBA Operator" -Tag DbaOperator, Operator -ForEach $InstancesToTest {
     }
 }
 
-# Describe "Failsafe Operator" -Tags FailsafeOperator, Operator, $filename {
-#     if ($NotContactable -contains $psitem) {
-#         Context "Testing failsafe operator exists on $psitem" {
-#             It "Can't Connect to $Psitem" {
-#                 $false | Should -BeTrue -Because "The instance should be available to be connected to!"
-#             }
-#         }
-#     }
-#     else {
-#         Context "Testing failsafe operator exists on $psitem" {
-#             $failsafeoperator = Get-DbcConfigValue agent.failsafeoperator
-#             It "The Failsafe Operator exists on $psitem" {
-#                 (Connect-DbaInstance -SqlInstance $psitem).JobServer.AlertSystem.FailSafeOperator | Should -Be $failsafeoperator -Because 'The failsafe operator will ensure that any job failures will be notified to someone if not set explicitly'
-#             }
-#         }
-#     }
-# }
+Describe "Failsafe operator" -Tag FailsafeOperator, CIS, security, Agent -ForEach $InstancesToTest {
+    $skipFailsafeOperator = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.failsafeoperator' }).Value
+
+    Context "Testing failsafe operator exists on <_.Name>" {
+        It "The failsafe operator <_.FailSafeOperator.ExpectedFailSafeOperator> exists on <_.Name>" -Skip:$skipFailsafeOperator {
+            $PSItem.FailSafeOperator.ActualFailSafeOperator | Should -Be $PSItem.FailSafeOperator.ExpectedFailSafeOperator -Because 'The failsafe operator will ensure that any job failures will be notified to someone if not set explicitly'
+        }
+    }
+}
+
+#
+## Write-PSFMessage -Message "Tags = $Tags" -Level Verbose
+#
+#Describe "Failsafe Operator" -Tag FailsafeOperator, Operator, Agent -ForEach $InstancesToTest {
+#    $skipFailsafeOperator = Get-DbcConfigValue skip.agent.failsafeoperator
+#  
+#    Context "Testing failsafe operator exists on <_.Name>" {
+#        It "The Failsafe Operator <_.ExpectedFailSafeOperator> exists on <_.Name>" -Skip:$skipFailsafeOperator  -ForEach ($PSItem.AlertSystem | Where-Object ExpectedFailSafeOperator -NE 'null') {
+#            $PSItem.ExpectedFailSafeOperator | Should -Be $PSItem.ActualFailSafeOperator -Because 'The failsafe operator will ensure that any job failures will be notified to someone if not set explicitly'
+#        }
+#    }
+#}
 
 # Describe "Database Mail Profile" -Tags DatabaseMailProfile, $filename {
 #     if ($NotContactable -contains $psitem) {

source/internal/configurations/configuration.ps1

@@ -338,8 +338,8 @@ Set-PSFConfig -Module dbachecks -Name skip.hadr.listener.pingcheck -Validation b
 Set-PSFConfig -Module dbachecks -Name skip.agent.databasemailenabled -Validation bool -Value $false -Initialize -Description "Skip the Database Mail Enabled agent check"
 Set-PSFConfig -Module dbachecks -Name skip.agent.servicestartmode -Validation bool -Value $false -Initialize -Description "Skip the Agent Service State check"
 Set-PSFConfig -Module dbachecks -Name skip.agent.servicestate -Validation bool -Value $false -Initialize -Description "Skip the Agent Service Start Mode check"
-Set-PSFConfig -Module dbachecks -Name skip.agent.operatorname -Validation bool -Value $false -Initialize -Description "Skip the Agent Operator Name check"
-Set-PSFConfig -Module dbachecks -Name skip.agent.operatoremail -Validation bool -Value $false -Initialize -Description "Skip the Agent Operator Email check"
+Set-PSFConfig -Module dbachecks -Name skip.agent.dbaoperatorname -Validation bool -Value $false -Initialize -Description "Skip the Agent Operator Name check"
+Set-PSFConfig -Module dbachecks -Name skip.agent.dbaoperatoremail -Validation bool -Value $false -Initialize -Description "Skip the Agent Operator Email check"
 Set-PSFConfig -Module dbachecks -Name skip.agent.failsafeoperator -Validation bool -Value $false -Initialize -Description "Skip the Agent Failsafe Operator check"
 Set-PSFConfig -Module dbachecks -Name skip.agent.longrunningjobs -Validation bool -Value $false -Initialize -Description "Skip the long running agent jobs check"
 Set-PSFConfig -Module dbachecks -Name skip.agent.lastjobruntime -Validation bool -Value $false -Initialize -Description "Skip the last agent job time check"

source/internal/functions/Get-AllAgentInfo.ps1

@@ -8,6 +8,7 @@ function Get-AllAgentInfo {
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Login], $false)
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.Job], $false)
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.Operator], $false)
+    $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.AlertSystem], $false)
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.StoredProcedure], $false)
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Information], $false)
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Settings], $false)
@@ -102,28 +103,19 @@ function Get-AllAgentInfo {
             }
         }
         'FailsafeOperator' {
-            $FailsafeInitFields.Add("Name") | Out-Null # so we can check failsafe operators
+            $FailsafeInitFields.Add("FailSafeOperator") | Out-Null # so we can check failsafe operators
             $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.AlertSystem], $FailsafeInitFields)
             $FailsafeInitFields = $Instance.GetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.AlertSystem])
 
             $ConfigValues | Add-Member -MemberType NoteProperty -Name 'FailsafeOperator' -Value (Get-DbcConfigValue agent.failsafeoperator)
 
-            $Operator = $ConfigValues.FailsafeOperator.ForEach{
+            $failsafeOperator = $ConfigValues.FailsafeOperator.ForEach{
                 [PSCustomObject]@{
                     InstanceName             = $Instance.Name
                     ExpectedFailSafeOperator = $PSItem
-                    ActualOperatorName       = $Instance.JobServer.AlertSystem.Name
+                    ActualFailSafeOperator   = $Instance.JobServer.AlertSystem.FailSafeOperator
                 }
             }
-
-            $Operator += $ConfigValues.FailsafeOperator.ForEach{
-                [PSCustomObject]@{
-                    InstanceName             = $Instance.Name
-                    ExpectedFailSafeOperator = 'null'
-                    ActualOperatorName       = 'null'
-                }
-            }
-
         }
         'DatabaseMailProfile' {
 
@@ -166,6 +158,7 @@ function Get-AllAgentInfo {
         DatabaseMailEnabled = $Instance.Configuration.DatabaseMailEnabled.ConfigValue
         Agent               = @($Agent)
         Operator            = @($Operator)
+        FailSafeOperator    = @($failsafeOperator)
     }
     return $testInstanceObject
 }