Merge pull request #1842 from microsoft/dpaul-HcDdgPf

Health Checker detects multiple dynamic distribution groups system objects for public folder mailboxes
microsoft · Oct 4, 2023 · f92f47a · f92f47a
2 parents 438ba8a + aac3713
commit f92f47a
Show file tree

Hide file tree

Showing 11 changed files with 2,470 additions and 15 deletions.
diff --git a/Diagnostics/HealthChecker/Analyzer/Invoke-AnalyzerOrganizationInformation.ps1 b/Diagnostics/HealthChecker/Analyzer/Invoke-AnalyzerOrganizationInformation.ps1
@@ -76,4 +76,33 @@ function Invoke-AnalyzerOrganizationInformation {
         }
         Add-AnalyzedResultInformation @params
     }
+
+    if ($null -ne $organizationInformation.GetDynamicDgPublicFolderMailboxes -and
+        $organizationInformation.GetDynamicDgPublicFolderMailboxes.Count -ne 0) {
+        $displayWriteType = "Green"
+
+        if ($organizationInformation.GetDynamicDgPublicFolderMailboxes.Count -gt 1) {
+            $displayWriteType = "Red"
+        }
+
+        $params = $baseParams + @{
+            Name             = "Dynamic Distribution Group Public Folder Mailboxes Count"
+            Details          = $organizationInformation.GetDynamicDgPublicFolderMailboxes.Count
+            DisplayWriteType = $displayWriteType
+        }
+
+        Add-AnalyzedResultInformation @params
+
+        if ($displayWriteType -ne "Green") {
+            $params = $baseParams + @{
+                Details                = "More Information: https://aka.ms/HC-DynamicDgPublicFolderMailboxes"
+                DisplayCustomTabNumber = 2
+                DisplayWriteType       = "Yellow"
+            }
+
+            Add-AnalyzedResultInformation @params
+        }
+    } else {
+        Write-Verbose "No Dynamic Distribution Group Public Folder Mailboxes found to review."
+    }
 }
diff --git a/...tics/HealthChecker/DataCollection/OrganizationInformation/Get-OrganizationInformation.ps1 b/...tics/HealthChecker/DataCollection/OrganizationInformation/Get-OrganizationInformation.ps1
@@ -66,6 +66,13 @@ function Get-OrganizationInformation {
             $wellKnownSecurityGroups = Get-ExchangeWellKnownSecurityGroups
             $isSplitADPermissions = Get-ExchangeADSplitPermissionsEnabled -CatchActionFunction ${Function:Invoke-CatchActions}
 
+            try {
+                $getDdgPublicFolders = @(Get-DynamicDistributionGroup "PublicFolderMailboxes*" -IncludeSystemObjects -ErrorAction "Stop")
+            } catch {
+                Write-Verbose "Failed to get the dynamic distribution group for public folder mailboxes."
+                Invoke-CatchActions
+            }
+
             try {
                 $rootDSE = [ADSI]("LDAP://$([System.DirectoryServices.ActiveDirectory.Domain]::GetComputerDomain().Name)/RootDSE")
                 $directorySearcher = New-Object System.DirectoryServices.DirectorySearcher
@@ -123,18 +130,19 @@ function Get-OrganizationInformation {
         }
     } end {
         return [PSCustomObject]@{
-            GetOrganizationConfig   = $organizationConfig
-            DomainsAclPermissions   = $domainsAclPermissions
-            WellKnownSecurityGroups = $wellKnownSecurityGroups
-            AdSchemaInformation     = $adSchemaInformation
-            GetHybridConfiguration  = $getHybridConfiguration
-            EnableDownloadDomains   = $enableDownloadDomains
-            GetAcceptedDomain       = $getAcceptedDomain
-            MapiHttpEnabled         = $mapiHttpEnabled
-            SecurityResults         = $securityResults
-            IsSplitADPermissions    = $isSplitADPermissions
-            ADSiteCount             = $adSiteCount
-            GetSettingOverride      = $getSettingOverride
+            GetOrganizationConfig             = $organizationConfig
+            DomainsAclPermissions             = $domainsAclPermissions
+            WellKnownSecurityGroups           = $wellKnownSecurityGroups
+            AdSchemaInformation               = $adSchemaInformation
+            GetHybridConfiguration            = $getHybridConfiguration
+            EnableDownloadDomains             = $enableDownloadDomains
+            GetAcceptedDomain                 = $getAcceptedDomain
+            MapiHttpEnabled                   = $mapiHttpEnabled
+            SecurityResults                   = $securityResults
+            IsSplitADPermissions              = $isSplitADPermissions
+            ADSiteCount                       = $adSiteCount
+            GetSettingOverride                = $getSettingOverride
+            GetDynamicDgPublicFolderMailboxes = $getDdgPublicFolders
         }
     }
 }
diff --git a/...ealthChecker/Tests/DataCollection/E15/Exchange/GetDynamicDistributionGroupPfMailboxes.xml b/...ealthChecker/Tests/DataCollection/E15/Exchange/GetDynamicDistributionGroupPfMailboxes.xml
diff --git a/...ealthChecker/Tests/DataCollection/E16/Exchange/GetDynamicDistributionGroupPfMailboxes.xml b/...ealthChecker/Tests/DataCollection/E16/Exchange/GetDynamicDistributionGroupPfMailboxes.xml
diff --git a/...ealthChecker/Tests/DataCollection/E19/Exchange/GetDynamicDistributionGroupPfMailboxes.xml b/...ealthChecker/Tests/DataCollection/E19/Exchange/GetDynamicDistributionGroupPfMailboxes.xml
diff --git a/...althChecker/Tests/DataCollection/E19/Exchange/GetDynamicDistributionGroupPfMailboxes1.xml b/...althChecker/Tests/DataCollection/E19/Exchange/GetDynamicDistributionGroupPfMailboxes1.xml
diff --git a/Diagnostics/HealthChecker/Tests/HealthChecker.E15.Main.Tests.ps1 b/Diagnostics/HealthChecker/Tests/HealthChecker.E15.Main.Tests.ps1
@@ -41,8 +41,9 @@ Describe "Testing Health Checker by Mock Data Imports - Exchange 2013" {
             TestObjectMatch "MAPI/HTTP Enabled" "True"
             TestObjectMatch "Enable Download Domains" "Unknown"
             TestObjectMatch "AD Split Permissions" "False"
+            TestObjectMatch "Dynamic Distribution Group Public Folder Mailboxes Count" 1 -WriteType "Green"
 
-            $Script:ActiveGrouping.Count | Should -Be 5
+            $Script:ActiveGrouping.Count | Should -Be 6
         }
 
         It "Display Results - Operating System Information" {

diff --git a/Diagnostics/HealthChecker/Tests/HealthChecker.E16.Main.Tests.ps1 b/Diagnostics/HealthChecker/Tests/HealthChecker.E16.Main.Tests.ps1
@@ -41,8 +41,9 @@ Describe "Testing Health Checker by Mock Data Imports - Exchange 2016" {
             TestObjectMatch "MAPI/HTTP Enabled" "True"
             TestObjectMatch "Enable Download Domains" "False"
             TestObjectMatch "AD Split Permissions" "False"
+            TestObjectMatch "Dynamic Distribution Group Public Folder Mailboxes Count" 1 -WriteType "Green"
 
-            $Script:ActiveGrouping.Count | Should -Be 4
+            $Script:ActiveGrouping.Count | Should -Be 5
         }
 
         It "Display Results - Operating System Information" {

diff --git a/Diagnostics/HealthChecker/Tests/HealthChecker.E19.Main.Tests.ps1 b/Diagnostics/HealthChecker/Tests/HealthChecker.E19.Main.Tests.ps1
@@ -41,8 +41,9 @@ Describe "Testing Health Checker by Mock Data Imports" {
             TestObjectMatch "MAPI/HTTP Enabled" "True"
             TestObjectMatch "Enable Download Domains" "False"
             TestObjectMatch "AD Split Permissions" "False"
+            TestObjectMatch "Dynamic Distribution Group Public Folder Mailboxes Count" 1 -WriteType "Green"
 
-            $Script:ActiveGrouping.Count | Should -Be 4
+            $Script:ActiveGrouping.Count | Should -Be 5
         }
 
         It "Display Results - Operating System Information" {
@@ -165,10 +166,16 @@ Describe "Testing Health Checker by Mock Data Imports" {
             Mock Get-WebSite -ParameterFilter { $Name -eq "Default Web Site" } -MockWith { return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\IIS\GetWebSite_DefaultWebSite1.xml" }
             Mock Get-WebConfigFile -ParameterFilter { $PSPath -eq "IIS:\Sites\Default Web Site" } -MockWith { return [PSCustomObject]@{ FullName = "$Script:MockDataCollectionRoot\Exchange\IIS\DefaultWebSite_web2.config" } }
             Mock Invoke-ScriptBlockHandler -ParameterFilter { $ScriptBlockDescription -eq "Getting applicationHost.config" } -MockWith { return Get-Content "$Script:MockDataCollectionRoot\Exchange\IIS\applicationHost2.config" -Raw }
+            Mock Get-DynamicDistributionGroup { return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\GetDynamicDistributionGroupPfMailboxes1.xml" }
 
             SetDefaultRunOfHealthChecker "Debug_Physical_Results.xml"
         }
 
+        It "Dynamic Public Folder Mailboxes" {
+            SetActiveDisplayGrouping "Organization Information"
+            TestObjectMatch "Dynamic Distribution Group Public Folder Mailboxes Count" 2 -WriteType "Red"
+        }
+
         It "Extended Protection Enabled" {
             SetActiveDisplayGrouping "Exchange Information"
             TestObjectMatch "Version" "Exchange 2019 CU12 Feb23SU"

diff --git a/Diagnostics/HealthChecker/Tests/HealthChecker.MockedCalls.Tests.ps1 b/Diagnostics/HealthChecker/Tests/HealthChecker.MockedCalls.Tests.ps1
@@ -40,6 +40,7 @@ Describe "Testing Health Checker by Mock Data Imports" {
             Mock Get-AcceptedDomain { return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\GetAcceptedDomain.xml" }
             Mock Get-ReceiveConnector { return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\GetReceiveConnector.xml" }
             Mock Get-SendConnector { return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\GetSendConnector.xml" }
+            Mock Get-DynamicDistributionGroup { return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\GetDynamicDistributionGroupPfMailboxes.xml" }
 
             $Error.Clear()
             Get-OrganizationInformation -EdgeServer $false | Out-Null
@@ -90,6 +91,7 @@ Describe "Testing Health Checker by Mock Data Imports" {
             Assert-MockCalled Get-IISModules -Exactly 1
             Assert-MockCalled Get-ExchangeDiagnosticInfo -Exactly 1
             Assert-MockCalled Get-ExchangeADSplitPermissionsEnabled -Exactly 1
+            Assert-MockCalled Get-DynamicDistributionGroup -Exactly 1
         }
     }
 }
diff --git a/Diagnostics/HealthChecker/Tests/HealthCheckerTest.CommonMocks.NotPublished.ps1 b/Diagnostics/HealthChecker/Tests/HealthCheckerTest.CommonMocks.NotPublished.ps1
@@ -251,6 +251,10 @@ function Get-OrganizationConfig {
     return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\GetOrganizationConfig.xml"
 }
 
+function Get-DynamicDistributionGroup {
+    return Import-Clixml "$Script:MockDataCollectionRoot\Exchange\GetDynamicDistributionGroupPfMailboxes.xml"
+}
+
 function Get-HybridConfiguration { return $null }
 
 # Needs to be a function as PS core doesn't have -ComputerName parameter