DatabaseMailProfile

Author: ClaudioESSilva

source/checks/Agentv5.Tests.ps1

@@ -84,7 +84,7 @@ Describe "DBA Operator" -Tag DbaOperator, Operator, Agent -ForEach $InstancesToT
     }
 }
 
-Describe "Failsafe operator" -Tag FailsafeOperator, CIS, security, Agent -ForEach $InstancesToTest {
+Describe "Failsafe operator" -Tag FailsafeOperator, Operator, Agent -ForEach $InstancesToTest {
     $skipFailsafeOperator = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.failsafeoperator' }).Value
 
     Context "Testing failsafe operator exists on <_.Name>" {
@@ -94,18 +94,16 @@ Describe "Failsafe operator" -Tag FailsafeOperator, CIS, security, Agent -ForEac
     }
 }
 
-#
-## 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" -Tag DatabaseMailProfile, Agent -ForEach $InstancesToTest {
+    $skipDatabaseMailProfile = ($__dbcconfig | Where-Object { $_.Name -eq 'skip.agent.databasemailprofile' }).Value
+
+    Context "Testing Database Mail Profile exists on <_.Name>" {
+        It "The Database Mail profile <_.DatabaseMailProfile.ExpectedDatabaseMailProfile> exists on <_.Name>" -Skip:$skipDatabaseMailProfile { #-ForEach ($PSItem.DatabaseMailProfile | Where-Object ExpectedDatabaseMailProfile -NE 'null') {
+            $PSItem.DatabaseMailProfile.ActualDatabaseMailProfile | Should -Be $PSItem.DatabaseMailProfile.ExpectedDatabaseMailProfile -Because 'The database mail profile is required to send emails'
+        }
+    }
+}
+
 
 # Describe "Database Mail Profile" -Tags DatabaseMailProfile, $filename {
 #     if ($NotContactable -contains $psitem) {

source/internal/configurations/configuration.ps1

@@ -341,10 +341,12 @@ Set-PSFConfig -Module dbachecks -Name skip.agent.servicestate -Validation bool -
 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.databasemailprofile -Validation bool -Value $false -Initialize -Description "Skip the Database Mail Profile 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"
 
 
+
 Set-PSFConfig -Module dbachecks -Name skip.security.containedbautoclose -Validation bool -Value $true -Initialize -Description "Skips the scan for contained databases should have auto close enabled"
 Set-PSFConfig -Module dbachecks -Name skip.security.sqlagentproxiesnopublicrole -Validation bool -Value $true -Initialize -Description "Skips the scan for if the public role has access to SQL Agent proxies"
 Set-PSFConfig -Module dbachecks -Name skip.security.symmetrickeyencryptionlevel -Validation bool -Value $true -Initialize -Description "Skips the test for if the Symmetric Encryption is at least AES_128 or higher in non-system databases"

source/internal/functions/Get-AllAgentInfo.ps1

@@ -2,6 +2,7 @@ function Get-AllAgentInfo {
     # Using the unique tags gather the information required
     Param($Instance, $Tags)
 
+    #ToDo: Clean unused SMO classes
     #clear out the default initialised fields
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Server], $false)
     $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Database], $false)
@@ -28,6 +29,9 @@ function Get-AllAgentInfo {
     # Job Server Alert System Initial fields
     $FailsafeInitFields = $Instance.GetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.AlertSystem])
 
+    # JobServer Initial fields
+    $DatabaseMailProfileInitFields = $Instance.GetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.JobServer])
+
     # Database Initial Fields
     $DatabaseInitFields = $Instance.GetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Database])
 
@@ -118,7 +122,33 @@ function Get-AllAgentInfo {
             }
         }
         'DatabaseMailProfile' {
+            $DatabaseMailProfileInitFields.Add("DatabaseMailProfile") | Out-Null # so we can check failsafe operators
+            $Instance.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.JobServer], $DatabaseMailProfileInitFields)
+            $DatabaseMailProfileInitFields = $Instance.GetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Agent.JobServer])
+
+            $ConfigValues | Add-Member -MemberType NoteProperty -Name 'DatabaseMailProfile' -Value (Get-DbcConfigValue agent.databasemailprofile)
+
+            $databaseMailProfile = $ConfigValues.DatabaseMailProfile.ForEach{
+                [PSCustomObject]@{
+                    InstanceName                = $Instance.Name
+                    ExpectedDatabaseMailProfile = $ConfigValues.DatabaseMailProfile
+                    ActualDatabaseMailProfile   = $Instance.JobServer.DatabaseMailProfile
+                }
+            }
 
+            #TODO: Clean up
+            #$databaseMailProfile = $ConfigValues.DatabaseMailProfile.ForEach{
+            #    [PSCustomObject]@{
+            #        InstanceName                = $Instance.Name
+            #        ExpectedDatabaseMailProfile = 'null'
+            #        ActualDatabaseMailProfile   = 'null'
+            #    }
+            #}
+#
+            #Write-PSFMessage -Message "InstanceName : $($databaseMailProfile.InstanceName)" -Level Verbose
+            #Write-PSFMessage -Message "ExpectedDatabaseMailProfile : $($databaseMailProfile.ExpectedDatabaseMailProfile)" -Level Verbose
+            #Write-PSFMessage -Message "ActualDatabaseMailProfile : $($databaseMailProfile.ActualDatabaseMailProfile)" -Level Verbose
+            #Write-PSFMessage -Message "ActualDatabaseMailProfile instance : $($Instance.JobServer.DatabaseMailProfile)" -Level Verbose
         }
         'AgentMailProfile' {
 
@@ -159,6 +189,7 @@ function Get-AllAgentInfo {
         Agent               = @($Agent)
         Operator            = @($Operator)
         FailSafeOperator    = @($failsafeOperator)
+        DatabaseMailProfile = @($databaseMailProfile)
     }
     return $testInstanceObject
 }