From 3143f9966908dbc707951921b2a8156b6d0d5540 Mon Sep 17 00:00:00 2001
From: Sam Erde <samuel.erde@gmail.com>
Date: Mon, 3 Feb 2025 13:41:59 -0500
Subject: [PATCH] Insert FYI when truncating test result data. Add info output
 to CSV and XLSX export.

---
 .../public/Convert-MtJsonResultsToFlatObject.ps1   | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/powershell/public/Convert-MtJsonResultsToFlatObject.ps1 b/powershell/public/Convert-MtJsonResultsToFlatObject.ps1
index f751a1aa..b4bd70e9 100644
--- a/powershell/public/Convert-MtJsonResultsToFlatObject.ps1
+++ b/powershell/public/Convert-MtJsonResultsToFlatObject.ps1
@@ -76,19 +76,28 @@
         'you’re'  = 'you are'
         'aren’nt' = 'are not'
     } ; [void]$ReplacementStrings # Not Used Yet
+
+    [string]$TruncationFYI = 'NOTE: DETAILS ARE TRUNCATED DUE TO FIELD SIZE LIMITATIONS. PLEASE SEE THE HTML REPORT FOR FULL DETAILS.'
     #endregion ReplacementStrings
 
     $MaesterResults = New-Object System.Collections.Generic.List[PSObject]
 
     $JsonData = (Get-Content -Path $JsonFilePath | ConvertFrom-Json).Tests
     $JsonData | ForEach-Object {
+        # Truncate the ResultDetail.TestResult data if it is longer than 30000 characters.
+        if ($_.ResultDetail.TestResult.Length -gt 30000) {
+            $TestResultDetail = "$TruncationFYI`n`n$($TestResultDetail -replace '(?s)(.*?)#### Impacted resources.*?#### Remediation actions:','$1#### Remediation actions:')"
+        } else {
+            $TestResultDetail = $_.ResultDetail.TestResult
+        }
+
         $MaesterResults.Add([PSCustomObject]@{
                 Name           = $_.Name
                 Tag            = $_.Tag -join ', '
                 Block          = $_.Block
                 Result         = $_.Result
                 Description    = $_.ResultDetail.TestDescription
-                ResultDetail   = "$($_.ResultDetail.TestResult -replace '(?s)(.*?)#### Impacted resources.*?#### Remediation actions:','$1#### Remediation actions:')"
+                ResultDetail   = $TestResultDetail
                 TestSkipped    = $_.ResultDetail.TestSkipped
                 SkippedReason  = $_.ResultDetail.SkippedReason
                 ErrorMessage   = $_.ErrorRecord.Exception.Message
@@ -99,6 +108,7 @@
 
     try {
         $MaesterResults | Export-Csv -Path $CsvFilePath -UseQuotes Always -NoTypeInformation
+        Write-Information "Exported the Maester test results to '$CsvFilePath'." -InformationAction Continue
     } catch {
         Write-Error "Failed to export the Maester test results to a CSV file. $_"
     }
@@ -106,6 +116,7 @@
     if ($ExportExcel.IsPresent) {
         try {
             $MaesterResults | Export-Excel -Path $ExcelFilePath -FreezeTopRow -AutoFilter -BoldTopRow -WorksheetName 'Results'
+            Write-Information "Exported the Maester test results to '$ExcelFilePath'." -InformationAction Continue
         } catch [System.Management.Automation.CommandNotFoundException] {
             Write-Error "The ImportExcel module is required to export the Maester test results to an Excel file. Install the module using ``Import-Module -Name 'ImportExcel'`` and try again."
 
@@ -117,4 +128,5 @@
     if ($Passthru.IsPresent) {
         $MaesterResults
     }
+
 } #end function Convert-MtJsonResultsToFlatObject