feat: improve code efficiency of Invoke-VcfConfigReport #62

Improvements around code efficiency: - Added $commandSwitch to create the -allDomains or -workloadDomain switch - Refactored all Publish- calls to use $commandSwitch resulting in single command per element and reduction of ten lines of code per element - 30% reduction in lines of code for Invoke-VcfConfigReport Signed-off-by: Gary Blake [email protected]
vmware · Dec 23, 2022 · b72d8de · b72d8de
2 parents 23b695e + fb7e4e8
commit b72d8de
Showing 1 changed file with 12 additions and 46 deletions.
diff --git a/VMware.CloudFoundation.Reporting.psm1 b/VMware.CloudFoundation.Reporting.psm1
@@ -347,7 +347,7 @@ Function Invoke-VcfConfigReport {
         [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$sddcManagerPass,
         [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$reportPath,
         [Parameter (ParameterSetName = 'All-WorkloadDomains', Mandatory = $true)] [ValidateNotNullOrEmpty()] [Switch]$allDomains,
-        [Parameter (ParameterSetName = 'Specific--WorkloadDomain', Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$workloadDomain,
+        [Parameter (ParameterSetName = 'Specific-WorkloadDomain', Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$workloadDomain,
         [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$darkMode
     )
 
@@ -360,10 +360,14 @@ Function Invoke-VcfConfigReport {
                 if (!(Test-Path -Path $reportPath)) {Write-Warning "Unable to locate report path $reportPath, enter a valid path and try again"; Write-Host ""; Break }
                 if ($PsBoundParameters.ContainsKey("allDomains")) {
                     $reportname = $defaultReport.Split('.')[0] + "-" + $sddcManagerFqdn.Split(".")[0] + ".htm"
+                    $reportData = "<h1>SDDC Manager: $sddcManagerFqdn</h1>"
                     $workflowMessage = "VMware Cloud Foundation instance ($sddcManagerFqdn)"
+                    $commandSwitch = "-allDomains"
                 } else {
                     $reportname = $defaultReport.Split('.')[0] + "-" + $workloadDomain + ".htm"
+                    $reportData = "<h1>Workload Domain: $workloadDomain</h1>"
                     $workflowMessage = "Workload Domain ($workloadDomain)"
+                    $commandSwitch = "-workloadDomain $workloadDomain"
                 }
                 Start-SetupLogFile -Path $reportPath -ScriptName $MyInvocation.MyCommand.Name # Setup Log Location and Log File
                 Write-LogMessage -Type INFO -Message "Starting the Process of Creating a Configuration Report for $workflowMessage." -Colour Yellow
@@ -372,64 +376,27 @@ Function Invoke-VcfConfigReport {
 
                 # Collecting Cluster Configuration Using PowerShell Functions
                 Write-LogMessage -Type INFO -Message "Generating the Cluster Configuration for $workflowMessage."
-                if ($PsBoundParameters.ContainsKey("allDomains")) {
-                    $clusterConfigHtml = Publish-ClusterConfiguration -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -allDomains
-                } else {
-                    $clusterConfigHtml = Publish-ClusterConfiguration -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -workloadDomain $workloadDomain
-                }
+                $clusterConfigHtml = Invoke-Expression "Publish-ClusterConfiguration -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass $($commandSwitch)"; $reportData += $clusterConfigHtml
 
                 # Collecting Cluster DRS Rules Using PowerShell Functions
                 Write-LogMessage -Type INFO -Message "Generating the DRS Rule Configuration for $workflowMessage."
-                if ($PsBoundParameters.ContainsKey("allDomains")) {
-                    $clusterDrsRuleHtml = Publish-ClusterDrsRule -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -allDomains
-                } else {
-                    $clusterDrsRuleHtml = Publish-ClusterDrsRule -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -workloadDomain $workloadDomain
-                }
+                $clusterDrsRuleHtml = Invoke-Expression "Publish-ClusterDrsRule -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass $($commandSwitch)"; $reportData += $clusterDrsRuleHtml
 
                 # Collecting Resource Pool Details  Using PowerShell Functions
                 Write-LogMessage -Type INFO -Message "Generating the Resouce Pool Configuration for $workflowMessage."
-                if ($PsBoundParameters.ContainsKey("allDomains")) {
-                    $resourcePoolsHtml = Publish-ResourcePool -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -allDomains
-                } else {
-                    $resourcePoolsHtml = Publish-ResourcePool -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -workloadDomain $workloadDomain
-                }
+                $resourcePoolsHtml = Invoke-Expression "Publish-ResourcePool -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass $($commandSwitch)"; $reportData += $resourcePoolsHtml
 
                 # Collecting VM Overrides Using PowerShell Functions
                 Write-LogMessage -Type INFO -Message "Generating the VM Override Configuration for $workflowMessage."
-                if ($PsBoundParameters.ContainsKey("allDomains")) {
-                    $vmOverridesHtml = Publish-VmOverride -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -allDomains
-                } else {
-                    $vmOverridesHtml = Publish-VmOverride -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -workloadDomain $workloadDomain
-                }
+                $vmOverridesHtml = Invoke-Expression "Publish-VmOverride -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass $($commandSwitch)"; $reportData += $vmOverridesHtml
 
                 # Collecting Virtual Networking Using PowerShell Functions
                 Write-LogMessage -Type INFO -Message "Generating the Virtual Networking Configuration for $workflowMessage."
-                if ($PsBoundParameters.ContainsKey("allDomains")) {
-                    $vritualNetworkHtml = Publish-VirtualNetwork -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -allDomains
-                } else {
-                    $vritualNetworkHtml = Publish-VirtualNetwork -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -workloadDomain $workloadDomain
-                }
+                $virtualNetworkHtml = Invoke-Expression "Publish-VirtualNetwork -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass $($commandSwitch)"; $reportData += $virtualNetworkHtml
 
                 # Collecting ESXi Security Configuration Using PowerShell Functions
                 Write-LogMessage -Type INFO -Message "Generating the ESXi Security Configuration for $workflowMessage."
-                if ($PsBoundParameters.ContainsKey("allDomains")) {
-                    $esxiSecuritykHtml = Publish-EsxiSecurityConfiguration -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -allDomains
-                } else {
-                    $esxiSecuritykHtml = Publish-EsxiSecurityConfiguration -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass -workloadDomain $workloadDomain
-                }
-
-                # Combine all information gathered into a single HTML report
-                if ($PsBoundParameters.ContainsKey("allDomains")) {
-                    $reportData = "<h1>SDDC Manager: $sddcManagerFqdn</h1>"
-                } else {
-                    $reportData = "<h1>Workload Domain: $workloadDomain</h1>"
-                }
-                $reportData += $clusterConfigHtml
-                $reportData += $clusterDrsRuleHtml
-                $reportData += $resourcePoolsHtml
-                $reportData += $vmOverridesHtml
-                $reportData += $vritualNetworkHtml
-                $reportData += $esxiSecuritykHtml
+                $esxiSecurityHtml = Invoke-Expression "Publish-EsxiSecurityConfiguration -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass $($commandSwitch)"; $reportData += $esxiSecurityHtml
 
                 if ($PsBoundParameters.ContainsKey("darkMode")) {
                     $reportHeader = Get-ClarityReportHeader -dark
@@ -453,8 +420,7 @@ Function Invoke-VcfConfigReport {
                 }
             }
         }
-    }
-    Catch {
+    } Catch {
         Debug-CatchWriter -object $_
     }
 }