Add report id to front page

cisagov · Sep 30, 2024 · ca5ac67 · ca5ac67
1 parent 3fd0e7b
commit ca5ac67
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/PowerShell/ScubaGear/Modules/CreateReport/ParentReport/ParentReport.html b/PowerShell/ScubaGear/Modules/CreateReport/ParentReport/ParentReport.html
@@ -27,7 +27,7 @@ <h1>SCuBA M365 Security Baseline Conformance Reports</h1>
             {TENANT_DETAILS}
             {TABLES}
             <footer>
-                Report generated with <a class="individual_reports" href="https://github.com/cisagov/ScubaGear">CISA's ScubaGear</a> tool {MODULE_VERSION}
+                Report UUID: {REPORT_UUID}. Report generated with <a class="individual_reports" href="https://github.com/cisagov/ScubaGear">CISA's ScubaGear</a> tool {MODULE_VERSION}
             </footer>
         </main>
    </body>

diff --git a/PowerShell/ScubaGear/Modules/Orchestrator.psm1 b/PowerShell/ScubaGear/Modules/Orchestrator.psm1
@@ -1209,10 +1209,14 @@ function Invoke-ReportCreation {
             $TenantMetaData = $TenantMetaData -replace '^(.*?)<table>','<table class ="tenantdata" style = "text-align:center;">'
             $Fragment = $Fragment | ConvertTo-Html -Fragment -ErrorAction 'Stop'
 
+            $FileName = Join-Path -Path $OutFolderPath -ChildPath "$($OutProviderFileName).json" -Resolve
+            $ReportUuid = $(Get-Utf8NoBom -FilePath $FileName | ConvertFrom-Json).report_uuid
+
             $ReportHtmlPath = Join-Path -Path $ReporterPath -ChildPath "ParentReport" -ErrorAction 'Stop'
             $ReportHTML = (Get-Content $(Join-Path -Path $ReportHtmlPath -ChildPath "ParentReport.html") -ErrorAction 'Stop') -Join "`n"
             $ReportHTML = $ReportHTML.Replace("{TENANT_DETAILS}", $TenantMetaData)
             $ReportHTML = $ReportHTML.Replace("{TABLES}", $Fragment)
+            $ReportHTML = $ReportHTML.Replace("{REPORT_UUID}", $ReportUuid)
             $ReportHTML = $ReportHTML.Replace("{MODULE_VERSION}", "v$ModuleVersion")
             $ReportHTML = $ReportHTML.Replace("{BASELINE_URL}", $BaselineURL)
 

diff --git a/PowerShell/ScubaGear/Testing/Unit/PowerShell/Orchestrator/Invoke-ReportCreation.Tests.ps1 b/PowerShell/ScubaGear/Testing/Unit/PowerShell/Orchestrator/Invoke-ReportCreation.Tests.ps1
@@ -1,8 +1,9 @@
 $OrchestratorPath = '../../../../Modules/Orchestrator.psm1'
 $CreateReportPath = '../../../../Modules/CreateReport/CreateReport.psm1'
+$UtilityPath = '../../../../Modules/Utility/Utility.psm1'
 Import-Module (Join-Path -Path $PSScriptRoot -ChildPath $OrchestratorPath) -Function Invoke-ReportCreation -Force
 Import-Module (Join-Path -Path $PSScriptRoot -ChildPath $CreateReportPath) -Function New-Report, Import-SecureBaseline -Force
-
+Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath $UtilityPath) -Function Get-Utf8NoBom -Force
 InModuleScope Orchestrator {
     Describe -Tag 'Orchestrator' -Name 'Invoke-ReportCreation' {
         BeforeAll {
@@ -19,7 +20,8 @@ InModuleScope Orchestrator {
             Mock -CommandName Get-Content {}
             Mock -CommandName Add-Type {}
             Mock -CommandName Invoke-Item {}
-
+            Mock -CommandName Get-Utf8NoBom {}
+            Mock -CommandName ConvertFrom-Json { @{ "report_uuid"="" } }
         }
         Context 'When creating the reports from Provider and OPA results JSON' {
             BeforeAll {