feat: show console output (#121)

- Added `Show-ReportingOutput` cmdlet to format output to the console when `PowerVCF` is not installed. - Bumps the module version to v2.0.0.1007. - Updates `CHANGELOG.md`. Signed-off-by: Ryan Johnson <[email protected]>
vmware · Apr 13, 2023 · 7d74da0 · 7d74da0
1 parent c4e9ef6
commit 7d74da0
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ Enhancement:
 - Updated `Publish-CertificateHealth` to include an "Expires In (Days)" column. [GH-107](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/pull/107)
 - Updated `Publish-CertificateHealth` to include ESXi host certificates. [GH-107](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/pull/107)
 - Updated `Publish-PasswordHealth` to include an "Expires In (Days)" column. [GH-111](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/pull/111)
+- Added `Show-ReportingOutput` cmdlet to format output to the console when `PowerVCF` is not installed. [GH-121](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-reporting/pull/121)
 
 Refactor:
 

diff --git a/VMware.CloudFoundation.Reporting.psd1 b/VMware.CloudFoundation.Reporting.psd1
@@ -12,7 +12,7 @@
     RootModule = '.\VMware.CloudFoundation.Reporting.psm1'
 
     # Version number of this module.
-    ModuleVersion = '2.0.0.1006'
+    ModuleVersion = '2.0.0.1007'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()

diff --git a/VMware.CloudFoundation.Reporting.psm1 b/VMware.CloudFoundation.Reporting.psm1
@@ -7534,15 +7534,14 @@ Function Test-VcfReportingPrereq {
         The Test-VcfReportingPrereq cmdlet checks that all the prerequisites have been met to run the PowerShell module.
 
         .EXAMPLE
-        Test-VcfReportingPrereq -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1! -logPath F:\Reporting
+        Test-VcfReportingPrereq -sddcManagerFqdn sfo-vcf01.sfo.rainpole.io -sddcManagerUser admin@local -sddcManagerPass VMw@re1!VMw@re1!
         This example runs the prerequisite validation.
     #>
 
     Param (
         [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$sddcManagerFqdn,
         [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$sddcManagerUser,
-        [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$sddcManagerPass,
-        [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$logPath
+        [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$sddcManagerPass
     )
 
     Try {
@@ -7559,27 +7558,26 @@ Function Test-VcfReportingPrereq {
 
         if (Test-VCFConnection -server $sddcManagerFqdn) {
             if (Test-VCFAuthentication -server $sddcManagerFqdn -user $sddcManagerUser -pass $sddcManagerPass) {           
-                Start-SetupLogFile -Path $logPath -ScriptName $MyInvocation.MyCommand.Name # Setup Log Location and Log File
 
                 $vcfVersion = ((Get-VCFManager).version).Split('-')[0]
                 if ($vcfVersion -lt $vcfMinVersion) {
                     $message = "VMware Cloud Foundation: SDDC Manager $vcfVersion ($($sddcManagerFqdn)) is not supported by this module. Minimum required version is $($vcfMinVersion)."
-                    Write-LogMessage -Type ERROR -Message $message -Colour Red
+                    Show-ReportingOutput -type ERROR -message $message
                     Break
                 } else {
                     $message = "VMware Cloud Foundation: SDDC Manager $vcfVersion ($($sddcManagerFqdn)) and supports the minimum required version."
-                    Write-LogMessage -Type INFO -Message $message -Colour Green
+                    Show-ReportingOutput -Type INFO -Message $message
                 }
 
                 foreach ($module in $modules ) {
                     if ((Get-InstalledModule -ErrorAction SilentlyContinue -Name $module.Name).Version -lt $module.MinimumVersion) {
-                        $message = "PowerShell Module: $($module.Name) $($module.MinimumVersion) is not installed."
-                        Write-LogMessage -Type ERROR -Message $message -Colour Red
+                        $message = "PowerShell Module: $($module.Name) $($module.MinimumVersion) minimum required version is not installed."
+                        Show-ReportingOutput -type ERROR -message $message
                         Break
                     } else {
                         $moduleCurrentVersion = (Get-InstalledModule -Name $module.Name).Version
                         $message = "PowerShell Module: $($module.Name) $($moduleCurrentVersion) is installed and supports the minimum required version."
-                        Write-LogMessage -Type INFO -Message $message -Colour Green
+                        Show-ReportingOutput -Type INFO -Message $message
                     }
                 }
             }
@@ -7592,6 +7590,37 @@ Function Test-VcfReportingPrereq {
 }
 Export-ModuleMember -Function Test-VcfReportingPrereq
 
+Function Show-ReportingOutput {
+
+    Param (
+        [Parameter (Mandatory = $true)] [AllowEmptyString()] [String]$message,
+        [Parameter (Mandatory = $false)] [ValidateSet("INFO", "ERROR", "WARNING", "EXCEPTION","ADVISORY","NOTE","QUESTION","WAIT")] [String]$type = "INFO",
+        [Parameter (Mandatory = $false)] [Switch]$skipnewline
+    )
+
+    If ($type -eq "INFO") {
+        $messageColour = "92m" #Green
+    } elseIf ($type -in "ERROR","EXCEPTION") {
+        $messageColour = "91m" # Red
+    } elseIf ($type -in "WARNING","ADVISORY","QUESTION") {
+        $messageColour = "93m" #Yellow
+    } elseIf ($type -in "NOTE","WAIT") {
+        $messageColour = "97m" # White
+    }
+
+    $ESC = [char]0x1b
+    $timestampColour = "97m"
+
+    $timeStamp = Get-Date -Format "MM-dd-yyyy_HH:mm:ss"
+
+    If ($skipnewline) {
+        Write-Host -NoNewline "$ESC[${timestampcolour} [$timestamp]$ESC[${threadColour} $ESC[${messageColour} [$type] $message$ESC[0m"
+    } else {
+        Write-Host "$ESC[${timestampcolour} [$timestamp]$ESC[${threadColour} $ESC[${messageColour} [$type] $message$ESC[0m"
+    }
+}
+Export-ModuleMember -Function Show-ReportingOutput
+
 Function Start-CreateReportDirectory {
     Param (
         [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$path,